Docs
Pesquisar na documentação...⌘K

Palavras-chave

API + MCP
GET/v3/gsc/keywords

As solicitações para este endpoint são gratuitas e não consomem unidades da API.

Parâmetros de consulta

keyword_listsstring

Filtro de listas de palavras-chave (string JSON). Oferece suporte a incluir (is), excluir (is_not), vazio (não está em nenhuma lista) e não_vazio (está em alguma lista).

keyword_list_idinteger

O ID de uma lista de palavras-chave existente para exibir métricas.

wherestring

Campos compatíveis:

limitinteger

O número de resultados a retornar.

Padrão:1000
devicestring

Filtre por tipo de dispositivo (DESKTOP, MOBILE, TABLET). Se não for especificado, todos os dispositivos serão incluídos.

Valores permitidos:desktopmobiletablet
countrystring

Um código de país com duas letras (ISO 3166-1 alpha-2).

Valores permitidos:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw
search_typestring

O tipo de resultados de pesquisa a retornar (web, imagem, vídeo, notícias).

Valores permitidos:webimagevideonews
Padrão:web
date_tostring (date)

A data final do período histórico, no formato YYYY-MM-DD.

date_fromstring (date)Obrigatório

A data inicial do período histórico, no formato YYYY-MM-DD.

portfolio_idinteger

ID do Portfolio. Quando fornecido, agrega dados de todos os Projetos conectados ao GSC no portfolio.

project_idinteger

ID do Projeto. Obrigatório quando portfolio_id não é fornecido.

outputstring

O formato de saída.

Valores permitidos:jsoncsvxmlphp

Respostas

keywordsarray<object>
keywordstring
urls_countinteger
top_urlstring (url) or null
clicksinteger or null
impressionsinteger or null
ctrnumber (float) or null
positionnumber (float) or null

Posição média (decimal, ex.: 4,7)

keyword_list_labelsarray<string>