Reports

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

Methoden

In der folgenden Tabelle sind die Methoden aufgeführt, 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 Berichtsjob generiert wurden.

Darstellung von JSON-Ressourcen

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 Job zugeordnet, ein Job kann jedoch mehreren Berichts-IDs zugeordnet sein.
jobId string
Die ID des Jobs, der diesen Bericht erstellt hat.
startTime timestamp
Der Beginn des Zeitraums, für den die Berichtsinstanz gilt. Der eingeschlossene Wert ist ein Zeitstempel im Format RFC3339 UTC „Zulu“ in Mikrosekunden. Beispiel: "2015-10-02T15:01:23.045678Z".
endTime timestamp
Das Ende des Zeitraums, für den die Berichtsinstanz gilt. Der exklusive Wert ist ein Zeitstempel im Format RFC3339 UTC „Zulu“ in Mikrosekunden. Beispiel: "2015-10-02T15:01:23.045678Z".
createTime timestamp
Das Datum und die Uhrzeit der Erstellung des Jobs. Der Attributwert ist ein Zeitstempel im Format RFC3339 UTC „Zulu“ in Mikrosekunden. Beispiel: "2015-10-02T15:01:23.045678Z".
jobExpireTime timestamp
Das Datum und die Uhrzeit, wann der Job, der dem Bericht zugeordnet ist, abgelaufen ist oder abläuft. Der Attributwert ist ein Zeitstempel im Format RFC3339 UTC „Zulu“ in Mikrosekunden. Beispiel: "2015-10-02T15:01:23.045678Z".

Diese Eigenschaft hat einen Wert, wenn entweder der Berichtstyp, der dem Job zugewiesen ist, veraltet ist oder die Berichte für diesen Job über einen längeren Zeitraum nicht heruntergeladen wurden. Der Wert gibt das Datum an, nach dem YouTube keine neuen Berichte für den Job mehr erstellen kann.

Wenn du einen Job mit einem Ablaufdatum hast, solltest du dein System so aktualisieren, dass der Bericht bis zu diesem Datum nicht mehr angefordert wird. In einigen Fällen ist ein Ersatzbericht verfügbar.
downloadUrl string
Die URL, unter der der Bericht heruntergeladen werden kann. Der Attributwert darf maximal 1.000 Zeichen lang sein.

Um den Bericht abzurufen, senden Sie eine HTTP-GET-Anfrage an diese URL. Legen Sie in der Anfrage den Authorization-HTTP-Anfrageheader mit Ihrem Autorisierungstoken als Headerwert fest.

gzip verwenden

Sie können die für das Herunterladen von Berichten erforderliche Bandbreite reduzieren, indem Sie bei Downloadanfragen die gzip-Komprimierung aktivieren. Während Ihre Anwendung zusätzliche CPU-Zeit benötigt, um API-Antworten zu dekomprimieren, ist der Vorteil, dass weniger Netzwerkressourcen verbraucht werden, normalerweise schwerer als diese Kosten.

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

Accept-Encoding: gzip