Zasób playlistItem
identyfikuje inny zasób, np. film, który jest zawarty na playliście. Ponadto zasób playlistItem
zawiera szczegółowe informacje o zawartym zasobie, które odnoszą się do sposobu jego wykorzystania na tej playliście.
YouTube używa też playlisty do identyfikowania listy przesłanych filmów na kanale, a każdy elementplaylistItem
na tej liście reprezentuje jeden przesłany film. Identyfikator playlisty możesz pobrać z zasobu channel
dla danego kanału. Następnie możesz użyć metody playlistItems.list
do listy.
Metody
Interfejs API obsługuje te metody dotyczące zasobów playlistItems
:
- list
- Zwraca kolekcję elementów playlisty, które pasują do parametrów żądania interfejsu API. Możesz pobrać wszystkie elementy playlisty na określonej playliście lub pobrać co najmniej jeden element playlisty według jego unikalnego identyfikatora. Wypróbuj teraz
- insert
- Dodaje zasób do playlisty. Wypróbuj teraz
- update
- Modyfikuje element playlisty. Możesz na przykład zaktualizować pozycję elementu na playliście. Wypróbuj teraz
- usuń
- Usuwanie elementu z playlisty. Wypróbuj teraz
Reprezentacja zasobu
Struktura JSON poniżej 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
Właściwości występujące w tym zasobie są opisane w tabeli poniżej:
Właściwości | |
---|---|
kind |
string Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#playlistItem . |
etag |
etag Etag tego zasobu. |
id |
string Identyfikator, którego YouTube używa do jednoznacznego identyfikowania elementu playlisty. |
snippet |
object Obiekt snippet zawiera podstawowe informacje o elemencie playlisty, takie jak tytuł i pozycja na liście. |
snippet.publishedAt |
datetime Data i godzina dodania elementu do playlisty. Wartość jest podawana w formacie ISO 8601. |
snippet.channelId |
string Identyfikator, którego YouTube używa do jednoznacznego zidentyfikowania użytkownika, który dodał element do playlisty. |
snippet.title |
string Tytuł produktu. |
snippet.description |
string Opis produktu. |
snippet.thumbnails |
object Mapa miniatur powiązanych z elementem playlisty. W przypadku każdego obiektu na mapie kluczem jest nazwa miniatury, a wartością obiekt, który zawiera inne informacje o miniaturze. |
snippet.thumbnails.(key) |
object Prawidłowe wartości klucza:
|
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 Nazwa kanału, który przesłał ten film. |
snippet.videoOwnerChannelId |
string Identyfikator kanału, który przesłał ten film. |
snippet.playlistId |
string Identyfikator, który YouTube używa do jednoznacznego identyfikowania playlisty, na której znajduje się element playlisty. |
snippet.position |
unsigned integer Kolejność, w jakiej element pojawia się na playliście. Wartość używa indeksu opartego na 0, więc pierwszy element ma pozycję 0 , drugi 1 itd. |
snippet.resourceId |
object Obiekt id zawiera informacje, które można wykorzystać do jednoznacznego zidentyfikowania zasobu zawartego na playliście jako elementu playlisty. |
snippet.resourceId.kind |
string Rodzaj lub typ zasobu, do którego się odwołuje. |
snippet.resourceId.videoId |
string Jeśli wartość właściwości snippet.resourceId.kind to youtube#video , ta właściwość będzie obecna, a jej wartość będzie zawierać identyfikator, którego YouTube używa do jednoznacznego zidentyfikowania filmu na playliście. |
contentDetails |
object Jeśli dołączony element to film w YouTube, obiekt contentDetails jest uwzględniany w zasobie. Obiekt zawiera dodatkowe informacje o filmie. |
contentDetails.videoId |
string Identyfikator, którego YouTube używa do jednoznacznej identyfikacji 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 i jej wartość jest ignorowana, jeśli zostanie ustawiona. Czas od rozpoczęcia filmu, mierzony w sekundach, w którym film powinien się zacząć odtwarzać. (właściciel playlisty może określić czas rozpoczęcia i zakończenia odtwarzania filmu w kontekście playlisty). Wartością domyślną jest 0 . |
contentDetails.endAt |
string Uwaga: ta właściwość została wycofana i jeśli zostanie ustawiona, jej wartość zostanie zignorowana. Czas mierzony w sekundach od początku filmu, w którym ma on przestać się odtwarzać. (właściciel playlisty może określić czas rozpoczęcia i zakończenia odtwarzania filmu w kontekście playlisty). Domyślnie załóż, że video.endTime to koniec filmu. |
contentDetails.note |
string Użytkownik dodał notatkę do tego elementu. Wartość właściwości może mieć maksymalnie 280 znaków. |
contentDetails.videoPublishedAt |
datetime Data i godzina opublikowania filmu w YouTube. Wartość jest podawana w formacie ISO 8601. |
status |
object Obiekt status zawiera informacje o stanie prywatności elementu listy odtwarzania. |
status.privacyStatus |
string Stan prywatności elementu playlisty. Kanał, który przesłał film reprezentowany przez element playlisty, może ustawić tę wartość za pomocą metody videos.insert lub videos.update . |