Реализация: плейлисты,реализация: плейлисты

В следующих примерах показано, как использовать API данных YouTube (v3) для выполнения функций, связанных со списками воспроизведения и элементами списков воспроизведения.

Получить плейлисты текущего пользователя

Вызовите метод playlists.list , чтобы получить плейлисты текущего аутентифицированного пользователя. В своем запросе установите для параметра mine значение true . Обратите внимание, что запрос, использующий параметр mine , должен быть авторизован с использованием OAuth 2.0.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=snippet,contentDetails
        &mine=true

Получить плейлисты пользователя

В этом примере извлекаются плейлисты, созданные определенным каналом. Пример состоит из двух шагов:

• Шаг 1. Получение идентификатора канала

  Вызовите channels.list , чтобы получить идентификатор канала, связанный с определенным именем пользователя YouTube. (В этом примере имя пользователя — GoogleDevelopers .) В ответе API свойство id идентифицирует идентификатор канала.

  https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.channels.list?
          part=id
          &forUsername=GoogleDevelopers

• Шаг 2. Получение плейлистов канала

  Вызовите метод playlists.list чтобы получить плейлисты канала. Установите для параметра channelId значение, полученное на шаге 1.

  https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
          part=snippet,contentDetails
          &channelId=UC_x5XG1OV2P6uZZ5FSM9Ttw

Получить информацию о конкретном плейлисте

Чтобы получить информацию об одном или нескольких конкретных списках воспроизведения, вызовите метод playlists.list и задайте для параметра id список идентификаторов списков воспроизведения YouTube, разделенных запятыми, которые идентифицируют нужные ресурсы. Распространенным вариантом использования этой функции является запрос на получение дополнительной информации о группе списков воспроизведения, возвращаемой в наборе результатов поиска. Например, вам может потребоваться получить количество элементов в каждом списке воспроизведения.

Приведенный ниже запрос вызывает метод playlists.list для получения количества элементов в двух плейлистах, соответствующих запросу «GoogleDevelopers». Эта информация находится в свойстве contentDetails.itemCount ресурса playlist , поэтому запрос устанавливает значение параметра part в contentDetails .

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=contentDetails
        &id=PLOU2XLYxmsIIM9h1Ybw2DuRw6o2fkNMeR,PLyYlLs02rgBYRWBzYpoHz7m2SE8mEZ68w

Добавить плейлист

В этом примере вызывается метод playlists.insert для создания частного списка воспроизведения на канале проверенного пользователя. Любой запрос API к этому методу должен быть авторизован с использованием OAuth 2.0.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.insert?
        part=snippet,status

Ссылка на проводник API также устанавливает параметр, определяющий текст запроса API. Тело запроса содержит ресурс playlist , который определяет такую ​​информацию, как название списка воспроизведения, описание и статус конфиденциальности. В этом примере тело запроса:

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "private"
  }
}

В следующем примере новый список воспроизведения помечается как подкаст:

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}

Связанные примеры кода: Java , JavaScript , .NET , PHP , Python.

Обновить плейлист

В этом примере статус конфиденциальности плейлиста обновляется с private на public . Пример состоит из двух шагов:

• Шаг 1. Получите идентификатор плейлиста.

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

• Шаг 2. Обновление плейлиста

  Вызовите метод playlists.update , чтобы изменить определенный список воспроизведения. Для этого метода требуется действительный токен авторизации OAuth 2.0.

  Тело запроса должно включать фрагмент snippet ресурса playlist , поскольку при вызове этого метода требуется свойство snippet.title . Кроме того, если обновляемый ресурс списка воспроизведения указывает значения свойств snippet.description или snippet.tags , эти значения необходимо повторно указать в запросе на обновление, иначе они будут удалены.

  https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.update?
          part=snippet,status

  Как и в приведенном выше примере добавления списка воспроизведения, ссылка на API Explorer устанавливает параметр, который определяет тело запроса API. Тело запроса содержит ресурс playlist , который определяет такую ​​информацию, как название списка воспроизведения, описание и статус конфиденциальности. В этом примере используется следующее тело запроса:

  {
    "id": "PLAYLIST_ID",
    "snippet": {
      "title": "New playlist",
      "description": "New playlist description"
    },
    "status": {
      "privacyStatus": "public"
    }
  }

  В следующем примере плейлист помечается как подкаст:

  {
    "id": "PLAYLIST_ID",
    "snippet": {
      "title": "New playlist",
      "description": "New playlist description"
    },
    "status": {
      "podcastStatus": "enabled"
    }
  }

  Примечание. Если вы тестируете этот запрос в API Explorer, вам необходимо будет подставить действительный идентификатор списка воспроизведения в тело ресурса. Чтобы получить идентификатор плейлиста, мы рекомендуем сначала выполнить показанный выше запрос на добавление плейлиста . Извлеките идентификатор плейлиста из ответа API и используйте это значение для плейлиста, который вы хотите обновить. Название и описание списка воспроизведения, используемые в этом примере, такие же, как и в этом примере.

Добавить элемент плейлиста

В этом примере элемент добавляется в список воспроизведения. Этот запрос должен быть авторизован с использованием OAuth 2.0. Этот пример состоит из двух шагов:

• Шаг 1. Получите соответствующий идентификатор плейлиста.

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

• Шаг 2. Добавьте видео в плейлист.

  Вызовите метод playlistItems.insert , чтобы добавить видео в список воспроизведения. Этот запрос должен быть авторизован с использованием OAuth 2.0. Тело запроса представляет собой ресурс playlistItem , который указывает как минимум следующие значения:

  • snippet.playlistId идентифицирует список воспроизведения, в который вы добавляете видео. Это идентификатор плейлиста, который вы получили на шаге 1.
  • snippet.resourceId.kind содержит значение youtube#video .
  • snippet.resourceId.videoId идентифицирует видео, которое вы добавляете в список воспроизведения. Значением свойства является уникальный идентификатор видео YouTube.

  Приведенный ниже запрос API добавляет видео в список воспроизведения. Тело запроса:

  {
    "snippet": {
      "playlistId": "PLAYLIST_ID",
      "resourceId": {
        "kind": "youtube#video",
        "videoId": "VIDEO_ID"
      }
    }
  }

  Чтобы выполнить запрос в API Explorer, вам необходимо установить значения для свойств snippet.playlistId и snippet.resourceId.videoId .

  https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.insert?
          part=snippet

  Примечание. В документации к методу playlistItems.insert указаны другие значения свойств, которые вы можете установить при добавлении элемента списка воспроизведения.

Добавить изображение плейлиста

Вы можете использовать метод playlistImages.insert API версии 3, чтобы загрузить собственное миниатюрное изображение и установить его для списка воспроизведения. В вашем запросе значение параметра playlistId определяет список воспроизведения, для которого будет использоваться миниатюра.

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

Обновить элемент плейлиста

В этом примере элемент списка воспроизведения обновляется так, что он становится первым элементом в списке воспроизведения. Этот запрос должен быть авторизован с использованием OAuth 2.0. Этот пример состоит из трех шагов:

• Шаг 1. Получите соответствующий идентификатор плейлиста.

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

• Шаг 2. Получите элементы из выбранного плейлиста.

  Вызовите метод playlistItems.list , чтобы получить список видео в выбранном списке воспроизведения. Задайте для параметра playlistId значение идентификатора списка воспроизведения, полученного на шаге 1.

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

• Шаг 3. Обновите выбранный элемент плейлиста.

  Вызовите метод playlistItems.update , чтобы изменить положение видео в списке воспроизведения. Установите значение параметра part snippet . Тело запроса должно быть ресурсом playlistItem , который устанавливает как минимум следующие значения:

  • Установите для свойства id идентификатор элемента списка воспроизведения, полученный на шаге 2.
  • Задайте для свойства snippet.playlistId идентификатор списка воспроизведения, полученный на шаге 1.
  • Задайте для свойства snippet.resourceId.kind значение youtube#video .
  • Задайте для свойства snippet.resourceId.videoId идентификатор видео, который уникально идентифицирует видео, включенное в список воспроизведения.
  • Установите для свойства snippet.position значение 0 или любую позицию, в которой вы хотите, чтобы элемент отображался (с использованием индекса, начинающегося с 0).

  Приведенный ниже запрос API обновляет элемент списка воспроизведения, чтобы он стал первым элементом в списке воспроизведения. Тело запроса:

  {
    "id": "PLAYLIST_ITEM_ID",
    "snippet": {
      "playlistId": "PLAYLIST_ID",
      "resourceId": {
        "kind": "youtube#video",
        "videoId": "VIDEO_ID"
      },
      "position": 0
    }
  }

  Чтобы выполнить запрос в API Explorer, вам необходимо установить значения для свойств id , snippet.playlistId и snippet.resourceId.videoId .

  https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.update?
          part=snippet

Обновить изображение плейлиста

Вы можете использовать метод playlistImages.update API версии 3 для обновления миниатюрного изображения списка воспроизведения. В вашем запросе значение параметра playlistId определяет список воспроизведения, для которого будет использоваться миниатюра.

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

Удаление элемента плейлиста

В этом примере удаляется видео из списка воспроизведения. Этот запрос должен быть авторизован с использованием OAuth 2.0. Этот пример состоит из трех шагов. Первые два шага такие же, как в приведенном выше примере обновления элемента списка воспроизведения .

После выполнения этих шагов вызовите метод playlistItems.delete , чтобы удалить видео из списка воспроизведения. Установите в качестве параметра id запроса идентификатор элемента списка воспроизведения для элемента, который вы хотите удалить. Этот запрос должен быть авторизован с использованием OAuth 2.0.

Обратите внимание, что идентификатор элемента списка воспроизведения, используемый для идентификации видео в списке воспроизведения, отличается от идентификатора видео YouTube, который однозначно идентифицирует видео. Идентификатор элемента списка воспроизведения идентифицирует видео как элемент в конкретном списке воспроизведения.

Чтобы выполнить запрос в API Explorer, вам необходимо установить значение свойства id .

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.delete?
        id=PLAYLIST_ITEM_ID

Удаление изображения плейлиста

В этом примере удаляется изображение списка воспроизведения. Пример состоит из двух шагов:

• Шаг 1. Получите список воспроизведения

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

• Шаг 2. Получите идентификатор изображения плейлиста.

  Вызовите метод playlistImages.list , чтобы получить миниатюру изображения списка воспроизведения. Используйте идентификатор плейлиста, который вы хотите изменить.

• Шаг 3. Удаление изображения плейлиста

  Вызовите метод playlistImages.delete , чтобы удалить определенное изображение списка воспроизведения. В запросе параметр id указывает идентификатор удаляемого изображения плейлиста. Для этого метода требуется действительный токен авторизации OAuth 2.0. Если вы тестируете этот запрос в API Explorer, вам нужно будет заменить значение параметра id действительным идентификатором списка воспроизведения.

  https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistImages.delete?
          id=ID

  Примечание. Если вы тестируете этот запрос в API Explorer, вам необходимо заменить значение параметра id действительным идентификатором изображения списка воспроизведения.

Удалить плейлист

В этом примере удаляется список воспроизведения. Пример состоит из двух шагов:

• Шаг 1. Получите идентификатор плейлиста.

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

• Шаг 2. Удаление плейлиста

  Вызовите метод playlists.delete , чтобы удалить определенный список воспроизведения. В запросе параметр id указывает идентификатор удаляемого плейлиста. Для этого метода требуется действительный токен авторизации OAuth 2.0. Если вы тестируете этот запрос в API Explorer, вам нужно будет заменить значение параметра id действительным идентификатором списка воспроизведения.

  https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.delete?
          id=PLAYLIST_ID

  Примечание. Если вы тестируете этот запрос в API Explorer, вам необходимо заменить значение параметра id действительным идентификатором списка воспроизведения. Чтобы получить идентификатор плейлиста, мы рекомендуем сначала выполнить показанный выше запрос на добавление плейлиста . Извлеките идентификатор списка воспроизведения из ответа API и используйте это значение для списка воспроизведения, который вы хотите удалить.