Videos: list

Zwraca listę filmów, które pasują do parametrów żądania do interfejsu API.

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/videos

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 video, 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 video właściwość snippet zawiera właściwości channelId, title, description, tags i categoryId. 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
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
Filtry (podaj jeden z tych parametrów)
chart string
Parametr chart wskazuje wykres, który chcesz pobrać.

Akceptowane wartości to:
id string
Parametr id określa oddzieloną przecinkami listę identyfikatorów filmów w YouTube dla pobieranych zasobów. W zasobie video właściwość id określa identyfikator filmu.
myRating string
Ten parametr może być używany tylko w poprawnie autoryzowanym żądaniu. Ustaw wartość tego parametru na like lub dislike, by interfejs API zwracał tylko te filmy, które zostały polubione lub nielubiane przez uwierzytelnionego użytkownika.

Akceptowane wartości to:
  • dislike – zwraca tylko filmy, które nie podobają się użytkownikowi.
  • like – zwraca tylko te filmy, które podobają się uwierzytelnionemu użytkownikowi.
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.
maxHeight unsigned integer
Parametr maxHeight określa maksymalną wysokość umieszczonego odtwarzacza zwróconego we właściwości player.embedHtml. Możesz użyć tego parametru, aby określić, że zamiast domyślnych wymiarów kod osadzania powinien używać wysokości dostosowanej do układu aplikacji. Jeśli podasz także parametr maxWidth, odtwarzacz może być krótszy niż maxHeight, aby nie naruszać maksymalnej szerokości. Akceptowane wartości to 728192 (włącznie).
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które należy zwrócić w zestawie wyników.

Uwaga: ten parametr można stosować w połączeniu z parametrem myRating, ale nie jest obsługiwany w połączeniu z parametrem id. Akceptowane wartości to 150 (włącznie). Wartością domyślną jest 5.
maxWidth unsigned integer
Parametr maxWidth określa maksymalną szerokość umieszczonego odtwarzacza zwróconego we właściwości player.embedHtml. Za pomocą tego parametru możesz określić, że zamiast wymiarów domyślnych kod powinien zawierać szerokość odpowiednią do układu aplikacji.

Jeśli podasz także parametr maxHeight, odtwarzacz może być węższy niż maxWidth, aby nie naruszać maksymalnej wysokości. Akceptowane wartości to 728192 (włącznie).
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.
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ć.

Uwaga: ten parametr można stosować w połączeniu z parametrem myRating, ale nie jest obsługiwany w połączeniu z parametrem id.
regionCode string
Parametr regionCode instruuje interfejs API, aby wybrał wykres wideo dostępny w danym regionie. Tego parametru można używać tylko w połączeniu z parametrem chart. Wartością tego parametru jest kod kraju w formacie ISO 3166-1 alfa-2.
videoCategoryId string
Parametr videoCategoryId wskazuje kategorię wideo, dla której chcesz pobrać wykres. Tego parametru można używać tylko w połączeniu z parametrem chart. Domyślnie wykresy nie są ograniczone do określonej kategorii. Wartością domyślną jest 0.

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#videoListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    video 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#videoListResponse.
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 filmów, które spełniają 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
badRequest (400) videoChartNotFound Żądany wykres wideo nie jest obsługiwany lub jest niedostępny.
forbidden (403) forbidden Żądanie nie ma uprawnień dostępu do pliku wideo lub informacji o przetwarzaniu. Pamiętaj, że fragmenty fileDetails, processingDetails i suggestions są dostępne tylko dla właściciela filmu.
forbidden (403) forbidden Prośba nie ma dostępu do informacji o ocenach użytkowników. Ten błąd może wystąpić, ponieważ żądanie nie jest poprawnie autoryzowane do używania parametru myRating.
notFound (404) videoNotFound Nie można znaleźć filmu, który próbujesz pobrać. Sprawdź, czy wartość parametru id żądania jest prawidłowa.

Wypróbuj

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