v0.2.0-beta

OpenAPI 3.1.0

Configurar tarefas de SERP de pesquisa de anúncios do Google Ads

Felo API Support

MIT

Servidor

https://openapi.felo.ai

Bibliotecas Cliente

Shell Curl

DataForSEO

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Operações

post/v1/beta/dataforseo/serp/google/ads_search/task_post

Configurar tarefas de SERP de pesquisa de anúncios do Google Ads

Enfileira os anúncios veiculados para uma palavra-chave no Google, retornando um id de tarefa em tasks[0].id. Encapsulado no envelope do DataForSEO: dados em tasks[0].result, resultado em tasks[0].status_code — uma requisição rejeitada ainda retorna HTTP 200. A versão em tempo real responde imediatamente e é mais simples para uma única consulta; enfileire quando o lote exceder uma chamada de ferramenta.

Referência de preços

Medição: Custo da resposta reportado.
Estimativa de referência por requisição: USD 0.02.
Multiplicador de referência do cliente: 1.0. Não o aplique novamente a um valor de cliente já liquidado.

Apenas metadados de referência, não uma cotação da conta, um preço garantido ou um limite de gastos. Créditos de recursos não são créditos Felo. As cobranças finais seguem os registros de cobrança da Felo.

Corpo

application/json

Tipo: array (object | null)[]
- advertiser_ids
  Tipo: array string[]
  
  identificadores de anunciantes
  
  campo obrigatório se target não for especificado
  
  você pode especificar no máximo 25 valores neste array;
  
  os valores de advertiser_ids para este parâmetro podem ser encontrados no endpoint Google Ads Advertisers;
- date_from
  Tipo: string
  
  data inicial do intervalo de tempo
  
  campo opcional
  
  campo obrigatório se date_to for especificado;
  
  formato de data: "yyyy-mm-dd"
  
  valor mínimo: 2018-05-31
  
  valor máximo: data de hoje
  
  exemplo:
  
  "2020-01-01"
- date_to
  Tipo: string
  
  data final do intervalo de tempo
  
  campo opcional
  
  campo obrigatório se date_from for especificado;
  
  formato de data: "yyyy-mm-dd"
  
  valor mínimo: 2018-05-31
  
  valor máximo: data de hoje
  
  exemplo:
  
  "2020-01-01"
- depth
  Tipo: integer | null
  
  profundidade de análise
  
  campo opcional
  
  número de resultados no SERP
  
  valor padrão: 40
  
  valor máximo: 700
  
  Sua conta será cobrada por cada SERP contendo até 40 resultados;
  Definir uma profundidade acima de 40 pode gerar cobranças adicionais se o mecanismo de pesquisa retornar mais de 40 resultados;
  
  O custo pode ser calculado na página Preços.
- format
  Tipo: string | null
  
  formato do anúncio
  
  campo opcional
  
  valores possíveis: all, text, image, video
- location_code
  Tipo: integer | null
  
  código do local do mecanismo de busca
  
  campo opcional
  
  se você usar este campo, não precisa especificar location_name ou location_coordinate
  
  você pode obter a lista de locais disponíveis dos mecanismos de busca e seus location_code fazendo uma requisição separada para https://api.dataforseo.com/v3/serp/google/ads_search/locations
  
  exemplo:
  
  2840
  
  Observação: se você não especificar location_name, location_code ou location_coordinate, os anúncios serão pesquisados em todos os locais disponíveis
- location_coordinate
  Tipo: string | null
  
  coordenadas GPS de uma localização
  
  campo opcional
  
  se você usar este campo, não precisa especificar location_name ou location_code
  
  exemplo:
  
  52.6178549,-155.352142
  
  Observação: se você não especificar location_name, location_code ou location_coordinate, os anúncios serão pesquisados em todos os locais disponíveis
- location_name
  Tipo: string | null
  
  nome completo do local do mecanismo de busca
  
  campo opcional
  
  se você usar este campo, não precisa especificar location_code ou location_coordinate
  
  você pode obter a lista de locais disponíveis do mecanismo de busca e seus location_name fazendo uma requisição separada para https://api.dataforseo.com/v3/serp/google/ads_search/locations
  
  exemplo:
  
  London,England,United Kingdom
  
  Observação: se você não especificar location_name, location_code ou location_coordinate, os anúncios serão pesquisados em todos os locais disponíveis
- pingback_url
  Tipo: string | null
  
  URL de notificação de uma tarefa concluída
  
  campo opcional
  
  quando uma tarefa é concluída, notificaremos você por meio de uma requisição GET enviada para a URL que você especificou
  
  você pode usar a string ‘$id’ como variável $id e ‘$tag’ como variável $tag codificada para URL. Definiremos os valores necessários antes de enviar a requisição.
  
  exemplo:
  
  http://your-server.com/pingscript?id=$id
  
  http://your-server.com/pingscript?id=$id&tag=$tag
  
  Observação: caracteres especiais em pingback_url serão codificados para URL;
  
  entre outros, o caractere # será codificado como %23
  
  saiba mais na nossa Central de Ajuda
- platform
  Tipo: string | null
  
  plataforma de publicidade
  
  campo opcional
  
  valores possíveis: all, google_play, google_maps, google_search, google_shopping, youtube
  
  valor padrão: all
- postback_data
  Tipo: string
  
  tipo de dado de postback_url
  
  campo obrigatório se você especificar postback_url
  
  corresponde à função usada para definir a tarefa
  
  valores possíveis:
  
  advanced
- postback_url
  Tipo: string | null
  
  URL para envio dos resultados da tarefa
  
  campo opcional
  
  quando a tarefa for concluída, enviaremos uma requisição POST com os resultados compactados no formato gzip para o postback_url especificado
  
  você pode usar a string ‘$id’ como variável $id e ‘$tag’ como variável $tag codificada para URL. Definiremos os valores necessários antes de enviar a requisição.
  
  exemplo:
  
  http://your-server.com/postbackscript?id=$id
  
  http://your-server.com/postbackscript?id=$id&tag=$tag
  
  Observação: caracteres especiais em postback_url serão codificados para URL;
  
  por exemplo, o caractere # será codificado como %23
  
  saiba mais na nossa Central de Ajuda
- priority
  Tipo: integer | null
  
  prioridade da tarefa
  
  campo opcional
  
  pode assumir os seguintes valores:
  
  1 – prioridade de execução normal (definida por padrão)
  
  2 – prioridade de execução alta
  
  Você será cobrado adicionalmente pelas tarefas com prioridade de execução alta.
  O custo pode ser calculado na página Preços.
- tag
  Tipo: string | null
  
  identificador de tarefa definido pelo usuário
  
  campo opcional
  
  o limite é de 255 caracteres
  
  você pode usar este parâmetro para identificar a tarefa e associá-la ao resultado
  
  você encontrará o valor tag especificado no objeto data da resposta
- target
  Tipo: string
  
  nome de domínio
  
  campo obrigatório se advertiser_ids não for especificado
  
  nome de domínio associado a uma conta de anunciante

Respostas

200
Tipo: object | null · Response36Afe1097B20_SerpGoogleAdsSearchTaskPostResponseInfo
cost
Tipo: number | null Formato: double

custo total das tarefas, USD

status_code
Tipo: integer | null

código de status geral você pode encontrar a lista completa dos códigos de resposta aqui

status_message
Tipo: string | null

mensagem informativa geral você pode encontrar a lista completa das mensagens informativas gerais aqui

tasks
Tipo: array (object | null)[] | null

array de tarefas

Tipo: object | null · Response36Afe1097B20_SerpGoogleAdsSearchTaskPostTaskInfo
cost
Tipo: number | null Formato: double

custo total das tarefas, USD

data
Tipo: object | null

contém os mesmos parâmetros que você especificou na requisição POST

propertyName
Tipo: object | null
id
Tipo: string | null

identificador da tarefa identificador exclusivo da tarefa em nosso sistema no formato UUID

path
Tipo: array (string | null)[] | null

caminho da URL

result
Tipo: object | null

array de resultados
nesse caso, o valor será null

result_count
Tipo: integer | null Formato: int64

número de elementos no array de resultados

status_code
Tipo: integer | null

código de status da tarefa gerado pelo DataForSEO; pode estar no seguinte intervalo: 10000-60000 você pode encontrar a lista completa dos códigos de resposta aqui

status_message
Tipo: string | null

mensagem informativa da tarefa você pode encontrar a lista completa das mensagens informativas gerais aqui

time
Tipo: string | null

tempo de execução, segundos

tasks_count
Tipo: integer | null Formato: int64

o número de tarefas no array de tarefas

tasks_error
Tipo: integer | null Formato: int64

o número de tarefas no array de tarefas retornadas com erro

time
Tipo: string | null

tempo total de execução, em segundos

version
Tipo: string | null

a versão atual da API
application/json
400

Não foi possível processar a requisição. Verifique os parâmetros da requisição.
401

É necessária uma chave de API da Felo válida.
402

A requisição não pode prosseguir porque um requisito de cobrança não foi atendido.
403

A conta não tem permissão para realizar esta operação.
429

Um limite de requisições ou de gastos foi atingido.
502

O serviço não pôde concluir a requisição.
503

A API ou o serviço de cobrança está temporariamente indisponível.
504

O serviço atingiu o tempo limite ao processar a requisição.
default

Resposta de erro; respostas repassadas do upstream podem usar formatos do provedor

application/json

post/v1/beta/dataforseo/serp/google/ads_search/task_post

curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/ads_search/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "location_code": 2840,
    "platform": "google_search",
    "advertiser_ids": [
      "AR13752565271262920705",
      "AR02439908557932462081"
    ]
  }
]'

Mostrar Schema

{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": null
    }
  ]
}

Operação bem-sucedida

Configurar tarefas de SERP de pesquisa de anúncios do Google Ads

AutenticaçãoRequired

DataForSEO

Configurar tarefas de SERP de pesquisa de anúncios do Google Ads

Referência de preços