Добавление оригинального текста

Описание

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

Ограничение.

Разрешается добавлять не более 100 текстов в сутки, при этом размер текста должен быть в пределах от 500 до 32000 символов.

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

Отправьте POST-запрос на адрес операции original-texts ресурса сайта пользователя, в теле запроса передайте оригинальный текст, а также укажите требуемый тип данных в заголовке Content-type (application/json или application/xml):

POST https://api.webmaster.yandex.net/v3/user/{user-id}/hosts/{host-id}/original-texts/
Content-type: application/xml

Path-параметры

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

Пример

{
  "content": "some text"
}
Параметр Описание
content Оригинальный текст.

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

В случае успешного добавления сайта сервер возвращает 201 Created.

Пример

{
  "text_id": "some text",
  "quota_remainder": 1
}
Имя Обязательный Тип Описание
text_id Да string Идентификатор добавленного оригинального текста.
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 Сообщение об ошибке.

409 Conflict

Переданный текст уже был добавлен ранее.

{
  "error_code": "TEXT_ALREADY_ADDED",
  "error_message": "explicit error message"
}
Параметр Описание
error_code Код ошибки.
error_message Сообщение об ошибке.

422 Unprocessable Entity

Переданный текст слишком короткий или длинный.

{
  "error_code": "TEXT_LENGTH_CONSTRAINTS_VIOLATION",
  "max_length": 1,
  "min_length": 1,
  "actual_length": 1,
  "error_message": "explicit error message"
}
Параметр Описание
error_code Код ошибки.
max_length Код ошибки.
min_length Код ошибки.
error_message Сообщение об ошибке.

429 Too Many Requests

Превышена квота добавления оригинальных текстов.

{
  "error_code": "QUOTA_EXCEEDED",
  "error_message": "explicit error message"
}
Параметр Описание
error_code Код ошибки.
error_message Сообщение об ошибке.