PlaylistItems: update

Изменить объект playlistItem. Например, вы можете изменить позицию элемента в плейлисте.

Влияние на квоту. Вызов этого метода стоит 50 единиц квоты.

Примеры использования

Запрос

HTTP-запрос

PUT https://www.googleapis.com/youtube/v3/playlistItems

Авторизация

Для выполнения этого запроса требуется авторизация как минимум в одной из следующих областей доступа. Подробнее…

Область действия
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Параметры

В таблице ниже перечислены параметры, которые поддерживает этот запрос. Все перечисленные параметры являются параметрами запроса.

Параметры
Обязательные параметры
part string
Параметр part используется в этой операции в двух целях. Он определяет свойства, которые будут заданы операцией записи, а также свойства, которые будут включены в ответ API.

Обратите внимание, что этот метод переопределит существующие значения для всех изменяемых свойств, содержащихся в любых частях, указанных значением параметра. Например, для элемента плейлиста можно указать время начала и окончания, чтобы определить, какая часть видео должна воспроизводиться, когда пользователи смотрят видео в плейлисте. Если ваш запрос обновляет элемент плейлиста, в котором заданы эти значения, и значение параметра part запроса включает часть contentDetails, время начала и окончания элемента плейлиста будет обновлено в соответствии со значением, указанным в теле запроса. Если в теле запроса не указаны значения, существующие время начала и окончания будут удалены и заменены настройками по умолчанию.

В следующем списке приведены названия part, которые можно включить в значение параметра:
  • contentDetails
  • id
  • snippet
  • status
Необязательные параметры
onBehalfOfContentOwner string
Примечание. Параметр onBehalfOfContentOwner предназначен исключительно для партнеров YouTube по контенту и может использоваться только в авторизованном запросе.

Этот параметр предназначен для партнеров YouTube по контенту, которые владеют множеством каналов YouTube и управляют ими. Она позволяет пользователям, связанным с правообладателем, пройти аутентификацию один раз, а затем получать доступ ко всем видео и данным каналов правообладателя и управлять ими, не предоставляя учетные данные для каждого канала.

Если параметр присутствует, его значение идентифицирует правообладателя, а учетные данные авторизации запроса идентифицируют пользователя YouTube, уполномоченного действовать от имени этого правообладателя. Аккаунт, с помощью которого пользователь проходит аутентификацию, должен быть связан с указанным владельцем контента в настройках Творческой студии YouTube.

Тело запроса

В теле запроса укажите ресурс playlistItem. Для этого ресурса:

  • Необходимо указать значение для следующих свойств:

    • id
    • snippet.playlistId
    • snippet.resourceId

  • Вы можете задать значения для следующих свойств:

    • snippet.position
    • contentDetails.note
    • contentDetails.startAt
    • contentDetails.endAt

    Если вы отправляете запрос на обновление и в нем не указано значение для свойства, у которого оно уже есть, существующее значение будет удалено.

Ответ

В случае успеха этот метод возвращает в теле ответа ресурс playlistItem.

Ошибки

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

Тип ошибки Сведения об ошибке Описание
forbidden (403) playlistItemsNotAccessible Запрос на обновление указанного объекта плейлиста не авторизован должным образом.
invalidValue (400) invalidPlaylistItemPosition В запросе указана недопустимая или неподдерживаемая позиция видео в плейлисте. Проверьте значение свойства position в snippet ресурса.
invalidValue (400) invalidResourceType Значение type, указанное для идентификатора ресурса, не поддерживается для этой операции. Идентификатор ресурса определяет объект, добавляемый в плейлист, например youtube#video.
invalidValue (400) invalidSnippet В запросе не указано действительное свойство snippet.
invalidValue (400) manualSortRequired В запросе указана позиция видео в плейлисте, но для плейлиста не задана сортировка вручную. Например, видео в плейлисте могут быть отсортированы по дате или популярности. Чтобы устранить ошибку, удалите элемент snippet.position из ресурса, который вставляется запросом. Если вы хотите, чтобы видео занимало определенную позицию в плейлисте, сначала нужно изменить настройку Порядок на Вручную в настройках плейлиста. Изменить эти настройки можно в Менеджере видео YouTube.
notFound (404) playlistItemNotFound Не удалось найти элемент плейлиста, указанный в свойстве id запроса.
notFound (404) playlistNotFound Плейлист, указанный в параметре playlistId, не найден.
required (400) channelIdRequired В запросе не указано значение для обязательного свойства channelId.
required (400) playlistIdRequired В запросе не указано значение обязательного свойства playlistId.
required (400) playlistItemIdRequired В ресурсе playlistItem, указанном в запросе, должно быть свойство id, которое идентифицирует обновляемый объект.
invalidValue (400) playlistOperationUnsupported API не поддерживает обновление видео в указанном плейлисте. Например, вы не можете изменить видео в плейлисте загруженных видео.

Попробовать

Используйте APIs Explorer, чтобы вызвать этот API и посмотреть запрос к API и ответ.