LiveBroadcasts: list

Retorna uma lista de transmissões do YouTube que correspondem aos parâmetros da solicitação de API.

Casos de uso comuns

Solicitação

Solicitação HTTP

GET https://www.googleapis.com/youtube/v3/liveBroadcasts

Autorização

Essa solicitação exige autorização com pelo menos um dos escopos a seguir. Para saber mais sobre autenticação e autorização, consulte Implementar a autenticação do OAuth 2.0.

Escopo
https://www.googleapis.com/auth/youtube.readonly
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

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
part string
O parâmetro part especifica uma lista separada por vírgulas de uma ou mais propriedades de recursos liveBroadcast que a resposta da API vai incluir. Os nomes de part que podem ser incluídos no valor de parâmetro são id, snippet, contentDetails, monetizationDetails e status.
Filtros (especifique exatamente um dos seguintes parâmetros)
broadcastStatus string
O parâmetro broadcastStatus filtra a resposta da API para incluir apenas transmissões com o status especificado.

Os valores aceitáveis são:
  • active: retorna transmissões ao vivo atuais.
  • all – retorna todas as transmissões.
  • completed – retorna transmissões que já terminaram.
  • upcoming: retorna transmissões que ainda não começaram.
id string
O parâmetro id especifica uma lista separada por vírgulas de IDs de transmissão do YouTube que identificam as transmissões que estão sendo recuperadas. Em um recurso liveBroadcast, a propriedade id especifica o ID da transmissão.
mine boolean
O parâmetro mine pode ser usado para instruir a API a retornar apenas transmissões de propriedade do usuário autenticado. Defina o valor de parâmetro como true para recuperar apenas suas próprias transmissões.
Parâmetros opcionais
broadcastType string
O parâmetro broadcastType filtra a resposta da API para incluir apenas transmissões com o tipo especificado. O parâmetro precisa ser usado em solicitações que definem o parâmetro mine como true ou que usam o parâmetro broadcastStatus. O valor padrão é event.

Os valores aceitáveis são:
  • all – retorna todas as transmissões.
  • event: retorna apenas transmissões de eventos programados.
  • persistent – retorna apenas transmissões persistentes.
maxResults unsigned integer
O parâmetro maxResults especifica o número máximo de itens que precisam ser retornados no conjunto de resultados. Os valores aceitáveis são de 0 a 50, inclusive. O valor padrão é 5.
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 Sistema de gerenciamento de conteúdo (CMS, na sigla em inglês) 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.
onBehalfOfContentOwnerChannel 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 onBehalfOfContentOwnerChannel especifica o ID do canal do YouTube ao qual um vídeo está sendo adicionado. Esse parâmetro é obrigatório quando uma solicitação especifica um valor para o parâmetro onBehalfOfContentOwner e só pode ser usado em conjunto com esse parâmetro. Além disso, a solicitação precisa ser autorizada usando uma conta do CMS vinculada ao proprietário do conteúdo que o parâmetro onBehalfOfContentOwner especifica. Por fim, o canal que o valor do parâmetro onBehalfOfContentOwnerChannel especifica precisa estar vinculado ao proprietário do conteúdo que o parâmetro onBehalfOfContentOwner especifica.

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 realizem ações em nome do canal especificado no valor do parâmetro, sem ter que fornecer credenciais de autenticação para cada canal separado.
pageToken string
O parâmetro pageToken identifica uma página específica no conjunto de resultados que precisa ser retornada. Em uma resposta da API, as propriedades nextPageToken e prevPageToken identificam outras páginas que podem ser recuperadas.

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#liveBroadcastListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveBroadcast Resource
  ]
}

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#liveBroadcastListResponse.
etag etag
O Etag desse recurso.
nextPageToken string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a próxima página no conjunto de resultados.
prevPageToken string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a página anterior no conjunto de resultados.
pageInfo object
O objeto pageInfo encapsula informações de paginação para o conjunto de resultados.
pageInfo.totalResults integer
O número total de resultados no conjunto de resultados.
pageInfo.resultsPerPage integer
O número de resultados incluídos na resposta da API.
items[] list
Uma lista de transmissões que correspondem aos critérios da solicitação.

Erros

A tabela a seguir identifica as mensagens de erro que a API pode retornar em resposta a uma chamada para esse método. Para mais detalhes, consulte a mensagem de erro.

Tipo de erro Detalhe do erro Descrição
insufficientPermissions insufficientLivePermissions A solicitação não está autorizada a recuperar a transmissão ao vivo.
insufficientPermissions liveStreamingNotEnabled O usuário que autorizou a solicitação não está ativado para transmitir vídeos ao vivo no YouTube. Para mais informações, consulte Qualificação para recursos.

Confira!

Use o APIs Explorer para chamar essa API e conferir a solicitação e a resposta da API.