Docs
Пошук документації...⌘K

Ключові слова

API + MCP
GET/v3/gsc/keywords

Запити до цього ендпоїнта безкоштовні та не витрачають жодних одиниць API.

Параметри запиту

keyword_listsstring

Фільтр списків ключових слів (рядок JSON). Підтримує включення (is), виключення (is_not), порожнє значення (not in any list) і непорожнє значення (in any list).

keyword_list_idinteger

ID наявного списку ключових слів, для якого потрібно показати метрики.

wherestring

Підтримувані поля:

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

Фільтр — це рядок JSON, що представляє булевий вираз; він має відповідати такій структурі:

<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

Кількість результатів, які потрібно повернути.

За Замовчуванням:1000
devicestring

Фільтр за типом пристрою (DESKTOP, MOBILE, TABLET). Якщо не вказано, включаються всі пристрої.

Дозволені значення:desktopmobiletablet
countrystring

Дволітерний код країни (ISO 3166-1 alpha-2).

Дозволені значення:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw
search_typestring

Тип результатів пошуку, які потрібно повернути (web, image, video, news).

Дозволені значення:webimagevideonews
За Замовчуванням:web
date_tostring

Кінцева дата історичного періоду у форматі YYYY-MM-DD.

date_fromstringОбов’язково

Початкова дата історичного періоду у форматі YYYY-MM-DD.

portfolio_idinteger

ID Portfolio. Якщо вказано, агрегує дані з усіх проєктів у Portfolio, підключених до GSC.

project_idinteger

ID Проєкту. Обов'язково, якщо portfolio_id не вказано.

outputstring

Формат виводу.

Дозволені значення:jsoncsvxmlphp

Відповіді

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

Середня позиція (десяткове число, наприклад 4.7)

keyword_list_labelsarray<string>