Получение списка оригинальных текстов

Описание

Позволяет получить список всех оригинальных текстов сайта, загруженных в Яндекс.Вебмастер.

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

Отправьте GET-запрос на адрес операции original-texts ресурса сайта пользователя:

GET https://api.webmaster.yandex.net/v3/user/{user-id}/hosts/{host-id}/original-texts/[?offset={offset}&limit={limit}]

Path-параметры

Имя Обязательный Тип Значение по умолчанию Описание
user-id Да int64 ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /user/.
host-id Да host id ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts/.

Query-параметры

Имя Обязательный Тип Значение по умолчанию Описание
offset Нет int32 0 Смещение в полученном списке. Минимальное значение - 0.
limit Нет int32 10 Размер страницы (1-100).

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

В случае успеха сервер возвращает 200 OK и список оригинальных текстов сайта

Примеры

{
  "original_texts": [
    {
      "id": "explicit error message",
      "content_snippet": "explicit error message",
      "date": "2016-01-01T00:00:00,000+0300"
    }, ...
  ],
  "count": 1,
  "quota_remainder": 1
}
Имя Обязательный Тип Описание
id Да string ID оригинального текста.
content_snippet Да string Отрывок оригинального текста.
date Нет yyyy-MM-ddTHH:mm:ss,sssZ Дата добавления оригинального текста.
count Да int32 Количество добавленных оригинальных текстов.
quota_remainder Да int32 Остаток суточной квоты на количество добавляемых текстов.

Ошибки

403 Forbidden

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

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
Параметр Описание
error_code Код ошибки.
available_user_id ID пользователя, от имени которого разрешен доступ.
error_message Сообщение об ошибке.

404 Not Found

Сайт отсутствует в списке сайтов пользователя или на него не подтверждены права.

{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
Параметр Описание
error_code Код ошибки.
host_id ID запрошенного сайта.
error_message Сообщение об ошибке.