Zasób playlistItem identyfikuje inny zasób, np. film, który jest uwzględniony na playliście. Dodatkowo zasób playlistItem zawiera szczegóły dotyczące dołączonego zasobu, które odnoszą się konkretnie do sposobu wykorzystania tego zasobu na danej liście odtwarzania.
YouTube używa też playlisty do identyfikowania listy przesłanych filmów na kanale. Każdy playlistItem 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, aby dodać adres do listy.
Metody
Interfejs API obsługuje te metody w przypadku zasobów playlistItems:
- list
- Zwraca kolekcję elementów playlisty, które pasują do parametrów żądania interfejsu API. Możesz pobrać wszystkie elementy playlisty z określonej playlisty lub pobrać co najmniej 1 element playlisty według jego unikalnego identyfikatora. Wypróbuj teraz
- wstaw
- Dodaje zasób do playlisty. Wypróbuj teraz
- aktualizować
- Modyfikuje element playlisty. Możesz na przykład zaktualizować pozycję elementu na playliście. Wypróbuj teraz
- usuń
- Usuwa element z playlisty. Wypróbuj teraz
Prezentacja zasobów
Poniższa struktura JSON przedstawia 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 zawiera definicje właściwości, które pojawiają się w tym zasobie:
| Właściwości | |
|---|---|
kind |
stringOkreśla typ zasobu interfejsu API. Wartość będzie wynosić youtube#playlistItem. |
etag |
etagTag ETag tego zasobu. |
id |
stringIdentyfikator, którego YouTube używa do jednoznacznego identyfikowania elementu playlisty. |
snippet |
objectObiekt snippet zawiera podstawowe informacje o elemencie playlisty, takie jak tytuł i pozycja na playliście. |
snippet.publishedAt |
datetimeData i godzina dodania elementu do playlisty. Wartość jest podana w formacie ISO 8601. |
snippet.channelId |
stringIdentyfikator, którego YouTube używa do jednoznacznego identyfikowania użytkownika, który dodał element do playlisty. |
snippet.title |
stringNazwa produktu. |
snippet.description |
stringOpis produktu. |
snippet.thumbnails |
objectMapa miniatur powiązanych z elementem playlisty. W przypadku każdego obiektu na mapie kluczem jest nazwa miniatury, a wartością jest obiekt zawierający inne informacje o miniaturze. |
snippet.thumbnails.(key) |
objectPrawidłowe wartości klucza to:
|
snippet.thumbnails.(key).url |
stringAdres URL obrazu. |
snippet.thumbnails.(key).width |
unsigned integerSzerokość obrazu. |
snippet.thumbnails.(key).height |
unsigned integerWysokość obrazu. |
snippet.channelTitle |
stringTytuł kanału, do którego należy element playlisty. |
snippet.videoOwnerChannelTitle |
stringTytuł kanału, na który przesłano ten film. |
snippet.videoOwnerChannelId |
stringIdentyfikator kanału, na który przesłano ten film. |
snippet.playlistId |
stringIdentyfikator, którego YouTube używa do jednoznacznego określenia playlisty, na której znajduje się element. |
snippet.position |
unsigned integerKolejność, w jakiej element pojawia się na playliście. Wartość używa indeksu opartego na zerze, więc pierwszy element ma pozycję 0, drugi – 1 itd. |
snippet.resourceId |
objectObiekt id zawiera informacje, które można wykorzystać do jednoznacznego zidentyfikowania zasobu uwzględnionego na playliście jako elementu playlisty. |
snippet.resourceId.kind |
stringRodzaj lub typ zasobu, do którego odnosi się link. |
snippet.resourceId.videoId |
stringJeś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 identyfikowania filmu na playliście. |
contentDetails |
objectObiekt contentDetails jest uwzględniany w zasobie, jeśli dołączony element to film w YouTube. Obiekt zawiera dodatkowe informacje o filmie. |
contentDetails.videoId |
stringIdentyfikator, którego YouTube używa do jednoznacznej identyfikacji filmu. Aby pobrać zasób video, w żądaniu do interfejsu API ustaw parametr zapytania id na tę wartość. |
contentDetails.startAt |
stringUwaga: ta właściwość została wycofana i jeśli jest ustawiona, jej wartość jest ignorowana. Czas w sekundach od początku filmu, w którym ma się rozpocząć odtwarzanie. (Właściciel playlisty może określić, kiedy film ma się rozpocząć i zakończyć, gdy jest odtwarzany w kontekście playlisty). Wartością domyślną jest 0. |
contentDetails.endAt |
stringUwaga: ta właściwość została wycofana i jeśli jest ustawiona, jej wartość jest ignorowana. Czas w sekundach od początku filmu, w którym odtwarzanie powinno się zatrzymać. (Właściciel playlisty może określić, kiedy film ma się rozpocząć i zakończyć, gdy jest odtwarzany w kontekście playlisty). Domyślnie przyjmujemy, że video.endTime to koniec filmu. |
contentDetails.note |
stringNotatka wygenerowana przez użytkownika dotycząca tego produktu. Wartość właściwości może mieć maksymalnie 280 znaków. |
contentDetails.videoPublishedAt |
datetimeData i godzina opublikowania filmu w YouTube. Wartość jest podana w formacie ISO 8601. |
status |
objectObiekt status zawiera informacje o stanie prywatności elementu na liście odtwarzania. |
status.privacyStatus |
stringStan 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. |