Reports

Une ressource report identifie une instance spécifique d'un rapport. La ressource identifie la période pour laquelle le rapport contient des données, ainsi que l'URL à partir de laquelle le rapport 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	Liste les rapports générés pour le job de création de rapports spécifié.

Représentation des ressources JSON

La structure JSON ci-dessous montre 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 de manière unique le rapport. Chaque rapport est associé à un seul job, mais un job peut être associé à plusieurs ID de rapport.
jobId	string ID du job qui a créé ce rapport.
startTime	timestamp Début de la période couverte par l'instance de rapport. La valeur inclusive est un code temporel 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 est un code temporel 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 code temporel 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 du job associé au rapport. La valeur de la propriété est un code temporel 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é au job du rapport a été abandonné ou si les rapports générés pour ce job n'ont pas été téléchargés pendant une longue période. Cette valeur indique la date après laquelle YouTube ne générera plus de rapports pour le job. Si vous avez un job qui identifie une date d'expiration, vous devez mettre à jour votre système pour qu'il cesse de demander le rapport à 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 dans les demandes de téléchargement. Bien que votre application ait besoin de temps CPU supplémentaire pour décompresser les réponses de l'API, l'avantage 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