Reports

Eine report-Ressource identifiziert eine bestimmte Instanz eines Berichts. Die Ressource gibt den Zeitraum an, für den der Bericht Daten enthält, sowie die URL, unter der der Bericht heruntergeladen werden kann.

Methoden

Die folgende Tabelle zeigt die Methoden, die von der API für report-Ressourcen unterstützt werden.

Methoden
get Ruft die Metadaten für einen bestimmten Bericht ab.
list Listet Berichte auf, die für den angegebenen Berichtjob generiert wurden.

JSON-Ressourcendarstellung

Die folgende JSON-Struktur zeigt das Format einer report-Ressource:

{
  "id": string,
  "jobId": string,
  "startTime": timestamp,
  "endTime": timestamp,
  "createTime": timestamp,
  "jobExpireTime": timestamp,
  "downloadUrl": string
}

Attribute

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

Attribute
id string
Die ID, die YouTube zur eindeutigen Identifizierung des Berichts zuweist. Jeder Bericht ist einem einzelnen Auftrag zugeordnet. Er kann jedoch mit vielen Berichts-IDs verknüpft sein.
jobId string
Die ID des Jobs, mit dem dieser Bericht erstellt wurde.
startTime timestamp
Der Beginn des Zeitraums, den die Berichtsinstanz abdeckt. Der inklusive Wert ist ein Zeitstempel in RFC3339 UTC "Zulu" bis auf Mikrosekunden genau. Beispiel: "2015-10-02T15:01:23.045678Z".
endTime timestamp
Das Ende des Zeitraums, den die Berichtsinstanz abdeckt. Der exklusive Wert ist ein Zeitstempel in RFC3339 UTC "Zulu" bis auf Mikrosekunden genau. Beispiel: "2015-10-02T15:01:23.045678Z".
createTime timestamp
Datum und Uhrzeit der Joberstellung. Der Eigenschaftswert ist ein Zeitstempel in RFC3339 UTC "Zulu" bis auf Mikrosekunden genau. Beispiel: "2015-10-02T15:01:23.045678Z".
jobExpireTime timestamp
Das Datum und die Uhrzeit, zu der der mit dem Bericht verknüpfte Job entweder abgelaufen ist oder abläuft. Der Eigenschaftswert ist ein Zeitstempel in RFC3339 UTC "Zulu" bis auf Mikrosekunden genau. Beispiel: "2015-10-02T15:01:23.045678Z".

Diese Property hat einen Wert, wenn entweder der Berichtstyp, der mit dem Job des Berichts verknüpft ist, eingestellt wurde oder wenn für diesen Job generierte Berichte über einen längeren Zeitraum nicht heruntergeladen wurden. Der Wert kennzeichnet das Datum, nach dem YouTube keine neuen Berichte mehr für den Job erstellt.

Wenn du einen Job hast, bei dem ein Ablaufdatum festgelegt ist, solltest du dein System so aktualisieren, dass der Bericht ab diesem Datum nicht mehr angefordert wird. In einigen Fällen ist möglicherweise ein Ersatzbericht verfügbar.
downloadUrl string
Die URL, unter der der Bericht heruntergeladen werden kann. Der Property-Wert darf maximal 1.000 Zeichen lang sein.

Sende eine HTTP-GET-Anfrage an diese URL, um den Bericht abzurufen. Legen Sie in der Anfrage den Authorization-HTTP-Anfrageheader fest und verwenden Sie Ihr Autorisierungstoken als Headerwert.

gzip verwenden

Sie können die für das Herunterladen von Berichten erforderliche Bandbreite verringern, indem Sie die gzip-Komprimierung für Downloadanfragen aktivieren. Für die Dekomprimierung von API-Antworten benötigt Ihre Anwendung zwar zusätzliche CPU-Zeit, doch in der Regel überwiegt der Vorteil der geringeren Netzwerkressourcen diese Kosten.

Um eine mit gzip codierte Antwort zu erhalten, setze den Accept-Encoding-HTTP-Anfrageheader auf gzip, wie im folgenden Beispiel gezeigt:

Accept-Encoding: gzip