Videos: batchGetStats

Recupera uma lista de estatísticas de vídeo que correspondem aos parâmetros da solicitação de API.

Impacto na cota:uma chamada para esse método tem um custo de cota de 1 unidade.

Solicitação

Solicitação HTTP

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

Autorização

A autenticação é necessária para usar esse método em vídeos não públicos, mas não é obrigatória para vídeos públicos. Se a autorização for fornecida, a solicitação precisará ser autorizada com pelo menos um dos seguintes escopos (saiba mais sobre autenticação e autorização).

Escopo
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

A tabela a seguir lista os parâmetros compatíveis com essa consulta. Todos os parâmetros listados são os parâmetros de consulta.

Parâmetros
Parâmetros obrigatórios
id string
O parâmetro id especifica uma lista separada por vírgulas dos IDs de vídeos do YouTube para os recursos que estão sendo recuperados. Em um recurso videoStat, a propriedade id especifica o ID do vídeo.
part string
O parâmetro part especifica uma lista separada por vírgulas de uma ou mais propriedades de recursos videoStat que a resposta da API vai incluir.

A lista a seguir contém os nomes part que podem ser incluídos no valor do parâmetro:
  • contentDetails
  • id
  • snippet
  • statistics
Parâmetros opcionais
onBehalfOfContentOwner string
Esse parâmetro só pode ser usado em uma solicitação devidamente autorizada. Observação: esse parâmetro é destinado exclusivamente a parceiros de conteúdo do YouTube.

O parâmetro onBehalfOfContentOwner indica que as credenciais de autorização da solicitação identificam um usuário do CMS do YouTube que está agindo em nome do proprietário do conteúdo especificado no valor de parâmetro. Este parâmetro destina-se a parceiros de conteúdo do YouTube que possuem e gerenciam vários canais do YouTube diferentes. Ele permite que os proprietários de conteúdo autentiquem uma vez e tenham acesso a todos os dados de seu canal e de seus vídeos sem ter que fornecer credenciais de autenticação para cada canal. A conta do CMS com a qual o usuário autentica deve estar vinculada ao proprietário do conteúdo do YouTube especificado.

Corpo da solicitação

Não forneça um corpo de solicitação ao chamar este método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

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

Propriedades

A tabela a seguir define as propriedades que aparecem neste recurso:

Propriedades
kind string
Identifica o tipo de recurso da API. O valor será youtube#batchGetStatsResponse.
etag etag
É a ETag deste recurso.
items[] list
Uma lista de estatísticas de vídeo que correspondem aos critérios da solicitação.
items[].id string
O ID que o YouTube usa para identificar o vídeo de maneira exclusiva.
items[].snippet.publishTime datetime
A data e a hora em que o vídeo foi enviado.
items[].statistics.viewCount unsigned long
É o número de visualizações do vídeo.
items[].statistics.likeCount unsigned long
O número de usuários que indicaram que gostaram do vídeo.
items[].statistics.commentCount unsigned long
O número de comentários do vídeo.
items[].contentDetails.duration string
A duração do vídeo.
items[].contentDetails.durationMillis unsigned long
A duração do vídeo em milissegundos.
summary object
Resumo da solicitação batchGetStats.
summary.requestedVideoCount unsigned long
O número de vídeos solicitados.
summary.succeededVideoCount unsigned long
O número de vídeos que foram bem-sucedidos.
summary.failedVideoCount unsigned long
O número de vídeos que falharam.
summary.failedVideoIds[] list
Os IDs de vídeo que falharam.

Erros

A API não define nenhuma mensagem de erro exclusiva para esse método. No entanto, esse método ainda pode retornar erros gerais da API listados na documentação de mensagens de erro.