Playlists

Ресурс playlist представляет плейлист YouTube. Плейлист – это подборка видео, которые можно смотреть по порядку и которыми можно делиться с другими пользователями. По умолчанию плейлисты видны всем пользователям, но вы можете сделать их доступными только вам.

Плейлисты также используются для создания специальных подборок видео на канале, например:

  • загруженные видео
  • видео, которым вы поставили лайк;
Эти списки связаны с каналом, который представляет собой коллекцию видео, плейлистов и другой информации на YouTube, принадлежащей человеку, группе или компании. Идентификаторы этих плейлистов можно получить из ресурса channel resource для определенного канала.

Затем вы можете использовать метод playlistItems.list, чтобы получить любой из этих списков. Вы также можете добавлять и удалять элементы из этих списков, вызывая методы playlistItems.insert и playlistItems.delete.

Методы

API поддерживает следующие методы для ресурсов playlists:

list
Возвращает коллекцию плейлистов, соответствующих параметрам запроса к API. Например, вы можете получить все плейлисты, принадлежащие пользователю, прошедшему аутентификацию, или один или несколько плейлистов по их уникальным идентификаторам. Перейти
insert
Создает плейлист. Перейти
update
Изменяет плейлист. Например, вы можете изменить название, описание или настройки доступа. Перейти
delete
Удаляет плейлист. Перейти

Представление ресурса

Ниже приведена структура JSON для ресурса playlists:

{
  "kind": "youtube#playlist",
  "etag": etag,
  "id": string,
  "snippet": {
    "publishedAt": datetime,
    "channelId": string,
    "title": string,
    "description": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    },
    "channelTitle": string,
    "defaultLanguage": string,
    "localized": {
      "title": string,
      "description": string
    }
  },
  "status": {
    "privacyStatus": string,
    "podcastStatus": enum
  },
  "contentDetails": {
    "itemCount": unsigned integer
  },
  "player": {
    "embedHtml": string
  },
  "localizations": {
    (key): {
      "title": string,
      "description": string
    }
  }
}

Свойства

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

Свойства
kind string
Тип ресурса API. Значение будет youtube#playlist.
etag etag
Тег Etag этого ресурса.
id string
Идентификатор, который YouTube использует для уникальной идентификации плейлиста.
snippet object
Объект snippet содержит основную информацию о плейлисте, например его название и описание.
snippet.publishedAt datetime
Дата и время создания плейлиста. Значение указывается в формате ISO 8601.
snippet.channelId string
Идентификатор, который YouTube использует для уникальной идентификации канала, опубликовавшего плейлист.
snippet.title string
Название плейлиста.
snippet.description string
Описание плейлиста.
snippet.thumbnails object
Карта значков, связанных с плейлистом. Для каждого объекта на карте ключ – это название значка, а значение – это объект, который содержит другую информацию о значке.
snippet.thumbnails.(key) object
Допустимые значения ключей:
  • default – уменьшенное изображение по умолчанию. Значок по умолчанию для видео или ресурса, который ссылается на видео (например, для элемента плейлиста или результата поиска), имеет ширину 120 пикселей и высоту 90 пикселей. По умолчанию значок канала имеет размер 88 x 88 пикселей.
  • medium – версия значка с более высоким разрешением. Для видео (или ресурса, который ссылается на видео) это изображение имеет ширину 320 пикселей и высоту 180 пикселей. Для канала размер изображения составляет 240 x 240 пикселей.
  • high – версия значка в высоком разрешении. Для видео (или ресурса, который ссылается на видео) это изображение имеет ширину 480 пикселей и высоту 360 пикселей. Для канала размер изображения составляет 800 x 800 пикселей.
  • standard – значок с разрешением, которое выше, чем у значка high. Это изображение доступно для некоторых видео и других ресурсов, которые ссылаются на видео, например элементов плейлиста или результатов поиска. Ширина этого изображения – 640 пикселей, а высота – 480 пикселей.
  • maxres – версия значка в высоком разрешении. Этот размер доступен для некоторых видео и других ресурсов, связанных с видео, например элементов плейлиста или результатов поиска. Ширина этого изображения – 1280 пикселей, а высота – 720 пикселей.
  • fhd – значок в формате Full HD (1080p). Такой размер доступен для некоторых видео. Размер изображения – 1920 x 1080 пикселей.
  • qhd – версия значка в разрешении Quad HD (1440p / 2K). Такой размер доступен для некоторых видео. Размер этого изображения – 2560 x 1440 пикселей.
  • uhd – значок в сверхвысоком разрешении (4K). Этот размер доступен для некоторых видео. Ширина этого изображения – 3840 пикселей, а высота – 2160 пикселей.
snippet.thumbnails.(key).url string
URL изображения.
snippet.thumbnails.(key).width unsigned integer
Ширина изображения.
snippet.thumbnails.(key).height unsigned integer
Высота изображения.
snippet.channelTitle string
Название канала, на котором размещено видео.
snippet.tags[] list
Это свойство больше не поддерживается.

Теги, связанные с плейлистом.
snippet.defaultLanguage string
Язык текста в свойствах snippet.title и snippet.description ресурса playlist.
snippet.localized object
Объект snippet.localized содержит локализованное название и описание плейлиста или название на языке по умолчанию для метаданных плейлиста.
  • Локализованный текст возвращается в фрагменте ресурса, если в запросе playlists.list с помощью параметра hl был указан язык, для которого доступен локализованный текст.
  • Если значение параметра hl не указано или указано, но локализованные метаданные для выбранного языка недоступны, возвращаются метаданные на языке по умолчанию.
Свойство содержит значение, доступное только для чтения. Используйте объект localizations, чтобы добавлять, изменять или удалять локализованные названия.
snippet.localized.title string
Локализованное название плейлиста.
snippet.localized.description string
Локализованное описание плейлиста.
status object
Объект status содержит информацию о статусе плейлиста.
status.privacyStatus string
Статус конфиденциальности плейлиста.

Допустимые значения:
  • private
  • public
  • unlisted
status.podcastStatus string
Статус плейлиста как подкаста. Если указано значение enabled, плейлист отмечен как подкаст. Чтобы задать для плейлиста статус подкаста enabled, у плейлиста должно быть изображение.

Допустимые значения для этого свойства:
  • enabled
  • disabled
  • unspecified
contentDetails object
Объект contentDetails содержит информацию о контенте плейлиста, в том числе о количестве видео в нем.
contentDetails.itemCount unsigned integer
Количество видео в плейлисте.
player object
Объект player содержит информацию, которая используется для воспроизведения плейлиста во встроенном проигрывателе.
player.embedHtml string
Тег <iframe>, который встраивает проигрыватель для воспроизведения плейлиста.
localizations object
Объект localizations содержит переводы метаданных плейлиста.
localizations.(key) object
Язык локализованного текста, связанного с ключом-значением. Значение представляет собой строку, содержащую код языка BCP-47.
localizations.(key).title string
Локализованное название плейлиста.
localizations.(key).description string
Локализованное описание плейлиста.