Videos: batchGetStats

Recupera una lista de estadísticas de video que coinciden con los parámetros de la solicitud a la API.

Impacto en la cuota: Una llamada a este método tiene un costo de cuota de 1 unidad.

Solicitud

Solicitud HTTP

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

Autorización

Se requiere autenticación para usar este método en videos no públicos, pero no para videos públicos. Si se proporciona autorización, la solicitud debe autorizarse con al menos uno de los siguientes alcances (obtén más información sobre la autenticación y la autorización).

Alcance
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

Parámetros

En la siguiente tabla, se muestran los parámetros que admite esta consulta. Todos los parámetros mencionados son parámetros de consulta.

Parámetros
Parámetros obligatorios
id string
El parámetro id especifica una lista separada por comas de los IDs de video de YouTube para los recursos que se recuperan. En un recurso videoStat, la propiedad id especifica el ID del video.
part string
El parámetro part especifica una lista separada por comas de una o más propiedades de recursos videoStat que incluirá la respuesta de la API.

La siguiente lista contiene los nombres part que puedes incluir en el valor del parámetro:
  • contentDetails
  • id
  • snippet
  • statistics
Parámetros opcionales
onBehalfOfContentOwner string
Este parámetro solo se puede usar en una solicitud autorizada correctamente. Nota: Este parámetro está destinado exclusivamente a socios de contenido de YouTube.

El parámetro onBehalfOfContentOwner indica que las credenciales de autorización de la solicitud identifican a un usuario de CMS de YouTube que actúa en nombre del propietario del contenido especificado en el valor del parámetro. Este parámetro está dirigido a socios de contenido de YouTube que poseen y administran muchos canales de YouTube diferentes. Permite a los propietarios del contenido autenticarse una vez y tener acceso a todos los datos de sus videos y canales, sin tener que proporcionar credenciales de autenticación para cada canal. La cuenta de CMS con la que se autentica el usuario debe estar relacionada con el propietario del contenido de YouTube especificado.

Cuerpo de la solicitud

No proporciones un cuerpo de solicitud cuando invoques este método.

Respuesta

Si se aplica correctamente, este método muestra un cuerpo de respuesta con la siguiente estructura:

{
  "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
    ]
  }
}

Propiedades

La siguiente tabla define las propiedades que aparecen en este recurso:

Propiedades
kind string
Identifica el tipo de recurso de la API. El valor será youtube#batchGetStatsResponse.
etag etag
Es el Etag de este recurso.
items[] list
Es una lista de estadísticas de video que coinciden con los criterios de la solicitud.
items[].id string
Es el ID que usa YouTube para identificar de forma exclusiva el video.
items[].snippet.publishTime datetime
Es la fecha y hora en que se subió el video.
items[].statistics.viewCount unsigned long
Es la cantidad de reproducciones del video.
items[].statistics.likeCount unsigned long
Es la cantidad de usuarios que indicaron que les gustó el video.
items[].statistics.commentCount unsigned long
Es la cantidad de comentarios del video.
items[].contentDetails.duration string
Es la duración del video.
items[].contentDetails.durationMillis unsigned long
Es la duración del video, expresada en milisegundos.
summary object
Es un resumen de la solicitud batchGetStats.
summary.requestedVideoCount unsigned long
Es la cantidad de videos solicitados.
summary.succeededVideoCount unsigned long
Es la cantidad de videos que se completaron correctamente.
summary.failedVideoCount unsigned long
Es la cantidad de videos que fallaron.
summary.failedVideoIds[] list
Son los IDs de video que fallaron.

Errores

La API no define ningún mensaje de error que sea exclusivo de este método de la API. Sin embargo, este método aún podría mostrar errores generales de la API que se enumeran en la documentación de mensajes de error.