Groups: list

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

Żądanie

Żądanie HTTP

GET https://youtubeanalytics.googleapis.com/v2/groups

Upoważnienie

To żądanie wymaga autoryzacji z co najmniej jednym z poniższych zakresów (więcej informacji o uwierzytelnianiu i autoryzacji).

Zakresy
https://www.googleapis.com/auth/yt-analytics.readonly	Wyświetlaj raporty Statystyk YouTube dotyczące treści w YouTube. Zakres ten zapewnia dostęp do danych o aktywności użytkowników, takich jak liczba wyświetleń i oceny.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly	Wyświetlanie raportów finansowych Statystyk YouTube dotyczących treści w YouTube Zakres ten umożliwia dostęp do danych o aktywności użytkowników oraz szacunkowych danych o przychodach i skuteczności reklam.
https://www.googleapis.com/auth/youtube	Zarządzaj swoim kontem YouTube. W interfejsie YouTube Analytics API właściciele kanałów używają tego zakresu do zarządzania grupami i elementami grup w YouTube Analytics.
https://www.googleapis.com/auth/youtubepartner	Wyświetlanie zasobów YouTube i powiązanych treści w YouTube oraz zarządzanie nimi. W interfejsie YouTube Analytics API właściciele treści używają tego zakresu do zarządzania grupami i elementami grup w YouTube Analytics.

Parametry

Tabela poniżej zawiera listę parametrów obsługiwanych przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.

Parametry
Filtry (podaj jeden z tych parametrów)
id	string Parametr id określa oddzieloną przecinkami listę identyfikatorów grup YouTube dla pobieranych zasobów. Każda grupa musi należeć do uwierzytelnionego użytkownika. W zasobie group właściwość id określa identyfikator grupy YouTube grupy. Jeśli nie określisz wartości parametru id, musisz ustawić wartość mine na true.
mine	boolean Ten parametr może być używany tylko w poprawnie autoryzowanym żądaniu. Ustaw wartość tego parametru na true, aby pobierać wszystkie grupy należące do uwierzytelnionego użytkownika.
Parametry opcjonalne
onBehalfOfContentOwner	string Ten parametr może być używany tylko w poprawnie autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów dostarczających treści do YouTube, którzy mają wiele kanałów YouTube i zarządzają nimi. Parametr onBehalfOfContentOwner żądania autoryzacji wskazuje użytkownika YouTube, który działa w imieniu właściciela treści określonego w wartości parametru. 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, z którego użytkownik się uwierzytelnia, 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ść nextPageToken wskazuje następną stronę, którą 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#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

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#groupListResponse.
etag	etag Otagowanie tego zasobu.
items[]	list Lista grup pasujących do parametrów żądań do interfejsu API. Każda pozycja na liście reprezentuje zasób group.
nextPageToken	string Token, który może zostać użyty jako wartość parametru pageToken, by pobrać następną stronę z zestawu wyników.

Błędy

Interfejs API nie definiuje żadnych komunikatów o błędach, które są unikalne dla tej metody. Może jednak zwrócić ogólne błędy interfejsu API wymienione w dokumentacji komunikatu o błędzie.

Wypróbuj

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