Groups: list

Gibt eine Liste der Gruppen zurück, die den API-Anfrageparametern entsprechen. Sie können beispielsweise alle Gruppen abrufen, die dem authentifizierten Nutzer gehören, oder Sie können eine oder mehrere Gruppen anhand ihrer eindeutigen ID abrufen.

Anfrage

HTTP-Anfrage

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

Autorisierung

Diese Anfrage benötigt eine Autorisierung mit mindestens einem der folgenden Bereiche (weitere Informationen zu Authentifizierung und Autorisierung).

Ebenen
https://www.googleapis.com/auth/yt-analytics.readonly YouTube Analytics-Berichte für deine YouTube-Inhalte abrufen Dieser Bereich bietet Zugriff auf Messwerte zur Nutzeraktivität, z. B. die Anzahl der Aufrufe und Bewertungen.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly YouTube Analytics-Finanzberichte für deine YouTube-Inhalte abrufen Diese Zugriffsebene bietet Zugriff auf Messwerte zu Nutzeraktivitäten sowie auf geschätzte Umsatz- und Anzeigenleistungsmesswerte.
https://www.googleapis.com/auth/youtube YouTube-Konto verwalten In der YouTube Analytics API können Kanalinhaber mit diesem Umfang YouTube Analytics-Gruppen und -Gruppenelemente verwalten.
https://www.googleapis.com/auth/youtubepartner YouTube-Assets und zugehörige Inhalte auf YouTube abrufen und verwalten In der YouTube Analytics API verwenden Rechteinhaber diesen Umfang, um YouTube Analytics-Gruppen und -Gruppenelemente zu verwalten.

Parameter

In der folgenden Tabelle sind die Parameter aufgeführt, die von dieser Abfrage unterstützt werden. Alle aufgeführten Parameter sind Abfrageparameter.

Parameter
Filter (genau einen der folgenden Parameter angeben)
id string
Der Parameter id gibt eine durch Kommas getrennte Liste der YouTube-Gruppen-IDs für die abgerufenen Ressourcen an. Jede Gruppe muss dem authentifizierten Nutzer gehören. In einer group-Ressource gibt das Attribut id die YouTube-Gruppen-ID der Gruppe an.

Wenn du keinen Wert für den Parameter id angibst, musst du den Parameter mine auf true setzen.
mine boolean
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Legen Sie den Wert dieses Parameters auf true fest, um alle Gruppen abzurufen, deren Eigentümer der authentifizierte Nutzer ist.
Optionale Parameter
onBehalfOfContentOwner string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Hinweis:Dieser Parameter ist ausschließlich für YouTube-Inhaltspartner gedacht, die Inhaber und Administrator vieler verschiedener YouTube-Kanäle sind.

Der Parameter onBehalfOfContentOwner gibt an, dass die Autorisierungsdaten der Anfrage einen YouTube-Nutzer identifizieren, der im Namen des im Parameterwert angegebenen Rechteinhabers handelt. Rechteinhaber können sich nur einmal authentifizieren und erhalten Zugriff auf alle ihre Video- und Kanaldaten, ohne dass sie für jeden einzelnen Kanal Anmeldedaten zur Authentifizierung angeben müssen. Das Konto, mit dem sich der Nutzer authentifiziert, muss mit dem angegebenen YouTube-Rechteinhaber verknüpft sein.
pageToken string
Der Parameter pageToken gibt eine bestimmte Seite im Ergebnissatz an, die zurückgegeben werden soll. In einer API-Antwort gibt die Property nextPageToken die nächste Seite an, die abgerufen werden kann.

Anfragetext

Geben Sie beim Aufruf dieser Methode keinen Anfragetext an.

Antwort

Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:

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

Attribute

In der folgenden Tabelle werden die Eigenschaften definiert, die in dieser Ressource angezeigt werden:

Attribute
kind string
Identifiziert den Typ der API-Ressource. Der Wert ist youtube#groupListResponse.
etag etag
Das ETag dieser Ressource.
items[] list
Eine Liste von Gruppen, die den API-Anfrageparametern entsprechen. Jedes Element in der Liste stellt eine group-Ressource dar.
nextPageToken string
Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die nächste Seite in der Ergebnismenge abzurufen.

Fehler

Die API definiert keine Fehlermeldungen, die nur für diese API-Methode gelten. Mit dieser Methode können jedoch weiterhin allgemeine API-Fehler zurückgegeben werden, die in der Dokumentation der Fehlermeldung aufgeführt sind.

Testen!

Verwenden Sie die APIs Explorer, um diese API aufzurufen und die API-Anfrage und ‑Antwort zu sehen.