v0.2.0-beta

OpenAPI 3.1.0

SERP do Google AI Mode 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

post/v1/beta/dataforseo/serp/google/ai_mode/live/advanced

SERP do Google AI Mode em tempo real

Retorna a resposta do AI Mode do Google para uma consulta, com as fontes citadas no Google, de forma síncrona. Retorna keyword, type, se_domain, location_code, language_code, check_url, datetime, spell, refinement_chips, item_types, items_count e items. advanced é a escolha padrão; use regular quando apenas a lista classificada importar e html somente para verificar o que o analisador descartou. Encapsulado no envelope do DataForSEO: dados em tasks[0].result, resultado em tasks[0].status_code — uma requisição rejeitada ainda retorna HTTP 200.

Referência de preços

Medição: Custo da resposta reportado.
Estimativa de referência por requisição: USD 0.004.
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: se definido como true, a cobrança por tarefa será multiplicada por 2
- 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
- keyword
  Tipo: string
  
  palavra-chave
  
  campo obrigatório
  
  você pode especificar até 700 caracteres no campo keyword
  
  todos os %## serão decodificados (o caractere ‘+’ 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”
  
  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/ai_mode/languages
- 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/ai_mode/languages;
- location_code
  Tipo: integer
  
  código de localização 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 localizações disponíveis dos mecanismos de busca com seu location_code fazendo uma requisição separada para o https://api.dataforseo.com/v3/serp/google/locations
  
  Observação: consulte Google Search Help para obter a lista de países onde o AI Mode está disponível no momento
- 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,zoom"
  
  se "zoom" não for especificado, 9z será aplicado como valor padrão
  
  o número máximo de casas decimais para "latitude" e "longitude": 7
  
  o valor mínimo para "zoom": 4z
  
  o valor máximo para "zoom": 18z
  
  exemplo:
  
  52.6178549,-155.352142,18z
- 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 localizações disponíveis do mecanismo de busca com seu location_name fazendo uma requisição separada para o https://api.dataforseo.com/v3/serp/google/locations
  
  Observação: consulte Google Search Help para obter a lista de países onde o AI Mode está disponível no momento
- 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
- 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

Respostas

200
Tipo: object | null · Response36Afe1097B20_SerpGoogleAiModeLiveAdvancedResponseInfo
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_SerpGoogleAiModeLiveAdvancedTaskInfo
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

check_url
Tipo: string | null

URL direta para os resultados do mecanismo de busca
você pode usá-la para garantir que fornecemos resultados exatos

datetime
Tipo: string | null

data e hora em que o resultado foi recebido
no formato UTC: “yyyy-mm-dd hh-mm-ss +00:00”
exemplo:
2019-11-15 12:57:46 +00:00

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

tipos de resultados de pesquisa na SERP
contém os tipos de resultados de pesquisa (items) encontrados na SERP.
tipos de itens possíveis:
ai_overview

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

itens do elemento

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

itens presentes no elemento

position
Tipo: string | null

o alinhamento do elemento na SERP
pode assumir os seguintes valores:
left, right

type
Tipo: string | null

tipo de elemento

markdown
Tipo: string | null

conteúdo do elemento em formato markdown
o texto do ai_overview formatado na linguagem de marcação markdown

page
Tipo: integer | null

página de SERP
página de SERP na qual o elemento é classificado

position
Tipo: string | null

o alinhamento do elemento na SERP
pode assumir os seguintes valores:
left, right

rank_absolute
Tipo: integer | null

classificação absoluta na SERP
posição absoluta entre todos os elementos da SERP

rank_group
Tipo: integer | null

classificação de grupo na SERP
posição dentro de um grupo de elementos com valores de type idênticos
as posições dos elementos com valores de type diferentes são omitidas de rank_group

rectangle
Tipo: object | null · Response36Afe1097B20_AiModeRectangleInfo

parâmetros do retângulo
contém coordenadas cartesianas e dimensões em pixels do snippet do resultado na SERP
equivale a null se calculate_rectangles na requisição POST não estiver definido como true

height
Tipo: number | null Formato: double

altura do elemento em pixels

width
Tipo: number | null Formato: double

largura do elemento em pixels

x
Tipo: number | null Formato: double

coordenada do eixo x coordenada do eixo x do canto superior esquerdo do snippet do resultado, em que o canto superior esquerdo da tela é a origem

y
Tipo: number | null Formato: double

coordenada do eixo y coordenada do eixo y do canto superior esquerdo do snippet do resultado, em que o canto superior esquerdo da tela é a origem

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

referências adicionais relevantes para o item
inclui referências a páginas da web que podem ter sido usadas para gerar o ai_overview

domain
Tipo: string | null

nome de domínio da referência

position
Tipo: string | null

o alinhamento do elemento na SERP
pode assumir os seguintes valores:
left, right

source
Tipo: string | null

nome ou título da fonte de referência

text
Tipo: string | null

texto do componente

title
Tipo: string | null

texto âncora do link

type
Tipo: string | null

tipo de elemento

url
Tipo: string | null

URL do link

type
Tipo: string | null

tipo de elemento

xpath
Tipo: string | null

o XPath do elemento

items_count
Tipo: integer | null Formato: int64

o número de resultados retornados no array items

keyword
Tipo: string | null

palavra-chave recebida em um array POST
a palavra-chave é retornada com %## decodificado (o símbolo de mais '+' será decodificado como um espaço)

language_code
Tipo: string | null

código de idioma em um array POST

location_code
Tipo: integer | null

código de localização em um array POST

refinement_chips
Tipo: object | null · Response36Afe1097B20_RefinementChipsInfo

chips de refinamento de pesquisa
nesse caso, o valor será null

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

itens do elemento

domain
Tipo: string | null

domínio na SERP

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

mais opções de refinamento da pesquisa

domain
Tipo: string | null

domínio na SERP

title
Tipo: string | null

título do elemento

type
Tipo: string | null

tipo de elemento

url
Tipo: string | null

URL de pesquisa com parâmetros de refinamento

title
Tipo: string | null

título do elemento

type
Tipo: string | null

tipo de elemento

url
Tipo: string | null

URL de pesquisa com parâmetros de refinamento

type
Tipo: string | null

tipo de elemento

xpath
Tipo: string | null

o XPath do elemento

se_domain
Tipo: string | null

domínio do mecanismo de busca em um array POST

se_results_count
Tipo: integer | null Formato: int64

total de resultados na SERP

spell
Tipo: object | null · Response36Afe1097B20_SpellInfo

autocorreção do mecanismo de busca
se o mecanismo de busca forneceu resultados para uma palavra-chave corrigida, indicaremos a palavra-chave corrigida pelo mecanismo de busca e o tipo de autocorreção;
nesse caso, o valor será null

keyword
Tipo: string | null

palavra-chave obtida como resultado da autocorreção do mecanismo de pesquisa os resultados serão fornecidos para a palavra-chave corrigida

type
Tipo: string | null

tipo de autocorreção valores possíveis: did_you_mean, showing_results_for, no_results_found_for, including_results_for observação: Yahoo e Yandex suportam apenas o seguinte tipo de autocorreção: including_results_for

type
Tipo: string | null

tipo de elemento

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/ai_mode/live/advanced

curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/ai_mode/live/advanced \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "what is google ai mode"
  }
]'

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": [
        {
          "keyword": null,
          "type": null,
          "se_domain": null,
          "location_code": null,
          "language_code": null,
          "check_url": null,
          "datetime": null,
          "spell": {
            "keyword": null,
            "type": null
          },
          "refinement_chips": {
            "type": null,
            "xpath": null,
            "items": [
              "[Max Depth Exceeded]"
            ]
          },
          "item_types": [
            null
          ],
          "se_results_count": null,
          "items_count": null,
          "items": [
            {
              "type": null,
              "rank_group": null,
              "rank_absolute": null,
              "page": null,
              "position": null,
              "xpath": null,
              "markdown": null,
              "items": [
                "[Max Depth Exceeded]"
              ],
              "references": [
                "[Max Depth Exceeded]"
              ],
              "rectangle": "[Max Depth Exceeded]"
            }
          ]
        }
      ]
    }
  ]
}

Operação bem-sucedida

SERP do Google AI Mode em tempo real

AutenticaçãoRequired

DataForSEO

SERP do Google AI Mode em tempo real

Referência de preços