Referência da API

Esta referência de API explica como programar transmissões ao vivo e streams de vídeo no YouTube usando a API de transmissão ao vivo do YouTube.

Tipos de recurso

LiveBroadcasts

Um recurso liveBroadcast representa um evento que será transmitido, por meio de vídeo ao vivo, no YouTube.

Para mais informações sobre este recurso, consulte sua representação de recurso e lista de propriedades.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/youtube/v3
bind POST /liveBroadcasts/bind Vincula uma transmissão do YouTube a um stream ou remove uma vinculação existente entre uma transmissão e uma transmissão. Uma transmissão de vídeo só pode ser vinculada a um stream de vídeo, mas um stream de vídeo pode estar vinculado a mais de uma transmissão.
delete DELETE /liveBroadcasts Exclui uma transmissão.
insert POST /liveBroadcasts Cria uma transmissão.
list GET /liveBroadcasts Retorna uma lista de transmissões do YouTube que correspondem aos parâmetros da solicitação da API.
transition POST /liveBroadcasts/transition Altera o status de uma transmissão ao vivo do YouTube e inicia todos os processos associados ao novo status. Por exemplo, quando você faz a transição do status de uma transmissão para testing, o YouTube começa a transmitir vídeos para o stream de monitor dessa transmissão. Antes de chamar esse método, confirme se o valor da propriedade status.streamStatus para o stream vinculado à sua transmissão é active.
update PUT /liveBroadcasts Atualiza uma transmissão. Por exemplo, é possível modificar as configurações de transmissão definidas no objeto contentDetails do recurso liveBroadcast.
cuepoint POST /liveBroadcasts/cuepoint Insere um marcador em uma transmissão ao vivo. O marcador pode acionar um intervalo de anúncio.

LiveChatBans

O recurso liveChatBan identifica um usuário e um chat ao vivo do YouTube em que ele não pode mais participar.

Para mais informações sobre este recurso, consulte sua representação de recurso e lista de propriedades.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/bans Remove um banimento que impede que um usuário específico contribua para um chat ao vivo, permitindo que ele volte a participar do chat. A solicitação de API precisa ser autorizada pelo proprietário do canal ou por um moderador do chat ao vivo associado ao banimento.
insert POST /liveChat/bans Banir um usuário específico de participar do chat ao vivo. A solicitação de API precisa ser autorizada pelo proprietário do canal ou por um moderador do chat ao vivo associado ao banimento.

LiveChatMessages

O recurso liveChatMessage representa uma mensagem em um chat ao vivo do YouTube. O recurso pode conter detalhes sobre vários tipos de mensagens, incluindo uma mensagem de texto recém-postada ou um evento de financiamento por fãs.

O recurso de chat ao vivo fica ativado por padrão para transmissões ao vivo e fica disponível enquanto o evento ao vivo está ativo. Após o término do evento, o chat ao vivo não estará mais disponível.

Para mais informações sobre este recurso, consulte sua representação de recurso e lista de propriedades.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/messages Exclui uma mensagem de chat. A solicitação de API precisa ser autorizada pelo proprietário do canal ou por um moderador do chat ao vivo associado ao banimento.
insert POST /liveChat/messages Adiciona uma mensagem a um chat ao vivo.
list GET /liveChat/messages Lista as mensagens de um chat ao vivo específico.

LiveChatModerators

Um recurso liveChatModerator representa um moderador de um chat ao vivo do YouTube. O moderador pode banir ou cancelar a ação de usuários de um chat, remover mensagens e realizar outras ações administrativas no chat ao vivo.

Para mais informações sobre este recurso, consulte sua representação de recurso e lista de propriedades.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/moderators Remove um moderador de bate-papo. A solicitação precisa ser autorizada pelo proprietário do canal da transmissão ao vivo.
insert POST /liveChat/moderators Adiciona um novo moderador ao bate-papo. A solicitação precisa ser autorizada pelo proprietário do canal da transmissão ao vivo.
list GET /liveChat/moderators Lista moderadores de um chat ao vivo. A solicitação precisa ser autorizada pelo proprietário do canal da transmissão ao vivo.

LiveStreams

Um recurso liveStream contém informações sobre o stream de vídeo que você está transmitindo para o YouTube. O stream fornece o conteúdo que será transmitido aos usuários do YouTube. Depois de criado, um recurso liveStream pode ser vinculado a um ou mais recursos liveBroadcast.

Para mais informações sobre este recurso, consulte sua representação de recurso e lista de propriedades.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/youtube/v3
delete DELETE /liveStreams Exclui um stream de vídeo.
insert POST /liveStreams Cria um stream de vídeo. O stream permite que você envie seu vídeo para o YouTube, que poderá transmiti-lo para seu público.
list GET /liveStreams Retorna uma lista de streams de vídeo que correspondem aos parâmetros da solicitação de API.
update PUT /liveStreams Atualiza um stream de vídeo. Se não for possível atualizar as propriedades que você quer mudar, crie um novo stream com as configurações adequadas.

SuperChatEvents

O recurso superChatEvent representa uma mensagem do Super Chat comprada por um fã durante uma transmissão ao vivo no YouTube. No chat ao vivo do YouTube, os Super Chats se destacam de outras mensagens de duas maneiras:

  • Os Super Chats são destacados com uma cor.
  • Os Super Chats ficam fixados no painel de mensagens por um determinado período.

A cor do Super Chat, o período em que ele fica fixado no painel e o comprimento máximo da mensagem são determinados pelo valor da compra. Acesse a Central de Ajuda do YouTube para saber mais sobre os Super Chats.

Para mais informações sobre este recurso, consulte sua representação de recurso e lista de propriedades.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/youtube/v3
list GET /superChatEvents Listar eventos do Super Chat das transmissões ao vivo de um canal nos últimos 30 dias.

Tipos de recursos descontinuados

FanFundingEvents

Um recurso de fanFundingEvent representa um evento de Financiamento por fãs em um canal do YouTube. O financiamento por fãs é uma forma de apoiar monetariamente os criadores de conteúdo do YouTube. Um evento de Financiamento por fãs ocorre quando um usuário faz um pagamento único e voluntário a um canal. Acesse a Central de Ajuda do YouTube para saber mais sobre o Financiamento por fãs.

Para mais informações sobre este recurso, consulte sua representação de recurso e lista de propriedades.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/youtube/v3
list GET /fanFundingEvents Lista os eventos de financiamento por fãs de um canal. A solicitação de API precisa ser autorizada pelo proprietário do canal.

LiveCuepoints

Um recurso liveCuepoint inicia um intervalo de anúncio no stream de transmissão de vídeo.

Observação:na verdade, o comando da API para controlar pontos de inserção faz parte da API Content ID do YouTube e tem requisitos de autorização diferentes das solicitações de gerenciamento de recursos liveBroadcast e liveStream.

Para mais informações sobre este recurso, consulte sua representação de recurso e lista de propriedades.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/
insert POST /liveCuepoints Insere um marcador em uma transmissão ao vivo. Atualmente, as solicitações feitas a esse método devem ser autorizadas por uma conta associada a um proprietário do conteúdo do YouTube.

Patrocinadores

Um recurso de sponsor representa um patrocinador de um canal do YouTube. Um patrocinador oferece apoio monetário recorrente, como uma assinatura ou taxa de assinatura, ao criador de conteúdo e recebe benefícios especiais. Por exemplo, os patrocinadores podem bater papo quando o criador de conteúdo ativar o modo exclusivo para patrocinadores.

Para mais informações sobre este recurso, consulte sua representação de recurso e lista de propriedades.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/youtube/v3
list GET /sponsors Lista os patrocinadores de um canal. A solicitação de API precisa ser autorizada pelo proprietário do canal.