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.

,

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

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