Получение информации о Sitemap, добавленном пользователем

Возвращает подробную информацию о файле Sitemap, добавленном пользователем, включая тип файла, дату и способ загрузки файла в Яндекс Вебмастер, дату обработки файла сервисом, количество содержащихся в файле URL, а также количество и тип обнаруженных ошибок.

Формат запроса

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/user-added-sitemaps/{sitemap-id}

user-id

Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

host-id

Тип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

sitemap-id

Тип: sitemap id (string). ID файла Sitemap.

Формат ответа

Примеры

{
  "sitemap_id": "c7-fe:80-c0",
  "sitemap_url": "some url",
  "added_date": "2016-01-01T00:00:00,000+0300"
}

<Data>
    <sitemap_id>c7-fe:80-c0</sitemap_id>
    <sitemap_url>some url</sitemap_url>
    <added_date>2016-01-01T00:00:00,000+0300</added_date>
</Data>

Имя

Обязательный

Тип

Описание

sitemap_id

Да

string

ID файла sitemap.

sitemap_url

Да

string

URL файла sitemap.

added_date

Да

datetime

Дата последней загрузки файла.

Коды ответа

Чтобы посмотреть структуру ответа подробнее, нажмите на причину.

Код

Причина

Описание

200

OK

403

INVALID_USER_ID

ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже {user_id} указан правильный uid владельца OAuth-токена.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}

<Data>
    <error_code>INVALID_USER_ID</error_code>
    <available_user_id>1</available_user_id>
    <error_message>Invalid user id. {user_id} should be used.</error_message>
</Data>

404

HOST_NOT_VERIFIED

Не подтверждены права на управление сайтом.

{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}

<Data>
  <error_code>HOST_NOT_VERIFIED</error_code>  
  <host_id>http:ya.ru:80</host_id>
  <error_message>some string</error_message>
</Data>

404

SITEMAP_NOT_ADDED

Файл Sitemap отсутствует.

{
  "error_code": "SITEMAP_NOT_ADDED",
  "host_id": "http:ya.ru:80",
  "sitemap_id": "c7-fe:80-c0",
  "error_message": "some string"
}

<Data>
  <error_code>SITEMAP_NOT_ADDED</error_code> 
  <host_id>http:ya.ru:80</host_id>  
  <sitemap_id>c7-fe:80-c0</sitemap_id>  
  <error_message>some string</error_message>
</Data>

Узнайте больше

Тип: 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 пользователя, от имени которого разрешен доступ.

Описание

Дата и время, до которого адрес доступен для создания задачи.

Описание

Список поддерживаемых типов контента.

Описание

Список поддерживаемых типов кодировки.

Описание

Максимальная длина.

Описание

Минимальная длина.

Описание

Доступное количество запросов в сутки.

Тип: sitemap id (string). ID файла Sitemap.

Обязательный

Да

Тип

string

Описание

ID файла sitemap.

Обязательный

Да

Тип

string

Описание

URL файла sitemap.

Обязательный

Да

Тип

datetime

Описание

Дата последней загрузки файла.

Предыдущая
Получение списка файлов Sitemap, добавленных пользователем
Следующая
Добавление файла Sitemap