Получить распределение количества запросов с ключевой фразой по регионам

Создайте файл с телом запроса (например, body.json):

 {
   "phrase": "<ключевая_фраза>",
   "region": "REGION_CITIES",
   "devices": ["DEVICE_PHONE"],
   "folderId": "<идентификатор_каталога>"
}

Где:

• phrase — ключевая фраза запроса, поддерживает поисковые операторы.
• region — уровень детализации распределения. Возможные значения:
  • REGION_CITIES: детализация только по городам.
  • REGION_REGIONS: детализация только по регионам.
  • REGION_ALL: везде, значение по умолчанию.
• devices — список типов устройств, с которых был задан запрос. Возможные значения:
  • DEVICE_ALL: все устройства.
  • DEVICE_DESKTOP: компьютеры.
  • DEVICE_PHONE: телефоны.
  • DEVICE_TABLET: планшеты.
• folderId — идентификатор каталога вашего сервисного аккаунта.

Выполните gRPC-вызов, указав полученный ранее API-ключ или IAM-токен и путь к файлу с телом запроса:

• Аутентификация с IAM-токеном:

  grpcurl \
    -rpc-header "Authorization: Bearer <IAM-токен>" \
    -d @ < body.json \
    searchapi.api.yandexcloud.kz:443 yandex.cloud.searchapi.v2.WordstatService/GetRegionsDistribution \
    > result.json
  

• Аутентификация с API-ключом:

  grpcurl \
    -rpc-header "Authorization: Api-Key <API-ключ>" \
    -d @ < body.json \
    searchapi.api.yandexcloud.kz:443 yandex.cloud.searchapi.v2.WordstatService/GetRegionsDistribution \
    > result.json
  

Результат будет сохранен в файл result.json.

Ответ содержит массив объектов со следующими параметрами:

• region — идентификатор региона.
• count — количество запросов с указанной фразой в регионе.
• share — доля запросов с фразой от общего числа запросов в регионе
• affinityIndex — индекс соответствия — отношение доли запросов в регионе к их доле по стране.

{
  "results": [
    { "region": "213", "count": "3200", "share": 0.034, "affinityIndex": 1.8 },
    { "region": "2",   "count": "1500", "share": 0.016, "affinityIndex": 1.2 }
  ]
}