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 YouTube Live Streaming.

Tipos de recurso

LiveBroadcasts

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

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

Método Solicitação HTTP Descrição
URIs relativos 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 um stream. Uma transmissão só pode ser vinculada a um stream de vídeo, mas um stream de vídeo pode ser 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 de solicitação da API.
transition POST /liveBroadcasts/transition Muda o status de uma transmissão ao vivo do YouTube e inicia todos os processos associados ao novo status. Por exemplo, quando você muda o status de uma transmissão para testing, o YouTube começa a transmitir o vídeo para o stream de monitoramento dessa transmissão. Antes de chamar esse método, confirme se o valor da propriedade status.streamStatus do stream vinculado à 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 ponto de referência em uma transmissão ao vivo. O ponto de referência pode acionar um intervalo de anúncio.

LiveChatBans

Um recurso liveChatBan identifica um usuário do YouTube e um chat ao vivo do YouTube em que o usuário está banido de participar.

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

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

LiveChatMessages

Um recurso liveChatMessage representa uma mensagem de chat 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-publicada ou um evento de financiamento por fãs.

O recurso de chat ao vivo é ativado por padrão para transmissões ao vivo e fica disponível enquanto o evento está ativo. Depois que o evento termina, o chat ao vivo não está mais disponível para ele.

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

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

LiveChatModerators

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

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

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/moderators Remove um moderador de chat. 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 chat. A solicitação precisa ser autorizada pelo proprietário do canal da transmissão ao vivo.
list GET /liveChat/moderators Lista os 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 obter mais informações sobre este recurso, consulte sua representação de recurso e lista de propriedades.

Método Solicitação HTTP Descrição
URIs relativos 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. Com a transmissão, você pode enviar seu vídeo para o YouTube, que pode transmitir o conteúdo para seu público.
list GET /liveStreams Retorna uma lista de transmissões de vídeo que correspondem aos parâmetros de solicitação da API.
update PUT /liveStreams Atualiza um fluxo de vídeo. Se as propriedades que você quer mudar não puderem ser atualizadas, crie uma nova transmissão com as configurações adequadas.

SuperChatEvents

Um recurso superChatEvent representa uma mensagem do Super Chat comprada por um fã durante uma transmissão ao vivo do 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 mostrador por um período determinado.

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

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

Método Solicitação HTTP Descrição
URIs relativos 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 fanFundingEvent representa um evento de financiamento por fãs em um canal do YouTube. O financiamento por fãs é uma forma de apoiar financeiramente 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 para um canal. Acesse a Central de Ajuda do YouTube para saber mais sobre o financiamento por fãs.

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

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

LiveCuepoints

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

Observação:o comando da API para controlar os pontos de inserção faz parte da API Content ID do YouTube e tem requisitos de autorização diferentes dos pedidos para gerenciar recursos liveBroadcast e liveStream.

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

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/
insert POST /liveCuepoints Insere um ponto de referência em uma transmissão ao vivo. No momento, as solicitações para esse método precisam ser autorizadas por uma conta associada a um proprietário do conteúdo do YouTube.

Patrocinadores

Um recurso sponsor representa um patrocinador de um canal do YouTube. Um patrocinador oferece suporte financeiro recorrente, como uma taxa de assinatura ou de associação, a um criador de conteúdo e recebe benefícios especiais. Por exemplo, os patrocinadores podem participar de um chat quando o criador de conteúdo ativa o modo exclusivo para patrocinadores.

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

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