Playlists: update

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

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

Распространенные случаи использования

Запрос

HTTP-запрос 

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

Авторизация

Этот запрос требует авторизации хотя бы с одной из следующих областей ( подробнее об аутентификации и авторизации читайте здесь ).

Объем
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Параметры

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

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

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

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

Параметр onBehalfOfContentOwner указывает, что учетные данные авторизации запроса идентифицируют пользователя YouTube CMS, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для контент-партнеров YouTube, которые владеют и управляют множеством различных каналов YouTube. Это позволяет владельцам контента один раз пройти аутентификацию и получить доступ ко всем своим видео и данным каналов без необходимости предоставлять учетные данные аутентификации для каждого отдельного канала. Учетная запись CMS, с помощью которой пользователь проходит аутентификацию, должна быть связана с указанным владельцем контента YouTube.

Тело запроса

Укажите ресурс списка воспроизведения в теле запроса. Для этого ресурса:

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

    • id
    • snippet.title

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

    • snippet.title
    • snippet.description
    • status.privacyStatus
    • status.podcastStatus
    • snippet.defaultLanguage
    • localizations.(key)
    • localizations.(key).title
    • localizations.(key).description

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

Ответ

В случае успеха этот метод возвращает ресурс списка воспроизведения в теле ответа.

Ошибки

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

Тип ошибки Детализация ошибки Описание
badRequest (400) defaultLanguageNotSetError Для обновления localizations необходимо установить defaultLanguage .
badRequest (400) localizationValidationError Одно из значений объекта локализации не прошло проверку. Используйте метод playlists.list для получения допустимых значений и обязательно обновите их, следуя рекомендациям в документации по ресурсам списков воспроизведения.
forbidden (403) playlistForbidden Эта операция запрещена или запрос не авторизован должным образом.
invalidValue (400) invalidPlaylistSnippet Запрос предоставляет недопустимый фрагмент плейлиста.
notFound (404) playlistNotFound Невозможно найти список воспроизведения, указанный в параметре id запроса.
required (400) playlistTitleRequired В запросе должно быть указано название плейлиста.
invalidValue (400) playlistOperationUnsupported API не поддерживает возможность обновления указанного плейлиста. Например, вы не можете обновить свойства плейлиста загруженных вами видео.

Попробуйте!

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

,

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

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

Распространенные случаи использования

Запрос

HTTP-запрос 

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

Авторизация

Этот запрос требует авторизации хотя бы с одной из следующих областей ( подробнее об аутентификации и авторизации читайте здесь ).

Объем
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Параметры

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

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

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

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

Параметр onBehalfOfContentOwner указывает, что учетные данные авторизации запроса идентифицируют пользователя YouTube CMS, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для контент-партнеров YouTube, которые владеют и управляют множеством различных каналов YouTube. Это позволяет владельцам контента один раз пройти аутентификацию и получить доступ ко всем своим видео и данным каналов без необходимости предоставлять учетные данные аутентификации для каждого отдельного канала. Учетная запись CMS, с помощью которой пользователь проходит аутентификацию, должна быть связана с указанным владельцем контента YouTube.

Тело запроса

Укажите ресурс списка воспроизведения в теле запроса. Для этого ресурса:

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

    • id
    • snippet.title

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

    • snippet.title
    • snippet.description
    • status.privacyStatus
    • status.podcastStatus
    • snippet.defaultLanguage
    • localizations.(key)
    • localizations.(key).title
    • localizations.(key).description

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

Ответ

В случае успеха этот метод возвращает ресурс списка воспроизведения в теле ответа.

Ошибки

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

Тип ошибки Детализация ошибки Описание
badRequest (400) defaultLanguageNotSetError Для обновления localizations необходимо установить defaultLanguage .
badRequest (400) localizationValidationError Одно из значений объекта локализации не прошло проверку. Используйте метод playlists.list для получения допустимых значений и обязательно обновите их, следуя рекомендациям в документации по ресурсам списков воспроизведения.
forbidden (403) playlistForbidden Эта операция запрещена или запрос не авторизован должным образом.
invalidValue (400) invalidPlaylistSnippet Запрос предоставляет недопустимый фрагмент плейлиста.
notFound (404) playlistNotFound Невозможно найти список воспроизведения, указанный в параметре id запроса.
required (400) playlistTitleRequired В запросе должно быть указано название плейлиста.
invalidValue (400) playlistOperationUnsupported API не поддерживает возможность обновления указанного плейлиста. Например, вы не можете обновить свойства плейлиста загруженных вами видео.

Попробуйте!

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