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

Configurar tarefas de Google Organic SERP

Servidor:https://openapi.felo.ai
Bibliotecas Cliente

DataForSEO

​

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

Configurar tarefas de Google Organic SERP

​

Enfileira os resultados classificados de 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)[]
    • browser_screen_height
      Tipo: integer | null

      altura da tela do navegador

      campo opcional

      você pode definir uma altura de tela de navegador personalizada para calcular o ranking em pixels de um dispositivo específico;

      pode ser especificada dentro do seguinte intervalo: 240-9999;

      por padrão, o parâmetro é definido como:

      1080 para desktop;

      640 para mobile no android;

      812 para mobile no iOS;

      Observação: para usar este parâmetro, defina calculate_rectangles como true

    • browser_screen_resolution_ratio
      Tipo: integer | null

      proporção de resolução da tela do navegador

      campo opcional

      você pode definir uma proporção de resolução de tela de navegador personalizada para calcular o ranking em pixels de um dispositivo específico;

      pode ser especificada dentro do seguinte intervalo: 0.5-3;

      por padrão, o parâmetro é definido como:

      1 para desktop;

      3 para mobile no android;

      3 para mobile no iOS;

      Observação: para usar este parâmetro, defina calculate_rectangles como true

    • browser_screen_width
      Tipo: integer | null Formato: int64

      largura da tela do navegador

      campo opcional

      você pode definir uma largura de tela de navegador personalizada para calcular o ranking em pixels de um dispositivo específico;

      pode ser especificada dentro do seguinte intervalo: 240-9999;

      por padrão, o parâmetro é definido como:

      1920 para desktop;

      360 para mobile no android;

      375 para mobile no iOS;

      Observação: para usar este parâmetro, defina calculate_rectangles como true

    • calculate_rectangles
      Tipo: boolean | null

      calcular o ranking em pixels para elementos do SERP em resultados avançados

      campo opcional

      o ranking em pixels se refere à distância entre o snippet do resultado e o canto superior esquerdo da tela;

      Visite a Central de Ajuda para saber mais>>

      por padrão, o parâmetro está definido como false

      Observação: você será cobrado US$ 0,0006 a mais por usar este parâmetro

    • depth
      Tipo: integer | null

      profundidade de análise

      campo opcional

      número de resultados na SERP

      valor padrão: 10

      valor máximo: 700


      Sua conta será cobrada por cada SERP contendo até 10 resultados;

      Definir uma profundidade acima de 10 pode gerar cobranças adicionais se o mecanismo de busca retornar mais de 10 resultados;

      O custo pode ser calculado na página Preços.

    • device
      Tipo: string | null

      tipo de dispositivo

      campo opcional

      retornar resultados para um tipo de dispositivo específico

      pode assumir os valores:desktop, mobile

      valor padrão: desktop

    • expand_ai_overview
      Tipo: boolean | null

      expandir visão geral de IA

      campo opcional

      defina como true para expandir o item ai_overview;

      valor padrão: false;

      Observação: este parâmetro se aplica apenas a resultados de tarefa HTML

    • find_targets_in
      Tipo: array string[] | null

      tipos de elemento do SERP a verificar para destinos

      campo opcional

      para ativar este parâmetro, stop_crawl_on_match também precisa estar ativado

      especifica quais tipos de elemento do SERP devem ser verificados para correspondências de destino

      se não for especificado, todos os elementos de primeiro nível com os campos url e domain são verificados para destinos

      valores possíveis: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitter

      Observação: não pode conter os mesmos tipos de elemento que ignore_targets_in

      exemplo:

      "find_targets_in": ["organic", "featured_snippet"]

      saiba mais sobre este parâmetro na nossa Central de Ajuda

    • group_organic_results
      Tipo: boolean | null

      exibir resultados relacionados

      campo opcional

      se definido como true, o elemento related_result na resposta será fornecido como um snippet do seu resultado orgânico pai;

      se definido como false, o elemento related_result será fornecido como um resultado orgânico separado;

      valor padrão: true

    • ignore_targets_in
      Tipo: array string[] | null

      tipos de elemento do SERP a excluir da busca de destinos

      campo opcional

      para ativar este parâmetro, stop_crawl_on_match também precisa estar ativado

      especifica quais tipos de elemento do SERP devem ser excluídos ao buscar correspondências de destino

      valores possíveis: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitter

      Observação: não pode conter os mesmos tipos de elemento que find_targets_in

      exemplo:

      "ignore_targets_in": ["paid", "images"]

      saiba mais sobre este parâmetro na nossa Central de Ajuda

    • keyword
      Tipo: string

      palavra-chave

      campo obrigatório

      você pode especificar até 700 caracteres no campo keyword

      todos os %## serão decodificados (o caractere ‘+’ também será decodificado como espaço)

      se precisar usar o caractere “%” no seu keyword, especifique-o como “%25”;

      se precisar usar o caractere “+” no seu keyword, especifique-o como “%2B”;

      se este campo contiver parâmetros como ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, a cobrança por tarefa será multiplicada por 5

      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

      código do idioma do mecanismo de busca

      campo obrigatório se você não especificar language_name

      se você usar este campo, não precisa especificar language_name

      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/serp/google/languages

      exemplo:

      en

    • language_name
      Tipo: string

      nome completo do idioma do mecanismo de busca

      campo obrigatório se você não especificar language_code

      se você usar este campo, não precisa especificar language_code

      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/serp/google/languages

      exemplo:

      English

    • load_async_ai_overview
      Tipo: boolean | null

      carregar visão geral de IA assíncrona

      campo opcional

      defina como true para obter itens ai_overview nas SERPs mesmo que sejam carregados de forma assíncrona;

      se definido como false, você obterá itens ai_overview apenas do cache;

      valor padrão: false

      Observação: você será cobrado US$ 0,0006 a mais por usar este parâmetro;

      se o elemento estiver ausente ou contiver "asynchronous_ai_overview": false, todos os valores extras serão devolvidos ao saldo da sua conta

    • location_code
      Tipo: integer

      código do local do mecanismo de busca

      campo obrigatório se você não especificar location_name ou location_coordinate

      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/locations

      exemplo:

      2840

    • location_coordinate
      Tipo: string

      coordenadas GPS de um local

      campo obrigatório se você não especificar location_name ou location_code

      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,radius"

      o número máximo de casas decimais para "latitude" e "longitude": 7

      o valor mínimo para "radius": 199 (mm)

      o valor máximo para "radius": 199999 (mm)

      exemplo:

      53.476225,-2.243572,200

    • location_name
      Tipo: string

      nome completo do local do mecanismo de busca

      campo obrigatório se você não especificar location_code ou location_coordinate

      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/locations

      exemplo:

      London,England,United Kingdom

    • match_type
      Tipo: string

      tipo de correspondência de destino

      campo obrigatório se stop_crawl_on_match for especificado

      tipo de correspondência para o match_value

      valores possíveis:

      domain – domínio ou subdomínio específico

      with_subdomains – domínio principal e subdomínios

      wildcard – padrão curinga

    • match_value
      Tipo: string

      domínio, subdomínio ou valor curinga de destino

      campo obrigatório se stop_crawl_on_match for especificado

      especifique um domínio, subdomínio ou valor curinga de destino;

      Observação: o domínio ou subdomínio deve ser especificado sem protocolo de requisição;

      exemplo: "match_value": "dataforseo.com",

      "match_value": "/blog/post-*"

    • max_crawl_pages
      Tipo: integer | null

      limite de páginas rastreadas

      campo opcional

      número de páginas de resultados de pesquisa a rastrear

      valor máximo: 100

      Observação: você será cobrado por cada página rastreada (10 resultados orgânicos por página);

      saiba mais sobre preços na nossa página Preços;

      Observação nº 2: os parâmetros max_crawl_pages e depth se complementam;

      saiba mais na nossa Central de Ajuda

    • os
      Tipo: string | null

      sistema operacional do dispositivo

      campo opcional

      se você especificar desktop no campo device, escolha entre os seguintes valores: windows, macos

      valor padrão: windows

      se você especificar mobile no campo device, escolha entre os seguintes valores: android, ios

      valor padrão: android

    • people_also_ask_click_depth
      Tipo: integer | null

      cliques no elemento correspondente

      campo opcional

      especifique a profundidade de cliques no elemento people_also_ask para obter itens people_also_ask_element adicionais;

      Observe que sua conta será cobrada US$ 0,00015 a mais por cada clique, independentemente da prioridade da tarefa;

      se o elemento estiver ausente ou realizarmos menos cliques do que você especificou, todos os valores extras serão devolvidos ao saldo da sua conta

      valores possíveis: de 1 a 4

    • 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

    • postback_data
      Tipo: string

      tipo de dados de postback_url

      campo obrigatório se você especificar postback_url

      corresponde ao tipo de dados que será enviado ao seu servidor

      valores possíveis:

      regular, advanced, html

    • 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.

    • remove_from_url
      Tipo: array string[] | null

      remover parâmetros específicos das URLs

      campo opcional

      usando este campo, você pode especificar até 10 parâmetros para remover das URLs no resultado

      exemplo:

      "remove_from_url": ["srsltid"]

    • se_domain
      Tipo: string | null

      domínio do mecanismo de busca

      campo opcional

      escolhemos automaticamente o domínio do mecanismo de busca relevante de acordo com a localização e o idioma especificados

      no entanto, você pode definir um domínio personalizado do mecanismo de busca neste campo

      exemplo:

      google.co.uk, google.com.au, google.de, etc.

    • search_param
      Tipo: string | null

      parâmetros adicionais da consulta de pesquisa

      campo opcional

      obtenha a lista de parâmetros disponíveis e mais detalhes aqui


      Observação: os seguintes parâmetros do mecanismo de busca não são suportados e serão removidos automaticamente se especificados: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.
    • stop_crawl_on_match
      Tipo: array (object | null)[] | null

      array de destinos para interromper o rastreamento campo opcional se especificado, a resposta conterá resultados de SERP até o match_value especificado, inclusive; você pode especificar até 10 valores de destino neste array exemplo: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] saiba mais sobre este parâmetro na nossa Central de Ajuda - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Sua conta será cobrada por cada SERP rastreada pelos destinos especificados

      • match_type
        Tipo: string | null

        tipo de correspondência de destino campo obrigatório se stop_crawl_on_match for especificado; tipo de correspondência para match_value valores possíveis: domain, with_subdomains, wildcard

      • match_value
        Tipo: string | null

        domínio ou valor curinga de destino campo obrigatório se stop_crawl_on_match for especificado; especifique um domínio ou valor curinga de destino; Observação: o nome de domínio deve ser especificado sem protocolo de requisição; exemplo: dataforseo.com

    • 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_search_mode
      Tipo: string | null

      modo de correspondência de destino

      campo opcional

      para habilitar este parâmetro, stop_crawl_on_match também deve estar habilitado

      define como o rastreamento deve parar quando vários destinos são especificados em stop_crawl_on_match

      valores possíveis: all, any

      all – o rastreamento para somente quando todos os destinos especificados são encontrados

      any – o rastreamento para quando qualquer destino é encontrado

      valor padrão: any

      saiba mais sobre este parâmetro na nossa Central de Ajuda

    • url
      Tipo: string | null

      URL direta da consulta de pesquisa

      campo opcional

      você pode especificar uma URL direta e nós a converteremos nos campos necessários. Observe que este método é o mais difícil para nossa API processar e também exige que você especifique o idioma e o local exatos na URL. Na maioria dos casos, não recomendamos usar este método.

      exemplo:

      https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS


      Observação: os seguintes parâmetros do mecanismo de busca não são suportados e serão removidos automaticamente se especificados na URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.
Respostas
  • 200
    Tipo: object | null · Response36Afe1097B20_SerpGoogleOrganicTaskPostResponseInfo
    • 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_SerpGoogleOrganicTaskPostTaskInfo
        • 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
Request Example for post/v1/beta/dataforseo/serp/google/organic/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/organic/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "albert einstein"
  },
  {
    "language_name": "English",
    "location_name": "United States",
    "keyword": "albert einstein",
    "priority": 2,
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  },
  {
    "url": "https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS",
    "postback_data": "html",
    "postback_url": "https://your-server.com/postbackscript"
  }
]'
{
  "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
    }
  ]
}
Setting Google Organic SERP Tasks