PlaylistItems: update

Изменяет элемент списка воспроизведения. Например, вы можете обновить положение элемента в списке воспроизведения.

Влияние квоты. Стоимость вызова этого метода составляет 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 Creator Studio.

Тело запроса

Укажите ресурс 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 Ресурс элемента списка воспроизведения, указанный в запросе, должен использовать свойство id для идентификации обновляемого элемента списка воспроизведения.
invalidValue (400) playlistOperationUnsupported API не поддерживает возможность обновления видео в указанном плейлисте. Например, вы не можете обновить видео в плейлисте загруженных видео.

Попробуй это!

Используйте APIs Explorer для вызова этого API и просмотра запроса и ответа API.