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

Возвращает список файлов Sitemap, добавленных пользователем.

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/user-added-sitemaps
  ? [offset=<sitemap id>]
  & [limit=<int 32>]

user-id

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

host-id

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

offset

Получить файлы, отсчитывая от указанного (исключительно). Значение по умолчанию: 0.

limit

Количество записей (1-100). Значение по умолчанию: 100.

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

Примеры

{
  "sitemaps": [
    {
      "sitemap_id": "c7-fe:80-c0",
      "sitemap_url": "some url",
      "added_date": "2016-01-01T00:00:00,000+0300"
    }, ...
  ],
  "count": 1
}

<Data>
  <sitemap>
        <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>
  </sitemap>
  ...
  <count>1</count>
</Data>

Имя

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

Тип

Описание

sitemap_id

Да

string

Идентификатор файла Sitemap.

sitemap_url

Да

string

URL файла Sitemap.

added_date

Да

datetime

Дата добавления файла.

count

Да

int32

Общее количество файлов Sitemap, добавленных пользователем.

Коды ответа

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

Код

Причина

Описание

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>

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

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

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

Количество записей (1-100). Значение по умолчанию: 10.

Описание

Код ошибки.

Описание

Сообщение об ошибке.

Описание

ID запрошенного сайта.

Описание

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

Получить файлы, отсчитывая от указанного (исключительно). Значение по умолчанию: 0.

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

Да

Тип

string

Описание

Идентификатор файла Sitemap.

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

Да

Тип

string

Описание

URL файла Sitemap.

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

Да

Тип

datetime

Описание

Дата добавления файла.

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

Да

Тип

int32

Описание

Общее количество файлов Sitemap, добавленных пользователем.

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