YouTube Reporting API

Mit der YouTube Reporting API können Entwickler Berichterstellungsjobs planen und dann generierte Bulk-Berichte herunterladen. Die API unterstützt eine vordefinierte Reihe von Berichten, die jeweils eine umfassende Menge an YouTube Analytics-Daten für einen Kanal oder Rechteinhaber enthalten.

Im Folgenden wird beschrieben, wie Sie Berichtsjobs planen und Berichte abrufen:

  1. Rufen Sie die Methode reportTypes.list() auf, um eine Liste der Berichte abzurufen, die ein Kanal- oder Rechteinhaber abrufen kann.
  2. Rufen Sie die Methode jobs.create() auf, um einen Bericht zu identifizieren, der für einen Kanal oder Rechteinhaber generiert werden soll. Anschließend können Sie mit den jobs.list()- und jobs.delete()-Parametern der API die Liste der generierten Berichte abrufen oder ändern.
  3. Rufen Sie die Methode jobs.reports.list() auf, um eine Liste der Berichte abzurufen, die für einen bestimmten Job generiert wurden. Jede Ressource in der Antwort enthält das Attribut downloadUrl, das die URL angibt, über die der Bericht heruntergeladen werden kann.
  4. Senden Sie eine autorisierte GET-Anfrage, um den Bericht über die Download-URL abzurufen.

Autorisierung

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

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

Ebenen
https://www.googleapis.com/auth/yt-analytics.readonly YouTube Analytics-Berichte für deine YouTube-Inhalte ansehen Dieser Bereich bietet Zugriff auf Messwerte zur Nutzeraktivität wie Aufruf- und Bewertungszahlen.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly YouTube Analytics-Finanzberichte für deine YouTube-Inhalte abrufen Dieser Bereich bietet Zugriff auf Messwerte zur Nutzeraktivität sowie auf geschätzte Umsatz- und Anzeigenleistungsmesswerte.

Ressourcentypen

In den folgenden Abschnitten finden Sie allgemeine Beschreibungen der Ressourcen und Methoden der API. Alle in den Tabellen gezeigten Methoden-URIs sind relativ zu https://youtubereporting.googleapis.com.

jobs

Methoden
create POST /v1/jobs
Erstellt einen Berichtsjob. Wenn Sie einen Berichtsjob erstellen, weisen Sie YouTube an, diesen Bericht täglich zu generieren. Der Bericht ist innerhalb von 24 Stunden nach der Erstellung des Jobs verfügbar.
delete DELETE /v1/jobs/{jobId}
Löscht einen Berichtsjob.
get GET /v1/jobs/{jobId}
Ruft Informationen zu einem bestimmten Berichtsjob ab, der für einen Kanal oder einen Rechteinhaber geplant wurde.
list GET /v1/jobs
Listet Berichtsjobs auf, die für einen Kanal oder Rechteinhaber geplant wurden. Jede Ressource in der Antwort enthält das Attribut id, das die ID angibt, mit der YouTube den Job eindeutig identifiziert. Sie benötigen diese ID, um die Liste der Berichte abzurufen, die für den Job generiert wurden, oder um den Job zu löschen.

jobs.reports

Methoden
get GET /v1/jobs/{jobId}/reports/{reportId}
Ruft die Metadaten für einen bestimmten Bericht ab.
list GET /v1/jobs/{jobId}/reports
Listet Berichte auf, die für den angegebenen Berichtsjob generiert wurden.

reportTypes

Methoden
list GET /v1/reportTypes
Gibt eine Liste der Berichtstypen zurück, die der Kanal- oder Rechteinhaber abrufen kann.