Playlists: list

Zwraca zbiór playlist zgodnych z parametrami żądania do interfejsu API. Możesz na przykład pobrać wszystkie playlisty, których właścicielem jest uwierzytelniony użytkownik, lub jedną bądź kilka playlist na podstawie ich unikalnych identyfikatorów.

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

Częste zastosowania

Żądanie

Żądanie HTTP

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

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 playlist, które mają być uwzględnione w odpowiedzi interfejsu API.

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

Poniżej znajdziesz listę nazw part, które możesz uwzględnić w wartości parametru:
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
Filtry (określ dokładnie 1 z tych parametrów)
channelId string
Ta wartość wskazuje, że interfejs API powinien zwracać tylko playlisty określonego kanału.
id string
Parametr id określa rozdzieloną 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żna używać tylko w prawidłowo autoryzowanym żądaniu. Ustaw wartość tego parametru na true, aby poinstruować interfejs API, aby zwracał tylko playlisty należące do uwierzytelnionego użytkownika.
Parametry opcjonalne
hl string
Parametr hl instruuje interfejs API, aby pobierał zlokalizowane metadane zasobów w określonym języku aplikacji obsługiwanym przez witrynę YouTube. Wartość parametru musi być kodem języka zawartym na liście zwracanej przez metodę i18nLanguages.list.

Jeśli zlokalizowane szczegóły zasobu są dostępne w danym języku, obiekt snippet.localized zasobu będzie zawierać zlokalizowane wartości. Jeśli jednak zlokalizowane szczegóły nie są dostępne, obiekt snippet.localized będzie zawierać szczegóły zasobu w języku domyślnym zasobu.
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które mają być zwracane w zbiorze wyników. Akceptowane wartości to od 0 do 50 włącznie. Wartością domyślną jest 5.
onBehalfOfContentOwner string
Ten parametr można używać tylko w prawidłowo autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów YouTube.

Parametr onBehalfOfContentOwner wskazuje, że dane uwierzytelniające autoryzację żądania identyfikują użytkownika systemu CMS YouTube, który działa w imieniu właściciela treści określonego w wartości parametru. Parametr `**onBehalfOfContentOwner**` wskazuje, że dane uwierzytelniające żądania identyfikują użytkownika systemu zarządzania treścią w YouTube, który działa w imieniu właściciela treści określonego w wartości parametru. Umożliwia to właścicielom treści jednokrotne uwierzytelnienie i uzyskanie dostępu do wszystkich danych dotyczących ich filmów i kanałów bez konieczności podawania danych uwierzytelniających dla każdego pojedynczego kanału. 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 prawidłowo autoryzowanym żądaniu. Uwaga: Ten parametr jest przeznaczony wyłącznie dla partnerów treści YouTube.

Parametr onBehalfOfContentOwnerChannel określa identyfikator kanału YouTube, do którego dodawany jest film. **Uwaga:** ten parametr jest przeznaczony wyłącznie dla partnerów YouTube.onBehalfOfContentOwner Dodatkowo żądanie musi być autoryzowane przy użyciu konta CMS połączonego z właścicielem treści, którego określa parametr onBehalfOfContentOwner. Na koniec kanał określony przez wartość parametru onBehalfOfContentOwnerChannel musi być połączony z właścicielem treści określonym przez parametr onBehalfOfContentOwner.

Ten parametr jest przeznaczony dla partnerów treści YouTube, którzy są właścicielami wielu różnych kanałów YouTube i zarządzają nimi. Umożliwia to właścicielom treści jednokrotne uwierzytelnienie 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ć.

`string` Parametr `**pageToken**` identyfikuje konkretną stronę w zbiorze wyników, która ma 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.

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

Odpowiedź

Jeśli operacja się uda, ta metoda zwróci treść odpowiedzi o tej strukturze:

Właściwości
kind string
Identyfikuje typ zasobu interfejsu API. Wartość będzie youtube#playlistListResponse.
etag etag
Określa typ zasobu interfejsu API.
nextPageToken string
Wartość to pageToken.
prevPageToken string
Token, który może być użyty jako wartość parametru pageToken do pobrania poprzedniej strony w zestawie wyników.
pageInfo object
Token, którego można użyć jako wartości parametru pageInfo, aby pobrać następną stronę w zbiorze wyników.
pageInfo.totalResults integer
Całkowita liczba wyników w zbiorze wyników.
pageInfo.resultsPerPage integer
Liczba wyników uwzględnionych w odpowiedzi interfejsu API.
items[] list
Lista playlist pasujących do kryteriów żądania.

`integer` Liczba wyników uwzględnionych w odpowiedzi interfejsu API.

Poniższa tabela zawiera komunikaty o błędach, które interfejs API może zwrócić w odpowiedzi na wywołanie tej metody. 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
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 Kanał określony w parametrze id został zamknięty.
notFound (404) channelNotFound Kanał określony w parametrze channelId został zawieszony.
notFound (404) playlistNotFound Playlista zidentyfikowana za pomocą parametru id żądania nie obsługuje żądania lub żądanie nie jest prawidłowo autoryzowane.
invalidValue (400) playlistOperationUnsupported Nie można znaleźć kanału określonego w parametrze `channelId`. Na przykład nie można wyświetlić playlisty Do obejrzenia.

Interfejs API nie obsługuje możliwości wyświetlania określonej playlisty.

Użyj APIs Explorer, aby wywołać to API i zobaczyć żądanie do interfejsu API i odpowiedź.