Playlists: list

Zwraca kolekcję playlist pasujących do parametrów żądania do interfejsu API. Możesz na przykład pobrać wszystkie playlisty, których właścicielem jest uwierzytelniony użytkownik, albo pobrać jedną lub więcej playlist według ich unikalnych identyfikatorów.

Wpływ limitu: wywołanie tej metody ma limit limitu wynoszący 1 jednostkę.

Typowe przypadki użycia

Żądanie

Żądanie HTTP

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

Parametry

W poniższej tabeli podano parametry obsługiwane przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.

Parametry
Parametry wymagane
part string
Parametr part określa rozdzieloną przecinkami listę co najmniej jednej właściwości zasobu playlist, która ma być uwzględniona w odpowiedzi interfejsu API.

Jeśli parametr wskazuje właściwość zawierającą właściwości podrzędne, zostaną one uwzględnione w odpowiedzi. Na przykład w zasobie playlist właściwość snippet zawiera usługi takie jak author, title, description i timeCreated. Jeśli ustawisz part=snippet, odpowiedź interfejsu API będzie zawierać wszystkie te właściwości.

Ta lista zawiera nazwy part, które możesz uwzględnić w wartości parametru:
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
Filtry (podaj jeden z tych parametrów)
channelId string
Ta wartość oznacza, że interfejs API powinien zwracać tylko playlisty z danego kanału.
id string
Parametr id określa oddzieloną przecinkami listę identyfikatorów playlist w YouTube dla pobieranych zasobów. W zasobie playlist właściwość id określa identyfikator playlisty w YouTube.
mine boolean
Ten parametr może być używany tylko w poprawnie autoryzowanym żądaniu. Ustaw wartość tego parametru na true, by interfejs API zwracał tylko playlisty należące do uwierzytelnionego użytkownika.
Parametry opcjonalne
hl string
Parametr hl nakazuje interfejsowi API pobrać zlokalizowane metadane zasobów dla konkretnego języka aplikacji obsługiwanego przez stronę YouTube. Wartość parametru musi być kodem języka znajdującym się na liście zwróconej metodą i18nLanguages.list.

Jeśli szczegółowe informacje o zasobach są dostępne w tym języku, obiekt snippet.localized zasobu będzie zawierać zlokalizowane wartości. Jeśli jednak szczegóły dotyczące lokalizacji nie będą dostępne, obiekt snippet.localized będzie zawierał szczegóły zasobów w języku domyślnym zasobu.
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które powinny zostać zwrócone w zestawie wyników. Akceptowane wartości to 0–50 (włącznie). Wartością domyślną jest 5.
onBehalfOfContentOwner string
Ten parametr może być używany tylko w poprawnie autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów w sieci reklamowej YouTube.

Parametr onBehalfOfContentOwner wskazuje, że dane logowania żądania autoryzacji to użytkownik 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 w sieci reklamowej YouTube, którzy mają wiele kanałów YouTube i zarządzają nimi. Umożliwia właścicielom treści uwierzytelnianie tylko raz oraz dostęp do wszystkich 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ę uwierzytelni, 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 poprawnie autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony tylko dla dostawców treści w YouTube.

Parametr onBehalfOfContentOwnerChannel określa identyfikator kanału YouTube, do którego jest dodawany film. Ten parametr jest wymagany, gdy żądanie określa wartość parametru onBehalfOfContentOwner i można go używać 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óre jest określone w parametrze onBehalfOfContentOwner. Na koniec kanał, który określa parametr onBehalfOfContentOwnerChannel, musi być powiązany z właścicielem treści, który jest określony przez parametr onBehalfOfContentOwner.

Ten parametr jest przeznaczony dla partnerów w sieci reklamowej YouTube, którzy mają wiele kanałów YouTube i zarządzają nimi. Umożliwia właścicielom treści uwierzytelnianie raz i wykonywanie działań w imieniu kanału określonego w wartości parametru, bez konieczności podawania danych uwierzytelniających dla każdego kanału z osobna.
pageToken string
Parametr pageToken wskazuje konkretną stronę w zestawie wyników, 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

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

Odpowiedź

Jeśli operacja się uda, metoda zwróci odpowiedź w następującym formacie:

{
  "kind": "youtube#playlistListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    playlist Resource
  ]
}

Usługi

Poniższa tabela określa właściwości, które pojawiają się w tym zasobie:

Usługi
kind string
Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#playlistListResponse.
etag etag
Otagowanie tego zasobu.
nextPageToken string
Token, który może zostać użyty jako wartość parametru pageToken, by pobrać następną stronę z zestawu wyników.
prevPageToken string
Token, którego można użyć jako wartości parametru pageToken w celu pobrania poprzedniej strony z zestawu wyników.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu dla zestawu 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 playlist, która spełnia kryteria żądania.

Błędy

W tabeli poniżej znajdziesz komunikaty o błędach, które interfejs API może zwrócić w odpowiedzi na wywołanie tej metody. Więcej informacji znajdziesz w dokumentacji komunikatów o błędach.

Typ błędu Szczegóły błędu Opis
forbidden (403) channelClosed Kanał określony w parametrze channelId został zamknięty.
forbidden (403) channelSuspended Kanał określony w parametrze channelId został zawieszony.
forbidden (403) playlistForbidden Playlista z parametrem id żądania nie obsługuje żądania lub żądanie nie jest prawidłowo autoryzowane.
notFound (404) channelNotFound Nie można znaleźć kanału określonego w parametrze channelId.
notFound (404) playlistNotFound Nie można znaleźć playlisty zidentyfikowanej za pomocą parametru id żądania.
invalidValue (400) playlistOperationUnsupported Interfejs API nie obsługuje możliwości wyświetlania określonej playlisty. Nie możesz na przykład dodać playlisty do obejrzenia później.

Wypróbuj

Użyj APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.