Playlists: update

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

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

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

Запрос

HTTP-запрос

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

Авторизация

Для этого запроса требуется авторизация по крайней мере с одной из следующих областей действия. Подробнее об аутентификации и авторизации читайте в статье Реализация авторизации OAuth 2.0.

Область действия
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, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для партнеров YouTube, которым принадлежит множество каналов. Владельцы контента могут пройти аутентификацию один раз и получить доступ к данным всех своих видео и каналов. Аккаунт CMS, с помощью которого пользователь проходит аутентификацию, должен быть связан с указанным владельцем контента YouTube.

Тело запроса

Укажите ресурс playlist в теле запроса.

Для этого ресурса:

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

    • id
    • snippet.title

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

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

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

Ответ

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

Ошибки

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

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

Попробовать

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