PlaylistImages: list

Zwraca kolekcję obrazów z playlist, które pasują do parametrów żądania do interfejsu API. Możesz pobrać obraz playlisty określonej playlisty lub pobrać co najmniej 1 obraz playlisty na podstawie jej unikalnego identyfikatora.

Wpływ na limit: wywołanie tej metody wiąże się z kosztem limitu w wysokości 1 jednostki.

Żądanie

Żądanie HTTP

GET https://www.googleapis.com/youtube/v3/playlistImages

Autoryzacja

To żądanie wymaga autoryzacji z użyciem co najmniej jednego z tych zakresów (więcej informacji o uwierzytelnianiu i autoryzacji).

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 to parametry zapytania.

Parametry
Parametry wymagane
part string

Parametr part określa rozdzieloną przecinkami listę co najmniej 1 właściwości zasobu playlistImage, które będą uwzględnione w odpowiedzi interfejsu API.

Jeśli parametr identyfikuje właściwość zawierającą właściwości podrzędne, zostaną one uwzględnione w odpowiedzi.
Filtry(określ dokładnie jeden z tych parametrów)
id string
Parametr id określa listę rozdzieloną przecinkami zawierającą co najmniej 1 unikalny identyfikator obrazu z playlisty.
playlistId string
Parametr playlistId określa unikalny identyfikator playlisty, dla której chcesz pobrać obrazy. Pamiętaj, że chociaż jest to parametr opcjonalny, każde żądanie pobrania obrazów playlisty musi zawierać wartość parametru id lub playlistId.
Parametry opcjonalne
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę obrazów, które powinny zostać zwrócone w zestawie wyników. Akceptowane wartości to od 0 do 50 włącznie. Wartością domyślną jest 5.
onBehalfOfContentOwner string
Ten parametr może być używany tylko w odpowiednio autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów YouTube zajmujących się treściami.

Parametr onBehalfOfContentOwner oznacza, że dane logowania autoryzacji żądania identyfikują użytkownika systemu CMS YouTube, który działa w imieniu właściciela treści określonego w wartości parametru. Ten parametr jest przeznaczony dla partnerów YouTube, którzy są właścicielami wielu różnych kanałów YouTube i nimi zarządzają. Umożliwia właścicielom treści jednorazowe uwierzytelnianie i uzyskiwanie dostępu do wszystkich danych dotyczących filmów i kanałów bez konieczności podawania danych uwierzytelniających dla każdego kanału z osobna. Konto CMS, za pomocą którego użytkownik się uwierzytelnia, musi być połączone z określonym właścicielem treści w YouTube.
onBehalfOfContentOwnerChannel string
Ten parametr może być używany tylko w odpowiednio autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów YouTube.

Parametr onBehalfOfContentOwnerChannel określa identyfikator kanału w YouTube, do którego dodawany jest film. Ten parametr jest wymagany, gdy żądanie określa wartość parametru onBehalfOfContentOwner, i może być używany tylko w połączeniu z tym parametrem. Dodatkowo żądanie musi być autoryzowane za pomocą konta CMS połączonego z właścicielem treści, którego określa parametr onBehalfOfContentOwner. Na koniec kanał, który określa wartość parametru onBehalfOfContentOwnerChannel, musi być połączony z właścicielem treści, którego określa parametr onBehalfOfContentOwner.

Ten parametr jest przeznaczony dla partnerów YouTube, którzy są właścicielami wielu różnych kanałów w YouTube i nimi zarządzają. Umożliwia właścicielom treści jednokrotne uwierzytelnianie i wykonywanie działań w imieniu kanału określonego w wartości parametru bez konieczności podawania danych uwierzytelniających dla każdego oddzielnego kanału.
pageToken string
Parametr pageToken identyfikuje konkretną stronę w zestawie wyników, która powinna zostać zwrócona. W odpowiedzi interfejsu API właściwości nextPageToken i prevPageToken identyfikują inne strony, które można pobrać.

Treść żądania

Podczas wywoływania tej metody nie podawaj treści żądania.

Odpowiedź

Jeśli operacja się uda, metoda zwróci odpowiedź w poniższym formacie:

{
          "kind": "youtube#playlistImageListResponse",
          "nextPageToken": string,
          "prevPageToken": string,
          "pageInfo": {
            "totalResults": integer,
            "resultsPerPage": integer
          },
          "items": [
            playlistImages Resource
          ]
        }

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 string
Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#playlistImageListResponse.
nextPageToken string
Token, którego można użyć jako wartości parametru pageToken, aby pobrać następną stronę w zbiorze wyników.
prevPageToken string
Token, którego można użyć jako wartości parametru pageToken, aby pobrać poprzednią stronę w zbiorze wyników.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu zestawu wyników.
pageInfo.totalResults integer
Łączna liczba wyników w zbiorze wyników.
pageInfo.resultsPerPage integer
Liczba wyników uwzględnionych w odpowiedzi interfejsu API.
items[] list
Lista obrazów playlisty, które spełniają kryteria żądania.