v0.2.0-beta

OpenAPI 3.1.0

Configurar tarefas de ‘Ad Traffic By Keywords’

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/keywords_data/google_ads/ad_traffic_by_keywords/task_post

Configurar tarefas de ‘Ad Traffic By Keywords’

Enfileira uma previsão de cliques, impressões e gasto para keywords com um determinado bid e tipo de match, retornando um id de tarefa. search_partners inclui a rede de parceiros do Google. Encapsulado no envelope do DataForSEO: dados em tasks[0].result, resultado em tasks[0].status_code — uma requisição rejeitada ainda retorna HTTP 200. Este é o único endpoint do Google Ads aqui sem variante em tempo real — a previsão sempre passa pela fila. Recupere com get_dataforseo_keywords_gads_ad_traffic_fetch.

Referência de preços

Medição: Custo da resposta reportado.
Estimativa de referência por requisição: USD 0.09.
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)[]
- bid
  Tipo: number
  
  o lance personalizado máximo
  campo obrigatório
  os dados coletados serão baseados neste valor
  ele representa o preço que você está disposto a pagar por um anúncio; quanto maior o valor especificado aqui, maiores serão os valores retornados nas métricas
  saiba mais neste artigo da Central de Ajuda
- date_from
  Tipo: string
  
  data inicial do intervalo de previsão
  campo obrigatório se você especificar date_to
  se indicar date_from e date_to, não precisa especificar date_interval
  o valor mínimo é a data de amanhã
  o valor especificado em date_from não deve ser posterior a date_to
  formato da data: "yyyy-mm-dd"
  exemplo:
  "2021-10-30"se o endpoint Status retornar false no campo actual_data, date_from pode ser definido como o mês retrasado e anteriores;
  se o endpoint Status retornar true no campo actual_data, date_from pode ser definido como o mês passado e anteriores
- date_interval
  Tipo: string | null
  
  intervalo de datas da previsão
  campo opcional
  se você especificar date_interval, não precisa indicar date_from e date_to
  valores possíveis: next_week, next_month, next_quarter
  valor padrão: next_month
- date_to
  Tipo: string
  
  data final do intervalo de previsão
  campo obrigatório se você especificar date_from
  se indicar date_from e date_to, não precisa especificar date_interval
  o valor mínimo é date_from +1 dia
  o valor máximo é o dia e mês atuais do próximo ano
  formato da data: "yyyy-mm-dd"
  exemplo:
  "2022-10-30"
- keywords
  Tipo: array string[]
  
  palavras-chave
  campo obrigatório
  O número máximo de palavras-chave que você pode especificar: 1000
  O número máximo de caracteres por palavra-chave: 80
  O número máximo de palavras por frase de palavra-chave: 10
  as palavras-chave especificadas serão convertidas para minúsculas
  Observação nº 1: O Google Ads pode não retornar dados para determinados grupos de palavras-chave;
  Observação nº 2: O Google Ads fornece valores combinados de volume de pesquisa para grupos de palavras-chave semelhantes
  para obter o volume de pesquisa de palavras-chave semelhantes, recomendamos enviar essas palavras-chave em requisições separadas;
  Observação nº 3: O Google Ads não permite o uso de determinados símbolos e caracteres (por exemplo, símbolos UTF, emojis), portanto você não pode usá-los ao definir uma tarefa;
  para saber mais sobre quais símbolos e caracteres podem ser usados, consulte este artigo
  
  saiba mais sobre as regras e limitações dos campos keyword e keywords nas APIs do DataForSEO neste artigo da Central de Ajuda
- language_code
  Tipo: string | null
  
  código do idioma do mecanismo de busca
  campo opcional
  você pode obter a lista de idiomas disponíveis do mecanismo de busca e seus language_code fazendo uma requisição separada para https://api.dataforseo.com/v3/keywords_data/google_ads/languages
  exemplo:
  en
- language_name
  Tipo: string | null
  
  nome completo do idioma do mecanismo de busca
  campo opcional
  você pode obter a lista de idiomas disponíveis do mecanismo de busca e seus language_name fazendo uma requisição separada para https://api.dataforseo.com/v3/keywords_data/google_ads/languages
  exemplo:
  English
- location_code
  Tipo: integer | null
  
  código do local do mecanismo de busca
  campo opcional
  se você não indicar o local, receberá resultados mundiais, ou seja, para todos os locais disponíveis;
  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/keywords_data/google_ads/locations
  exemplo:
  2840
- location_coordinate
  Tipo: string | null
  
  coordenadas GPS de um local
  campo opcional
  se você não indicar o local, receberá resultados mundiais, ou seja, para todos os locais disponíveis;
  se você usar este campo, não precisa especificar location_name ou location_code;
  o parâmetro location_coordinate deve ser especificado no formato "latitude,longitude";
  os dados serão fornecidos para o país ao qual as coordenadas especificadas pertencem;
  exemplo:
  52.6178549,-155.352142
- location_name
  Tipo: string | null
  
  nome completo do local do mecanismo de busca
  campo opcional
  se você não indicar o local, receberá resultados mundiais, ou seja, para todos os locais disponíveis;
  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/keywords_data/google_ads/locations
  exemplo:
  London,England,United Kingdom
- match
  Tipo: string
  
  tipo de correspondência de palavras-chave
  campo obrigatório
  pode assumir os seguintes valores: exact, broad, phrase
- 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;
  ou seja, o caractere # será codificado como %23
  
  saiba mais na nossa Central de Ajuda
- 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 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/postbackscript?id=$id
  http://your-server.com/postbackscript?id=$id&tag=$tag
  Observação: caracteres especiais em postback_url serão codificados para URL;
  ou seja, o caractere # será codificado como %23
  
  saiba mais na nossa Central de Ajuda
- sort_by
  Tipo: string | null
  
  parâmetros de ordenação dos resultados
  campo opcional
  Use estes parâmetros para ordenar os resultados por relevance, average_cpc, cost ou clicks em ordem decrescente
  valor padrão: relevance
- tag
  Tipo: string | null
  
  identificador de tarefa definido pelo usuário
  campo opcional
  o limite de caracteres é 255
  você pode usar este parâmetro para identificar a tarefa e associá-la ao resultado
  você encontrará o valor de tag especificado no objeto data da resposta

Respostas

200
Tipo: object | null · Response36Afe1097B20_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostResponseInfo
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_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostTaskInfo
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/keywords_data/google_ads/ad_traffic_by_keywords/task_post

curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/google_ads/ad_traffic_by_keywords/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "bid": 999,
    "match": "exact",
    "keywords": [
      "seo marketing"
    ]
  }
]'

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 ‘Ad Traffic By Keywords’

AutenticaçãoRequired

DataForSEO

Configurar tarefas de ‘Ad Traffic By Keywords’

Referência de preços