Docs
Cerca nella documentazione...⌘K

Parole chiave

API + MCP
GET/v3/gsc/keywords

Le richieste a questo endpoint sono gratuite e non consumano alcuna unità API.

Parametri della query

keyword_listsstring

Filtro per elenchi di parole chiave (stringa JSON). Supporta include (is), exclude (is_not), empty (non presente in alcun elenco) e not_empty (presente in almeno un elenco).

keyword_list_idinteger

L'id di un elenco di parole chiave esistente per cui mostrare le metriche.

wherestring

Campi supportati:

  • keyword
  • top_url
  • url
  • clicks
  • impressions
  • ctr
  • position

Il filtro è una stringa JSON che rappresenta un'espressione booleana e deve seguire la seguente struttura:

<bool_filter> ::= { "and" : <bool_filter>+ }
              |   { "or" : <bool_filter>+ }
              |   { "not" : <bool_filter> }
              |   <expr>

<expr> ::= {
             "field" : <dimension|metric>,
             ? "is": <condition>,
           }

<condition> ::= [ "eq", <value> ]
            |   [ "neq", <value> ]
            |   [ "gt", <value> ]
            |   [ "gte", <value> ]
            |   [ "lt", <value> ]
            |   [ "lte", <value> ]
            |   [ "substring", <value> ]
            |   [ "isubstring", <value> ]
            |   [ "phrase_match", <value> ]
            |   [ "iphrase_match", <value> ]
            |   [ "prefix", <value> ]
            |   [ "suffix", <value> ]
limitinteger

Il numero di risultati da restituire.

Predefinita:1000
devicestring

Filtra per tipo di dispositivo (DESKTOP, MOBILE, TABLET). Se non specificato, sono inclusi tutti i dispositivi.

Valori consentiti:desktopmobiletablet
countrystring

Un codice paese a due lettere (ISO 3166-1 alpha-2).

Valori consentiti:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw
search_typestring

Il tipo di risultati di ricerca da restituire (web, image, video, news).

Valori consentiti:webimagevideonews
Predefinita:web
date_tostring

La data di fine del periodo storico nel formato YYYY-MM-DD.

date_fromstringObbligatorio

La data di inizio del periodo storico nel formato YYYY-MM-DD.

portfolio_idinteger

ID del Portfolio. Se fornito, aggrega i dati di tutti i Progetti connessi a GSC nel Portfolio.

project_idinteger

ID del Progetto. Obbligatorio quando non viene fornito portfolio_id.

outputstring

Il formato di output.

Valori consentiti:jsoncsvxmlphp

Risposte

keywordsarray<object>
keywordstring
urls_countinteger
top_urlstring or null
clicksinteger or null
impressionsinteger or null
ctrnumber or null
positionnumber or null

Posizione media (decimale, ad es. 4.7)

keyword_list_labelsarray<string>