Groups: list

Zwraca listę grup, które pasują do parametrów żądania interfejsu API. Możesz na przykład pobrać wszystkie grupy należące do uwierzytelnionego użytkownika lub pobrać co najmniej 1 grupę według jej unikalnego identyfikatora.

Żądanie

Żądanie HTTP

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

Autoryzacja

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

Zakresy
https://www.googleapis.com/auth/yt-analytics.readonly	Wyświetlanie raportów Statystyk YouTube dotyczących treści w YouTube. Ten zakres uprawnień zapewnia dostęp do danych o aktywności użytkowników, takich jak liczba wyświetleń i liczba ocen.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly	Wyświetlanie raportów finansowych Statystyk YouTube dotyczących treści w YouTube Ten zakres uprawnień zapewnia dostęp do danych o aktywności użytkowników oraz szacowanych przychodów i danych o skuteczności reklam.
https://www.googleapis.com/auth/youtube	Zarządzanie kontem YouTube. W interfejsie API Statystyk YouTube właściciele kanałów używają tego zakresu do zarządzania grupami i elementami grup w Statystykach YouTube.
https://www.googleapis.com/auth/youtubepartner	Wyświetlanie zasobów YouTube i powiązanych z nimi 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 Statystykach YouTube.

Parametry

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

Parametry
Filtry (wybierz dokładnie 1 z tych parametrów)
id	string Parametry id określają listę oddzielonych przecinkami identyfikatorów grup YouTube, do których należą pobierane zasoby. Każda grupa musi należeć do uwierzytelnionego użytkownika. W zasobach group właściwość id określa identyfikator grupy YouTube. Pamiętaj, że jeśli nie określisz wartości parametru id, musisz ustawić parametr mine na true.
mine	boolean Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu. Aby pobrać wszystkie grupy należące do uwierzytelnionego użytkownika, ustaw wartość tego parametru na true.
Parametry opcjonalne
onBehalfOfContentOwner	string Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów treści w YouTube, którzy są właścicielami wielu kanałów w YouTube i nimi zarządzają. Parametr onBehalfOfContentOwner wskazuje, że dane uwierzytelniające autoryzacji prośby identyfikują użytkownika YouTube, który działa w imieniu właściciela treści określonego w wartości parametru. Umożliwia ona właścicielom treści jednorazową weryfikację i uzyskanie dostępu do wszystkich danych o filmach i kanałach bez konieczności podawania danych uwierzytelniających dla każdego kanału. Konto, na którym użytkownik się uwierzytelnia, musi być powiązane z określonym właścicielem treści w YouTube.
pageToken	string Parametr pageToken określa w zestawie wyników konkretną stronę, 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ę powiedzie, metoda zwróci odpowiedź o tej strukturze:

{
  "kind": "youtube#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

Właściwości

Właściwości występujące w tym zasobie są opisane w tabeli poniżej:

Właściwości
kind	string Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#groupListResponse.
etag	etag Etag tego zasobu.
items[]	list Lista grup pasujących do parametrów żądania interfejsu API. Każdy element na liście reprezentuje zasób group.
nextPageToken	string Token, którego można użyć jako wartości parametru pageToken do pobrania następnej strony w zestawie wyników.

Błędy

Interfejs API nie definiuje żadnych komunikatów o błędach, które są unikalne dla tej metody. Ta metoda może jednak zwracać ogólne błędy interfejsu API wymienione w dokumentacji komunikatów o błędach.

Wypróbuj

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