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 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 générés pour la tâche de création de rapports spécifiée.

Représentation de la ressource 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 comme identifiant unique du rapport. Chaque rapport est associé à une tâche unique, bien qu'une tâche puisse être associée à de nombreux ID de rapport.
jobId
string ID de la tâche qui a créé ce rapport.
startTime
timestamp Début de la période couverte par l'instance de rapport. La valeur inclusive est un horodatage au format RFC3339 UTC "Zulu" avec une précision à 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" avec une précision à 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 dans RFC3339 UTC "Zulu" avec une précision à la microseconde près. Exemple : "2015-10-02T15:01:23.045678Z".
jobExpireTime
timestamp Date et heure de l'expiration ou de l'expiration de l'offre d'emploi associée au rapport. La valeur de la propriété est un code temporel dans RFC3339 UTC "Zulu" avec une précision à la microseconde près. Exemple: "2015-10-02T15:01:23.045678Z".

Cette propriété est associée à 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 pendant une période prolongée. La valeur indique la date après laquelle YouTube ne générera plus de rapports pour cette tâche.

Si une tâche présente une date d'expiration, vous devez mettre à jour votre système pour arrêter 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 comporter plus de 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 au téléchargement des rapports en activant la compression gzip pour les requêtes de téléchargement. Bien que votre application nécessite un temps CPU supplémentaire pour décompresser les réponses de l'API, l'avantage d'une consommation moins importante des 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 illustré dans l'exemple suivant:

Accept-Encoding: gzip