Mots-clés

API + MCP

GET/v3/gsc/keywords

Les requêtes vers ce point de terminaison sont gratuites et ne consomment aucune unité d’API.

Paramètres de requête

keyword_listsstring

Filtre des listes de mots-clés (chaîne JSON). Prend en charge include (is), exclude (is_not), empty (absent de toute liste) et not_empty (présent dans au moins une liste).

keyword_list_idinteger

L’identifiant d’une liste de mots-clés existante pour laquelle afficher des métriques.

wherestring

Champs pris en charge :

keyword
top_url
url
clicks
impressions
ctr
position

Le filtre est une chaîne JSON représentant une expression booléenne ; elle doit respecter la structure suivante :

<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

Nombre de résultats à renvoyer.

Par défaut:1000

devicestring

Filtrer par type d’appareil (DESKTOP, MOBILE, TABLET). Si non spécifié, tous les appareils sont inclus.

Valeurs autorisées:desktopmobiletablet

countrystring

Un code pays à deux lettres (ISO 3166-1 alpha-2).

Valeurs autorisées:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw

search_typestring

Le type de résultats de recherche à renvoyer (web, image, video, news).

Valeurs autorisées:webimagevideonews

Par défaut:web

date_tostring

Date de fin de la période historique, au format AAAA-MM-JJ.

date_fromstringObligatoire

Date de début de la période historique, au format AAAA-MM-JJ.

portfolio_idinteger

ID du Portfolio. Lorsqu'il est fourni, agrège les données de tous les Projets connectés à GSC dans le Portfolio.

project_idinteger

ID du Projet. Obligatoire lorsque portfolio_id n’est pas fourni.

outputstring

Le format de sortie.

Valeurs autorisées:jsoncsvxmlphp

Réponses

keywordsarray<object>

keywordstring

urls_countinteger

top_urlstring or null

clicksinteger or null

impressionsinteger or null

ctrnumber or null

positionnumber or null

Position moyenne (décimale, p. ex. 4,7)

keyword_list_labelsarray<string>