Groups: list

Gibt eine Liste von Gruppen zurück, die den API-Anfrageparametern entsprechen. Sie können beispielsweise alle Gruppen abrufen, deren Inhaber der authentifizierte Nutzer ist, oder eine oder mehrere Gruppen anhand ihrer eindeutigen IDs abrufen.

Anfragen

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).

Sucher
https://www.googleapis.com/auth/yt-analytics.readonly Sieh dir YouTube Analytics-Berichte für deine YouTube-Inhalte an. Dieser Bereich bietet Zugriff auf Messwerte zur Nutzeraktivität, wie Anzahl der Aufrufe und Anzahl der Bewertungen.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Sieh dir die YouTube Analytics-Finanzberichte für deine YouTube-Inhalte an. Dieser Bereich bietet Zugriff auf Messwerte zur Nutzeraktivität 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 Bereich YouTube-Gruppen und ‐Gruppen verwalten.
https://www.googleapis.com/auth/youtubepartner YouTube-Assets und zugehörige Inhalte auf YouTube ansehen und verwalten In der YouTube Analytics API können Rechteinhaber diesen Bereich verwenden, 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 die Eigenschaft 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, die dem authentifizierten Nutzer gehören.
Optionale Parameter
onBehalfOfContentOwner string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Hinweis: Dieser Parameter ist ausschließlich für Content-Partner von YouTube bestimmt, die viele verschiedene YouTube-Kanäle besitzen und verwalten.

Der Parameter onBehalfOfContentOwner gibt an, dass die Autorisierungsanmeldedaten einer Anfrage einen YouTube-Nutzer identifizieren, der im Namen des in dem Parameterwert angegebenen Rechteinhabers handelt. Rechteinhaber können sich einmalig authentifizieren und auf alle ihre Video- und Kanaldaten zugreifen, ohne für jeden einzelnen Kanal Anmeldedaten zur Authentifizierung angeben zu 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 Aufrufen 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 Attribute 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 der 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 im Ergebnissatz abzurufen.

Fehler

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

Testen!

Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.