Zasób playlist reprezentuje playlistę YouTube. Playlista to zbiór filmów, które można oglądać w określonej kolejności i udostępniać innym użytkownikom. Domyślnie playlisty są widoczne publicznie dla innych użytkowników, ale playlisty mogą być publiczne lub prywatne.
YouTube wykorzystuje również playlisty do tworzenia specjalnych kolekcji filmów dla danego kanału, takich jak:
- przesłane filmy
- filmy pozytywnie ocenione (lubiane)
channel resource każdego kanału.Następnie możesz użyć metody
playlistItems.list, aby pobrać dowolną z tych list. Możesz też dodawać elementy do tych list i je z nich usuwać, wywołując metody playlistItems.insert i playlistItems.delete.
Metody
Interfejs API obsługuje następujące metody w przypadku zasobów playlists:
- list
- Zwraca zbiór playlist, które pasują do parametrów żądania do interfejsu API. Możesz na przykład pobrać wszystkie playlisty, które należą do uwierzytelnionego użytkownika, albo pobrać jedną lub więcej playlist, korzystając z ich unikalnych identyfikatorów. Wypróbuj teraz
- wstaw
- Tworzy playlistę. Wypróbuj teraz
- zaktualizuj
- Modyfikuje playlistę. Możesz na przykład zmienić tytuł, opis lub stan prywatności playlisty. Wypróbuj teraz
- usuń
- Usuwa playlistę. Wypróbuj teraz
Reprezentowanie zasobu
Poniższa struktura JSON przedstawia format zasobu 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
}
}
}
Właściwości
Tabela poniżej zawiera właściwości widoczne w tym zasobie:
| Właściwości | |
|---|---|
kind |
string, Określa typ zasobu interfejsu API. Wartość wyniesie youtube#playlist. |
etag |
etag, Etag tego zasobu. |
id |
string, Identyfikator używany przez YouTube do jednoznacznego identyfikowania playlisty. |
snippet |
object, Obiekt snippet zawiera podstawowe informacje o playliście, takie jak jej tytuł i opis. |
snippet.publishedAt |
datetime, Data i godzina utworzenia playlisty. Wartość jest podana w formacie ISO 8601. |
snippet.channelId |
string, Identyfikator, za pomocą którego YouTube jednoznacznie identyfikuje kanał, na którym opublikowano playlistę. |
snippet.title |
string, Tytuł playlisty. |
snippet.description |
string, Opis playlisty. |
snippet.thumbnails |
object, Mapa miniatur obrazów powiązanych z playlistą. Kluczem dla każdego obiektu na mapie jest nazwa miniatury obrazu, a wartością jest obiekt zawierający inne informacje o miniaturze. |
snippet.thumbnails.(key) |
object, Prawidłowe wartości klucza to:
|
snippet.thumbnails.(key).url |
string, Adres URL obrazu. |
snippet.thumbnails.(key).width |
unsigned integer, Szerokość obrazu. |
snippet.thumbnails.(key).height |
unsigned integer, Wysokość obrazu. |
snippet.channelTitle |
string, Tytuł kanału, do którego należy film. |
snippet.tags[] |
list, Ta usługa została wycofana. Tagi słów kluczowych powiązane z playlistą. |
snippet.defaultLanguage |
string, Język tekstu we właściwościach snippet.title i snippet.description zasobu playlist. |
snippet.localized |
object, Obiekt snippet.localized zawiera zlokalizowany tytuł i opis playlisty albo tytuł w języku domyślnym metadanych playlisty.
localizations. |
snippet.localized.title |
string, Tytuł zlokalizowanej playlisty. |
snippet.localized.description |
string, Zlokalizowany opis playlisty. |
status |
object, Obiekt status zawiera informacje o stanie playlisty. |
status.privacyStatus |
string, Stan prywatności playlisty. Prawidłowe wartości tej właściwości to:
|
status.podcastStatus |
string, Stan podcastu na playliście. Jeśli wartość to enabled, playlista jest oznaczona jako podcast. Aby można było ustawić stan podcastu na enabled, playlista musi zawierać obraz playlisty.Prawidłowe wartości tej właściwości to:
|
contentDetails |
object, Obiekt contentDetails zawiera informacje o zawartości playlisty, w tym liczbę znajdujących się na niej filmów. |
contentDetails.itemCount |
unsigned integer, Liczba filmów na playliście. |
player |
object, Obiekt player zawiera informacje potrzebne do odtworzenia playlisty w odtwarzaczu umieszczonym na stronie. |
player.embedHtml |
string, tag <iframe> zawierający odtwarzacz, który będzie odtwarzać playlistę. |
localizations |
object, Obiekt localizations zawiera tłumaczenia metadanych playlisty. |
localizations.(key) |
object, Język zlokalizowanego tekstu powiązanego z wartością kluczową. Wartość jest ciągiem znaków zawierającym kod języka BCP-47. |
localizations.(key).title |
string, Tytuł zlokalizowanej playlisty. |
localizations.(key).description |
string, Zlokalizowany opis playlisty. |