Videos: batchGetStats

Récupère une liste de statistiques vidéo correspondant aux paramètres de la requête API.

Impact sur le quota : un appel à cette méthode a un coût de quota d'une unité.

Requête

Requête HTTP

GET https://www.googleapis.com/youtube/v3/videos:batchGetStats

Autorisation

L'authentification est requise pour utiliser cette méthode avec des vidéos non publiques, mais pas pour les vidéos publiques. Si une autorisation est fournie, la requête doit être autorisée avec au moins l'un des champs d'application suivants (en savoir plus sur l'authentification et l'autorisation).

Champ d'application
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

Paramètres

Le tableau suivant répertorie les paramètres acceptés par cette requête. Tous les paramètres listés sont des paramètres de requête.

Paramètres
Paramètres obligatoires
id string
Le paramètre id spécifie une liste d'ID de vidéos YouTube séparés par une virgule pour les ressources à récupérer. Dans une ressource videoStat, la propriété id spécifie l'ID de la vidéo.
part string
Le paramètre part spécifie une liste d'une ou plusieurs propriétés de ressources videoStat que la réponse de l'API inclura.

La liste suivante contient les noms part que vous pouvez inclure dans la valeur du paramètre :
  • contentDetails
  • id
  • snippet
  • statistics
Paramètres facultatifs
onBehalfOfContentOwner string
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. Remarque : Ce paramètre est exclusivement destiné aux partenaires de contenu YouTube.

Le paramètre onBehalfOfContentOwner indique que les identifiants d'autorisation de la requête identifient un utilisateur du CMS YouTube agissant au nom du propriétaire du contenu spécifié dans la valeur du paramètre. Ce paramètre est destiné aux partenaires de contenu YouTube qui possèdent et gèrent de nombreuses chaînes YouTube différentes. Il permet aux propriétaires de contenu de s'authentifier une seule fois et d'accéder à toutes leurs données vidéo et de chaîne, sans avoir à fournir d'identifiants d'authentification pour chaque chaîne. Le compte CMS avec lequel l'utilisateur s'authentifie doit être associé au propriétaire de contenu YouTube spécifié.

Corps de la requête

Ne fournissez pas de corps de requête lorsque vous appelez cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
  "kind": "youtube#batchGetStatsResponse",
  "etag": etag,
  "items": [
    {
      "kind": "youtube#videoStats",
      "etag": etag,
      "id": string,
      "snippet": {
        "publishTime": datetime
      },
      "statistics": {
        "viewCount": unsigned long,
        "likeCount": unsigned long,
        "commentCount": unsigned long
      },
      "contentDetails": {
        "duration": string,
        "durationMillis": unsigned long
      }
    }
  ],
  "summary": {
    "requestedVideoCount": unsigned long,
    "succeededVideoCount": unsigned long,
    "failedVideoCount": unsigned long,
    "failedVideoIds": [
      string
    ]
  }
}

Propriétés

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

Propriétés
kind string
Identifie le type de ressource de l'API. La valeur sera youtube#batchGetStatsResponse.
etag etag
Etag de cette ressource.
items[] list
Liste des statistiques vidéo correspondant aux critères de la requête.
items[].id string
ID utilisé par YouTube pour identifier de manière unique la vidéo.
items[].snippet.publishTime datetime
Date et heure de mise en ligne de la vidéo.
items[].statistics.viewCount unsigned long
Nombre de fois où la vidéo a été visionnée.
items[].statistics.likeCount unsigned long
Nombre d'utilisateurs ayant indiqué avoir aimé la vidéo.
items[].statistics.commentCount unsigned long
Nombre de commentaires sur la vidéo.
items[].contentDetails.duration string
Durée de la vidéo.
items[].contentDetails.durationMillis unsigned long
Durée de la vidéo en millisecondes.
summary object
Résumé de la requête batchGetStats.
summary.requestedVideoCount unsigned long
Nombre de vidéos demandées.
summary.succeededVideoCount unsigned long
Nombre de vidéos traitées avec succès.
summary.failedVideoCount unsigned long
Nombre de vidéos ayant échoué.
summary.failedVideoIds[] list
ID des vidéos qui ont échoué.

Erreurs

L'API ne définit aucun message d'erreur propre à cette méthode d'API. Toutefois, cette méthode peut toujours renvoyer des erreurs d'API générales listées dans la documentation sur les messages d'erreur.