Zasób playlistItem
określa inny zasób, np. film, który znajduje się na playliście. Dodatkowo zasób playlistItem
zawiera szczegółowe informacje o uwzględnionym zasobie, które odnoszą się konkretnie do sposobu jego wykorzystania na playliście.
YouTube wykorzystuje też playlistę do identyfikowania listy przesłanych filmów na kanał, gdzie każdy element playlistItem
z tej listy odpowiada 1 przesłanemu filmowi. Identyfikator playlisty dla tej listy możesz pobrać z channel resource
dla danego kanału. Do wyświetlania listy możesz użyć metody playlistItems.list
.
Metody
Interfejs API obsługuje te metody zasobów playlistItems
:
- list
- Zwraca kolekcję elementów playlisty, które pasują do parametrów żądania do interfejsu API. Możesz pobrać wszystkie elementy playlisty, które się na niej znajdują, albo jeden lub więcej elementów, podając ich unikalne identyfikatory. Wypróbuj teraz
- wstaw
- Dodaje zasób do playlisty. Wypróbuj teraz
- aktualizacja
- Modyfikuje element playlisty. Możesz na przykład zmienić pozycję elementu na playliście. Wypróbuj teraz
- usuń
- Usuwa element playlisty. Wypróbuj teraz
Reprezentacja zasobu
Poniższa struktura JSON pokazuje format zasobu playlistItems
:
{ "kind": "youtube#playlistItem", "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, "videoOwnerChannelTitle": string, "videoOwnerChannelId": string, "playlistId": string, "position": unsigned integer, "resourceId": { "kind": string, "videoId": string, } }, "contentDetails": { "videoId": string, "startAt": string, "endAt": string, "note": string, "videoPublishedAt": datetime }, "status": { "privacyStatus": string } }
Właściwości
Poniższa tabela przedstawia właściwości, które pojawiają się w tym zasobie:
Właściwości | |
---|---|
kind |
string Określa typ zasobu interfejsu API. Wartością będzie youtube#playlistItem . |
etag |
etag ETag tego zasobu. |
id |
string Identyfikator, którego YouTube używa do jednoznacznego zidentyfikowania elementu playlisty. |
snippet |
object Obiekt snippet zawiera podstawowe informacje o elemencie playlisty, takie jak tytuł i pozycja na playliście. |
snippet.publishedAt |
datetime Data i godzina dodania elementu do playlisty. Wartość należy podać w formacie ISO 8601. |
snippet.channelId |
string Identyfikator używany w YouTube do jednoznacznej identyfikacji użytkownika, który dodał element do playlisty. |
snippet.title |
string Tytuł elementu. |
snippet.description |
string Opis produktu. |
snippet.thumbnails |
object Mapa miniaturek powiązanych z elementem playlisty. W przypadku każdego obiektu na mapie kluczem jest nazwa obrazu miniatury, a wartością jest obiekt zawierający inne informacje na temat miniatury. |
snippet.thumbnails.(key) |
object Prawidłowe pary klucz-wartość 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 element playlisty. |
snippet.videoOwnerChannelTitle |
string Tytuł kanału, na którym przesłano ten film. |
snippet.videoOwnerChannelId |
string Identyfikator kanału, z którego przesłano ten film. |
snippet.playlistId |
string Identyfikator używany w YouTube do jednoznacznego identyfikowania playlisty, na której znajduje się dany element. |
snippet.position |
unsigned integer Kolejność, w jakiej element pojawia się na playliście. Wartości indeksu liczone są od zera, więc pierwszy element ma pozycję 0 , drugi element ma pozycję 1 itd. |
snippet.resourceId |
object Obiekt id zawiera informacje, które pozwalają jednoznacznie zidentyfikować zasób występujący na playliście jako element playlisty. |
snippet.resourceId.kind |
string Rodzaj lub typ polecanego zasobu. |
snippet.resourceId.videoId |
string Jeśli wartość właściwości snippet.resourceId.kind to youtube#video , ta właściwość będzie dostępna, a jej wartość będzie zawierać identyfikator używany przez YouTube do jednoznacznej identyfikacji filmu na playliście. |
contentDetails |
object Jeśli zawarty w nim element to film z YouTube, w zasobie jest zawarty obiekt contentDetails . Obiekt zawiera dodatkowe informacje o filmie. |
contentDetails.videoId |
string Identyfikator używany w YouTube do jednoznacznego identyfikowania filmu. Aby pobrać zasób video , ustaw parametr zapytania id na tę wartość w żądaniu do interfejsu API. |
contentDetails.startAt |
string Uwaga: ta właściwość została wycofana. Jeśli jest ustawiona, jej wartość jest ignorowana. Wyrażony w sekundach czas, w którym należy rozpocząć odtwarzanie filmu. (Właściciel playlisty może określić czas rozpoczęcia i zakończenia odtwarzania filmu zgodnie z kontekstem playlisty). Wartością domyślną jest 0 . |
contentDetails.endAt |
string Uwaga: ta właściwość została wycofana. Jeśli jest ustawiona, jej wartość jest ignorowana. Wyrażony w sekundach czas, w którym odtwarzanie filmu powinno zostać zatrzymane. (Właściciel playlisty może określić czas rozpoczęcia i zakończenia odtwarzania filmu zgodnie z kontekstem playlisty). Domyślnie załóżmy, że video.endTime to koniec filmu. |
contentDetails.note |
string Wygenerowana przez użytkownika notatka do tego elementu. Wartość właściwości może mieć maksymalnie 280 znaków. |
contentDetails.videoPublishedAt |
datetime Data i godzina publikacji filmu w YouTube. Wartość należy podać w formacie ISO 8601. |
status |
object Obiekt status zawiera informacje o stanie prywatności elementu playlisty. |
status.privacyStatus |
string Stan prywatności elementu playlisty. Kanał, który przesłał film, który reprezentuje element playlisty, może ustawić tę wartość za pomocą metody videos.insert lub videos.update . |