Reports

Une ressource report identifie une instance spécifique d'un rapport. La ressource identifie la période pendant laquelle le rapport contient des données, ainsi que l'URL depuis laquelle il peut être téléchargé.

Méthodes

Le tableau suivant présente les méthodes compatibles avec l'API pour les ressources report.

Méthodes
get Récupère les métadonnées d'un rapport spécifique.
list Répertorie les rapports qui ont été générés pour la tâche de création de rapports spécifiée.

Représentation des ressources JSON

La structure JSON ci-dessous présente le format d'une ressource report:

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

Propriétés

Le tableau suivant définit les propriétés qui apparaissent dans cette ressource:

Propriétés
id string
ID attribué par YouTube pour identifier le rapport de manière unique. Chaque rapport est associé à une tâche unique, bien qu'une tâche puisse être associée à plusieurs ID de rapport.
jobId string
ID de la tâche ayant créé ce rapport.
startTime timestamp
Début de la période couverte par l'instance de rapport. La valeur inclusive correspond à un horodatage au format RFC3339 UTC "Zulu", précis à la microseconde près. Exemple : "2015-10-02T15:01:23.045678Z".
endTime timestamp
Fin de la période couverte par l'instance de rapport. La valeur exclusive correspond à un horodatage au format RFC3339 UTC "Zulu", précis à la microseconde près. Exemple : "2015-10-02T15:01:23.045678Z".
createTime timestamp
Date et heure de création du job. La valeur de la propriété est un horodatage au format RFC3339 UTC "Zulu", précis à la microseconde près. Exemple : "2015-10-02T15:01:23.045678Z".
jobExpireTime timestamp
Date et heure d'expiration de la tâche associée au rapport. La valeur de la propriété est un horodatage au format RFC3339 UTC "Zulu", précis à la microseconde près. Exemple : "2015-10-02T15:01:23.045678Z".

Cette propriété a une valeur si le type de rapport associé à la tâche du rapport est obsolète ou si les rapports générés pour cette tâche n'ont pas été téléchargés depuis longtemps. La valeur indique la date à partir de laquelle YouTube ne générera plus de nouveaux rapports pour le projet.

Si une tâche identifie une date d'expiration, vous devez mettre à jour votre système afin qu'il cesse de demander le rapport avant cette date. Dans certains cas, un rapport de remplacement peut être disponible.
downloadUrl string
URL depuis laquelle le rapport peut être téléchargé. La valeur de la propriété ne doit pas dépasser 1 000 caractères.

Pour récupérer le rapport, envoyez une requête HTTP GET à cette URL. Dans la requête, définissez l'en-tête de requête HTTP Authorization en utilisant votre jeton d'autorisation comme valeur d'en-tête.

Utiliser gzip

Vous pouvez réduire la bande passante nécessaire pour télécharger des rapports en activant la compression gzip sur les demandes de téléchargement. Bien que votre application ait besoin de plus de temps CPU pour décompresser les réponses de l'API, le fait de consommer moins de ressources réseau compense généralement ce coût.

Pour recevoir une réponse encodée au format gzip, définissez l'en-tête de requête HTTP Accept-Encoding sur gzip, comme indiqué dans l'exemple suivant:

Accept-Encoding: gzip