v0.2.0-beta

OpenAPI 3.1.0

Configurar tarefas de SERP do Google AI Mode

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

Configurar tarefas de SERP do Google AI Mode

Enfileira a resposta do AI Mode do Google para uma consulta, com as fontes citadas 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: 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
- 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 à função que você usou para definir uma tarefa
  
  valores possíveis:
  
  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 Pricing.
- 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_SerpGoogleAiModeTaskPostResponseInfo
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_SerpGoogleAiModeTaskPostTaskInfo
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/ai_mode/task_post

curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/ai_mode/task_post \
  --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": null
    }
  ]
}

Operação bem-sucedida

Configurar tarefas de SERP do Google AI Mode

AutenticaçãoRequired

DataForSEO

Configurar tarefas de SERP do Google AI Mode

Referência de preços