Получение информации о сайте
Возвращает информацию о сайте.
Формат запроса
GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}
|
|
Тип: |
|
|
Тип: |
Формат ответа
Пример
JSONXML{ "host_id": "https:ya.ru:443", "verified": true, "ascii_host_url": "https://ya.ru/", "unicode_host_url": "https://ya.ru/", "main_mirror": { "host_id": "http:xn--d1acpjx3f.xn--p1ai:80", "ascii_host_url": "http://xn--d1acpjx3f.xn--p1ai/", "unicode_host_url": "http://Яндекс рф/", "verified": false }, "host_data_status": "NOT_INDEXED", "host_display_name": "Ya.ru" }<Data> <host_id>https:ya.ru:443</host_id> <verified>true</verified> <ascii_host_url>https://ya.ru/</ascii_host_url> <unicode_host_url>https://ya.ru/</unicode_host_url> <main_mirror> <host_id>http:xn--d1acpjx3f.xn--p1ai:80</host_id> <ascii_host_url>http://xn--d1acpjx3f.xn--p1ai/</ascii_host_url> <unicode_host_url>http://Яндекс рф/</unicode_host_url> <verified>false</verified> </main_mirror> <host_data_status>NOT_INDEXED</host_data_status> <host_display_name>Ya.ru</host_display_name> </Data>
|
Имя |
Обязательный |
Тип |
Описание |
|
|
Да |
|
ID запрошенного сайта. |
|
|
Да |
|
ASCII URL сайта. |
|
|
Да |
|
UTF-8 URL сайта. |
|
|
Да |
|
Подтвержден ли сайт. |
|
|
Нет |
Главный адрес сайта, если есть. |
|
|
|
Нет |
|
Информация о сайте (показывается, если сайт подтвержден). |
|
|
Нет |
|
Отображаемое имя сайта. |
Статус индексирования сайта (ApiHostDataStatus)
|
Источник |
Описание |
|
|
Сайт еще не проиндексирован. |
|
|
Данные о сайте еще не загружены в Яндекс Вебмастер. |
|
|
Сайт проиндексирован, данные доступны в Яндекс Вебмастере. |
Коды ответа
Чтобы посмотреть структуру ответа подробнее, нажмите на причину.
|
Код |
Причина |
Описание |
|
200 |
OK |
|
|
403 |
ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже JSON
XML
|
|
|
404 |
Сайт отсутствует в списке сайтов пользователя. JSON
XML
|
Узнайте больше
Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
Тип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.
Обязательный параметр
Смещение в списке. Минимальное значение — 0. Значение по умолчанию: 0.
Количество записей (1-100). Значение по умолчанию: 10.
Описание
Код ошибки.
Описание
Сообщение об ошибке.
Описание
Значение.
Описание
Поле.
Описание
ID запрошенного сайта.
Описание
ID сайта.
Описание
Признак подтверждения сайта.
Описание
ID файла Sitemap.
Описание
Список поддерживаемых типов контента.
Описание
Лимит на количество добавленных сайтов.
Описание
Лимит количества фидов.
Описание
Лимит количества добавленных фидов.
Описание
ID пользователя, от имени которого разрешен доступ.
Описание
Дата и время, до которого адрес доступен для создания задачи.
Описание
Список поддерживаемых типов контента.
Описание
Список поддерживаемых типов кодировки.
Описание
Максимальная длина.
Описание
Минимальная длина.
Описание
Доступное количество запросов в сутки.
Статус индексирования сайта (ApiHostDataStatus)
|
Источник |
Описание |
|
|
Сайт еще не проиндексирован. |
|
|
Данные о сайте еще не загружены в Яндекс Вебмастер. |
|
|
Сайт проиндексирован, данные доступны в Яндекс Вебмастере. |
Обязательный
Да
Тип
host id (string)
Описание
ID запрошенного сайта.
Обязательный
Да
Тип
string
Описание
ASCII URL сайта.
Обязательный
Да
Тип
string
Описание
UTF-8 URL сайта.
Обязательный
Да
Тип
boolean
Описание
Подтвержден ли сайт.
Обязательный
Нет
Тип
Описание
Главный адрес сайта, если есть.
Обязательный
Нет
Тип
string (ApiHostDataStatus)
Описание
Информация о сайте (показывается, если сайт подтвержден).
Обязательный
Нет
Тип
string
Описание
Отображаемое имя сайта.