Zwraca kolekcję obrazów playlisty pasujących do parametrów żądania do interfejsu API. Możesz pobrać obraz określonej playlisty lub jedną lub więcej obrazów playlisty według ich unikalnych identyfikatorów.
Wpływ limitu: wywołanie tej metody ma limit równy 1 jednostce.
Żądanie
Żądanie HTTP
GET https://www.googleapis.com/youtube/v3/playlistImages
Autoryzacja
To żądanie wymaga autoryzacji z co najmniej jednym z tych zakresów (więcej informacji o uwierzytelnianiu i autoryzowaniu).
Zakres |
---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Parametry
W tabeli poniżej znajdziesz parametry obsługiwane przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.
Parametry | ||
---|---|---|
Parametry wymagane | ||
part |
string Parametr |
|
Filtry (określ dokładnie jeden z następujących parametrów) | ||
id |
string , Parametr id zawiera rozdzieloną przecinkami listę złożoną z co najmniej jednego unikalnego identyfikatora obrazu playlisty. |
|
playlistId |
string , Parametr playlistId określa unikalny identyfikator playlisty, dla której chcesz pobrać obrazy playlisty. Pamiętaj, że chociaż jest to parametr opcjonalny, w każdym żądaniu pobrania obrazów playlisty musi być określona wartość parametru id lub playlistId . |
|
Parametry opcjonalne | ||
maxResults |
unsigned integer , Parametr maxResults określa maksymalną liczbę obrazów, które powinny być zwracane w zbiorze wyników. Akceptowane wartości to od 0 do 50 włącznie. Wartością domyślną jest 5 . |
|
onBehalfOfContentOwner |
string , Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla dostawców treści w YouTube. Parametr onBehalfOfContentOwner wskazuje, że dane uwierzytelniające żądania identyfikują użytkownika systemu zarządzania treścią YouTube, który działa w imieniu właściciela treści określonego w wartości parametru. Ten parametr jest przeznaczony dla dostawców treści w YouTube, którzy są właścicielami wielu różnych kanałów YouTube i nimi zarządzają. Dzięki niej właściciele treści mogą dokonać uwierzytelnienia raz i uzyskać dostęp do wszystkich danych dotyczących filmów i kanału bez konieczności podawania danych uwierzytelniających dla każdego kanału. Konto CMS, za pomocą którego użytkownik się uwierzytelnia, musi być połączone z określonym właścicielem treści YouTube. |
|
onBehalfOfContentOwnerChannel |
string , Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla dostawców treści w YouTube. onBehalfOfContentOwnerChannel parametr
określa identyfikator kanału YouTube, na którym jest umieszczony film
– dodano. Ten parametr jest wymagany, gdy żądanie określa wartość dla
onBehalfOfContentOwner i można go używać tylko w
w połączeniu z tym parametrem. Ponadto żądanie musi być
autoryzowane za pomocą konta CMS połączonego z właścicielem treści,
Parametr onBehalfOfContentOwner określa wartość. Pamiętaj też, że
kanał, w którym wartość parametru onBehalfOfContentOwnerChannel
określa, że musi być powiązany z właścicielem treści,
Parametr onBehalfOfContentOwner określa wartość.To jest przeznaczony dla partnerów dostarczających treści YouTube, którzy są właścicielami wielu na różnych kanałach YouTube. Umożliwia właścicielom treści jednorazowe uwierzytelnianie i wykonywać działania w imieniu kanału określonego w parametrze bez konieczności podawania danych uwierzytelniających przy każdym oddzielnym kanale. |
|
pageToken |
string , Parametr pageToken określa w zestawie wyników konkretną stronę, która powinna zostać zwrócona. W odpowiedzi interfejsu API właściwości nextPageToken i prevPageToken wskazują inne strony, które można pobrać. |
Treść żądania
Nie podawaj treści żądania przy wywoływaniu tej metody.
Odpowiedź
Jeśli operacja się uda, metoda zwróci odpowiedź o następującej strukturze:
{ "kind": "youtube#playlistImageListResponse", "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ playlistImages Resource ] }
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#playlistImageListResponse . |
nextPageToken |
string , Token, którego można użyć jako wartość parametru pageToken do pobrania następnej strony w zestawie wyników. |
prevPageToken |
string , Token, którego można używać jako wartość parametru pageToken do pobierania poprzedniej strony zbioru wyników. |
pageInfo |
object , Obiekt pageInfo zawiera informacje o stronicowaniu dla zbioru wyników. |
pageInfo.totalResults |
integer , Łączna liczba wyników w zestawie wyników. |
pageInfo.resultsPerPage |
integer , Liczba wyników zawartych w odpowiedzi interfejsu API. |
items[] |
list , Lista obrazów playlisty, które pasują do kryteriów żądania. |