API Reference

Mit der YouTube Analytics API kannst du YouTube Analytics-Daten für einen YouTube-Kanal oder einen 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: Die reports.query-Methode der API ruft YouTube Analytics-Berichte ab.

  • Gruppenverwaltung in YouTube Analytics: Eine Gruppe in YouTube Analytics 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. Dies kann für die Leistungsanalyse hilfreich sein.

Diese Seite bietet einen kurzen Überblick über die API-Ressourcen und -Methoden, die diese Funktionen ermöglichen.

Autorisierung

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

YouTube Analytics API-Anfragen verwenden die folgenden Autorisierungsbereiche:

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.

Abruf melden

Mit der API-Methode reports.query kannst du viele verschiedene YouTube Analytics-Berichte abrufen. Bei jeder Anfrage werden Suchparameter verwendet, um eine Kanal-ID oder einen Rechteinhaber, ein Startdatum, ein Enddatum und mindestens einen Messwert anzugeben. Sie können auch zusätzliche Suchparameter wie Dimensionen, Filter und Sortierungsanweisungen 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 Suchparameter verwendet, um eine Kanal-ID oder einen Rechteinhaber, ein Startdatum, ein Enddatum und mindestens einen Messwert anzugeben. Sie können auch zusätzliche Suchparameter wie Dimensionen, Filter oder Sortierungsanweisungen angeben.
  • Messwerte sind individuelle Messungen der Nutzeraktivität, beispielsweise Videoaufrufe oder Bewertungen (positive und negative Bewertungen).
  • Dimensionen sind gängige Kriterien, die zum Aggregieren von Daten verwendet werden, z. B. das Datum, an dem die Nutzeraktivität stattgefunden hat, oder das Land, in dem die Nutzer ansässig waren. In einem Bericht hat jede Datenzeile eine eindeutige Kombination aus Dimensionswerten.
  • Filter sind Dimensionswerte, die angeben, welche Daten abgerufen werden. Sie können beispielsweise Daten für ein bestimmtes Land, ein bestimmtes Video oder eine Gruppe von Videos abrufen.
In den Listen der unterstützten Kanalberichte und Rechteinhaberberichte sind die gültigen Kombinationen von Messwerten, Dimensionen und Filtern definiert.

Gruppen verwalten

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

Gruppen

Eine Ressource vom Typ group steht für eine YouTube Analytics-Gruppe. Sie ist eine benutzerdefinierte Sammlung von bis zu 500 Kanälen, Videos, Playlists oder Assets.

Alle Elemente in einer Gruppe müssen denselben Ressourcentyp repräsentieren. Du kannst beispielsweise keine Gruppe erstellen, die 100 Videos und 100 Playlists enthält.

Eine Analytics-Gruppe kann nur Ressourcen enthalten, die Sie hochgeladen oder beansprucht haben oder die mit einem von Ihnen verwalteten Kanal verknüpft sind. Dadurch können Kanalinhaber Gruppen von Videos und Playlists erstellen. Rechteinhaber können Gruppen von Videos, Playlists, Kanälen oder Assets erstellen.

Weitere Informationen zu dieser Ressource finden Sie in der zugehörigen Ressourcendarstellung und Liste der Attribute.

Methode HTTP-Anfrage Beschreibung
URIs relativ zu https://youtubeanalytics.googleapis.com/v2
list GET /groups 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.
insert POST /groups Erstellt eine YouTube Analytics-Gruppe. Verwenden Sie die Methode groupItems.insert, um der Gruppe Elemente hinzuzufügen.
update PUT /groups Ändert die Metadaten für eine Gruppe. Derzeit ist die einzige Eigenschaft, die aktualisiert werden kann, der Titel der Gruppe. Verwenden Sie groupItems.insert und groupItems.delete, um Gruppenelemente hinzuzufügen oder zu entfernen.
delete DELETE /groups Löscht eine Gruppe.

Gruppenelemente

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

Weitere Informationen zu dieser Ressource finden Sie in der zugehörigen Ressourcendarstellung und Liste der Attribute.

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