Felo API PlatformFelo API Platform
Todos os endpoints de DataForSEO
v0.2.0-beta
OpenAPI 3.1.0

Configurar tarefas de ‘Google Ads Search Volume’ em tempo real

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

Configurar tarefas de ‘Google Ads Search Volume’ em tempo real

​

Volume de pesquisa do Google Ads para uma lista de keywords. Retorna keyword, location_code, language_code, search_partners, competition, competition_index, search_volume, low_top_of_page_bid, high_top_of_page_bid, cpc e monthly_searches, além de spell quando o Google corrigiu o termo. 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 número clássico de volume de pesquisa; para a frequência com que as pessoas perguntam a um assistente, use post_dataforseo_ai_keyword_volume_live. As variantes de envio e recuperação deste endpoint fazem o mesmo trabalho de forma assíncrona, pelo mesmo preço, para lotes grandes demais para aguardar.

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)[]
    • date_from
      Tipo: string | null

      data inicial do intervalo de tempo
      campo opcional
      formato da data: "yyyy-mm-dd"
      valor mínimo: 4 anos a partir da data atual
      por padrão, os dados são retornados para os últimos 12 meses;
      Observação: a data indicada não pode ser maior que a especificada em date_to e/ou a data de ontem;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_to
      Tipo: string | null

      data final do intervalo de tempo
      campo opcional
      Observação: a data indicada não pode ser maior que o mês passado, o Google Ads não retorna dados do mês atual;
      se você não especificar este campo, a data de ontem será usada por padrão
      formato da data: "yyyy-mm-dd"
      exemplo:
      "2022-11-30"

    • include_adult_keywords
      Tipo: boolean | null

      incluir palavras-chave associadas a conteúdo adulto
      campo opcional
      se definido como true, palavras-chave adultas serão incluídas na resposta
      valor padrão: false
      observe que a API pode não retornar dados para essas palavras-chave devido a restrições do Google Ads

    • 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

    • search_partners
      Tipo: boolean | null

      incluir parceiros de pesquisa do Google
      campo opcional
      se você especificar true, os resultados serão entregues para redes próprias, operadas e sindicadas do Google e sites parceiros que hospedam a pesquisa do Google;
      valor padrão: false - os resultados são retornados para os sites de pesquisa do Google

    • sort_by
      Tipo: string | null

      parâmetros de ordenação dos resultados
      campo opcional
      use estes parâmetros para ordenar os resultados por relevance, search_volume, competition_index, low_top_of_page_bid ou high_top_of_page_bid 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 array data da resposta

Respostas
  • 200
    Tipo: object | null · Response36Afe1097B20_KeywordsDataGoogleAdsSearchVolumeLiveResponseInfo
    • 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_KeywordsDataGoogleAdsSearchVolumeLiveTaskInfo
        • 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: array (object | null)[] | null

          array de resultados

          • competition
            Tipo: string | null

            concorrência
            representa a quantidade relativa de concorrência associada à palavra-chave especificada apenas na SERP paga;
            esse valor é baseado em dados do Google Ads e pode assumir os seguintes valores: HIGH, MEDIUM, LOW;
            se não houver dados, o valor é null;
            saiba mais sobre a métrica neste artigo da central de ajuda

          • competition_index
            Tipo: integer | null

            concorrência
            representa a quantidade relativa de concorrência associada à palavra-chave especificada apenas na SERP paga;
            esse valor é baseado em dados do Google Ads e pode estar entre 0 e 100 (inclusive);
            se não houver dados, o valor é null;
            saiba mais sobre a métrica neste artigo da central de ajuda

          • cpc
            Tipo: number | null

            custo por clique
            indica o valor pago (USD) por cada clique no anúncio exibido para uma determinada palavra-chave

          • high_top_of_page_bid
            Tipo: number | null

            lance máximo para o anúncio ser exibido no topo da primeira página
            indica o valor superior a cerca de 80% dos lances mais baixos para os quais os anúncios foram exibidos (com base nas estatísticas do Google Ads para anunciantes);
            o valor pode variar dependendo da localização especificada em uma requisição POST

          • keyword
            Tipo: string | null

            palavra-chave
            a palavra-chave é retornada com %## decodificado (o caractere de mais '+' será decodificado como espaço)

          • language_code
            Tipo: string | null

            código do idioma em um array do POST
            se não houver dados, o valor é_nulln

          • location_code
            Tipo: integer | null

            código de localização em um array do POST
            se não houver dados, o valor é_nulln

          • low_top_of_page_bid
            Tipo: number | null

            lance mínimo para o anúncio ser exibido no topo da primeira página
            indica o valor superior a cerca de 20% dos lances mais baixos para os quais os anúncios foram exibidos (com base nas estatísticas do Google Ads para anunciantes);
            o valor pode variar dependendo da localização especificada em uma requisição POST

          • monthly_searches
            Tipo: array (object | null)[] | null

            pesquisas mensais
            representa o número (aproximado) de pesquisas dessa ideia de palavra-chave (conforme disponível nos últimos doze meses por padrão), direcionadas às localizações geográficas especificadas;
            se não houver dados, o valor é null

            • month
              Tipo: integer | null

              mês

            • search_volume
              Tipo: integer | null

              taxa média mensal de volume de pesquisa

            • year
              Tipo: integer | null

              ano

          • search_partners
            Tipo: boolean | null

            indica se os dados de redes parceiras estão incluídos na resposta

          • search_volume
            Tipo: integer | null Formato: int64

            taxa média mensal de volume de pesquisa;
            representa o número (aproximado) de pesquisas da ideia de palavra-chave especificada no google.com ou no google.com e parceiros, dependendo do direcionamento do usuário;
            se não houver dados, o valor é null

          • spell
            Tipo: string | null

            ortografia correta da palavra-chave
            Observação:se a palavra-chave no array POST estiver com erro de ortografia, os dados serão retornados para a palavra-chave corrigida;
            usamos a funcionalidade da API Google Ads para verificar e validar a ortografia das palavras-chave, saiba mais neste link

        • 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
Request Example for post/v1/beta/dataforseo/keywords_data/google_ads/search_volume/live
curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/google_ads/search_volume/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "location_code": 2840,
    "keywords": [
      "buy laptop",
      "cheap laptops for sale",
      "purchase laptop"
    ],
    "date_from": "2021-08-01",
    "search_partners": true
  }
]'

{
  "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": [
        {
          "keyword": null,
          "spell": null,
          "location_code": null,
          "language_code": null,
          "search_partners": null,
          "competition": null,
          "competition_index": null,
          "search_volume": null,
          "low_top_of_page_bid": null,
          "high_top_of_page_bid": null,
          "cpc": null,
          "monthly_searches": [
            {
              "year": null,
              "month": null,
              "search_volume": null
            }
          ]
        }
      ]
    }
  ]
}

Operação bem-sucedida

Setting Live ‘Google Ads Search Volume’ Tasks