API Reference

Mit der YouTube Analytics API kannst du YouTube Analytics-Daten für einen YouTube-Kanal oder Rechteinhaber abrufen. Die API unterstützt Echtzeitabfragen und generiert einen Bericht basierend auf den API-Anfrageparametern.

Die API unterstützt zwei Arten von Funktionen:

  • Berichtabruf: Mit der reports.query-Methode der API kannst du YouTube Analytics-Berichte abrufen.

  • YouTube Analytics-Gruppenverwaltung: Eine YouTube Analytics-Gruppe ist eine benutzerdefinierte Sammlung von bis zu 500 Kanälen, Videos, Playlists oder Assets. Die API unterstützt mehrere Methoden zum Erstellen, Abrufen und Aktualisieren von YouTube Analytics-Gruppen. Kanal- und Rechteinhaber können dann mit der Methode reports.query zusammengefasste Daten für alle Elemente in einer Gruppe abrufen, was die Leistungsanalyse erleichtern kann.

Auf dieser Seite erhalten Sie einen kurzen Überblick über die API-Ressourcen und ‑Methoden, die diese Funktionen ermöglichen.

Autorisierung

Alle YouTube Analytics API-Anfragen müssen autorisiert sein. Im Autorisierungsleitfaden wird erläutert, wie Sie mit dem OAuth 2.0-Protokoll Autorisierungstokens abrufen.

Für YouTube Analytics API-Anfragen werden die folgenden Autorisierungsbereiche verwendet:

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.

Abrufen von Berichten

Mit der reports.query-Methode der API kannst du viele verschiedene YouTube Analytics-Berichte abrufen. Bei jeder Anfrage werden Abfrageparameter verwendet, um eine Kanal-ID oder einen Rechteinhaber, ein Start- und ein Enddatum sowie mindestens einen Messwert anzugeben. Sie können auch zusätzliche Abfrageparameter wie Dimensionen, Filter und Sortiervorgaben angeben.

Methode HTTP-Anfrage Beschreibung
URIs relativ zu https://youtubeanalytics.googleapis.com/v2
query GET /reports Ruft einen YouTube Analytics-Bericht ab. Bei jeder API-Anfrage werden Abfrageparameter verwendet, um eine Kanal-ID oder einen Rechteinhaber, ein Start- und ein Enddatum sowie mindestens einen Messwert anzugeben. Sie können auch zusätzliche Abfrageparameter wie Dimensionen, Filter oder Sortieranweisungen angeben.
  • Messwerte sind einzelne Messungen der Nutzeraktivität, z. B. Videoaufrufe oder Bewertungen („Mag ich“- bzw. „Mag ich nicht“-Bewertungen).
  • Dimensionen sind gängige Kriterien, mit denen Daten zusammengefasst werden, z. B. das Datum der Nutzeraktivität oder das Land, in dem sich die Nutzer befanden. In einem Bericht enthält jede Datenzeile eine eindeutige Kombination von Dimensionswerten.
  • Filter sind Dimensionswerte, die angeben, welche Daten abgerufen werden sollen. Du kannst beispielsweise Daten für ein bestimmtes Land, ein bestimmtes Video oder eine Gruppe von Videos abrufen.
In den Listen der unterstützten Channelberichte und Berichte für Rechteinhaber sind die zulässigen Kombinationen von Messwerten, Dimensionen und Filtern definiert.

Gruppen verwalten

Die API bietet zwei Ressourcen zum Erstellen und Verwalten von YouTube Analytics-Gruppen:

Gruppen

Eine group-Ressource stellt eine YouTube Analytics-Gruppe dar, eine benutzerdefinierte Sammlung von bis zu 500 Kanälen, Videos, Playlists oder Assets.

Alle Elemente in einer Gruppe müssen denselben Ressourcentyp haben. Sie können beispielsweise keine Gruppe mit 100 Videos und 100 Playlists erstellen.

Eine Analytics-Gruppe kann nur Ressourcen enthalten, die du hochgeladen oder auf die du Anspruch erhoben hast oder die mit einem von dir verwalteten Kanal verknüpft sind. Kanalinhaber können also Videos und Playlists in Gruppen zusammenfassen. Rechteinhaber können Gruppen von Videos, Playlists, Kanälen oder Assets erstellen.

Weitere Informationen zu dieser Ressource finden Sie in der Ressourcendarstellung und in der Liste der Properties.

Methode HTTP-Anfrage Beschreibung
URIs relativ zu https://youtubeanalytics.googleapis.com/v2
list GET /groups Gibt eine Liste der Gruppen zurück, die den API-Anfrageparametern entsprechen. Sie können beispielsweise alle Gruppen abrufen, deren Eigentümer der authentifizierte Nutzer ist, oder eine oder mehrere Gruppen anhand ihrer eindeutigen IDs.
insert POST /groups Erstellt eine YouTube Analytics-Gruppe. Verwenden Sie nach dem Erstellen einer Gruppe die Methode groupItems.insert, um der Gruppe Elemente hinzuzufügen.
update PUT /groups Ändert die Metadaten für eine Gruppe. Derzeit kann nur der Titel der Gruppe aktualisiert werden. Mit groupItems.insert und groupItems.delete können Sie Gruppenelemente hinzufügen und entfernen.
delete DELETE /groups Löscht eine Gruppe.

GroupItems

Eine groupItem-Ressource steht für ein Element in einer YouTube Analytics-Gruppe.

Weitere Informationen zu dieser Ressource finden Sie in der Ressourcendarstellung und in der Liste der Properties.

Methode HTTP-Anfrage Beschreibung
URIs relativ zu https://youtubeanalytics.googleapis.com/v2
list GET /groupItems Gibt eine Sammlung von Gruppenelementen zurück, die mit den Parametern der API-Anfrage übereinstimmen.
insert POST /groupItems Erstellt ein Gruppenelement.
delete DELETE /groupItems Entfernt ein Element aus einer Gruppe.