Получить список кодов всех регионов
REST-метода и gRPC-вызов GetRegionsTree позволяет получить все коды, которые использует Яндекс для определения региона поиска. Список наиболее часто используемых стран и регионов доступен в разделе Регионы поиска.
Эта функциональность находится на стадии Preview.
Чтобы воспользоваться примером, создайте сервисный аккаунт с ролью search-api.webSearch.user и получите для него API-ключ с областью действия yc.search-api.execute. Также вы можете использовать IAM-токен как более безопасный способ. Подробнее об аутентификации в Yandex Search API.
Вызов GetRegionsTree не требует указания ключевой фразы для поиска.
Выполните HTTP-запрос, указав полученный ранее API-ключ или IAM-токен и идентификатор каталога вашего сервисного аккаунта:
-
Аутентификация с IAM-токеном:
curl \ --request POST \ --header "Authorization: Bearer <IAM-токен>" \ "https://searchapi.api.yandexcloud.kz/v2/wordstat/getRegionsTree" \ > regions_tree.json -
Аутентификация с API-ключом:
curl \ --request POST \ --header "Authorization: Api-key <API-ключ>" \ "https://searchapi.api.yandexcloud.kz/v2/wordstat/getRegionsTree" \ > regions_tree.json
Результат будет сохранен в файл regions_tree.json.
Фрагмент ответа
{
"regions": [
{
"id": "225",
"name": "Россия",
"children": [
{
"id": "1",
"name": "Москва и Московская область",
"children": [
{ "id": "213", "name": "Москва" },
{ "id": "1", "name": "Московская область" }
]
},
{
"id": "2",
"name": "Санкт-Петербург и Ленинградская область",
"children": [
{ "id": "2", "name": "Санкт-Петербург" }
]
}
]
}
]
}
Вызов GetRegionsTree не требует указания ключевой фразы для поиска.
Выполните gRPC-вызов, указав полученный ранее API-ключ или IAM-токен и идентификатор каталога вашего сервисного аккаунта:
-
Аутентификация с IAM-токеном:
grpcurl \ -rpc-header "Authorization: Bearer <IAM-токен>" \ -d '{"folderId": "<идентификатор_каталога>"}' \ searchapi.api.yandexcloud.kz:443 yandex.cloud.searchapi.v2.WordstatService/GetRegionsTree \ > regions_tree.json -
Аутентификация с API-ключом:
grpcurl \ -rpc-header "Authorization: Api-Key <API-ключ>" \ -d '{"folderId": "<идентификатор_каталога>"}' \ searchapi.api.yandexcloud.kz:443 yandex.cloud.searchapi.v2.WordstatService/GetRegionsTree \ > regions_tree.json
Результат будет сохранен в файл regions_tree.json.
Фрагмент ответа
{
"regions": [
{
"id": "225",
"name": "Россия",
"children": [
{
"id": "1",
"name": "Москва и Московская область",
"children": [
{ "id": "213", "name": "Москва" },
{ "id": "1", "name": "Московская область" }
]
},
{
"id": "2",
"name": "Санкт-Петербург и Ленинградская область",
"children": [
{ "id": "2", "name": "Санкт-Петербург" }
]
}
]
}
]
}