YouTube
Visão geral
Seção intitulada “Visão geral”YouTube é uma plataforma de compartilhamento de vídeos com conteúdo gerado por usuários, transmissões ao vivo e oportunidades de monetização, amplamente utilizada para marketing, educação e entretenimento. Com a integração YouTube no SquadOS, seus agentes podem fazer upload de vídeos, gerenciar playlists, moderar comentários, consultar estatísticas de canais e interagir com transmissões ao vivo de forma automatizada.
- Site oficial: https://www.youtube.com/
- Documentação na Composio: docs.composio.dev/toolkits/youtube
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.
Você vai precisar autorizar o acesso à sua conta Google/YouTube pelo fluxo OAuth hospedado pela Composio. Nenhuma chave de API manual é necessária.
Como obter a credencial
Seção intitulada “Como obter a credencial”O YouTube usa OAuth 2.0 via conta Google. A Composio gerencia o fluxo de autorização: basta clicar em Conectar e autorizar o acesso na tela do Google.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
YouTube. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso com sua conta Google.
- Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)
Perguntas frequentes
Seção intitulada “Perguntas frequentes”Como configurar credenciais OAuth do Google personalizadas para o YouTube?
Seção intitulada “Como configurar credenciais OAuth do Google personalizadas para o YouTube?”Consulte o guia passo a passo em Como criar credenciais OAuth2 para apps Google para criar e configurar suas próprias credenciais.
Por que estou recebendo erros de cota no YouTube?
Seção intitulada “Por que estou recebendo erros de cota no YouTube?”O app OAuth padrão é compartilhado e possui limites de cota rigorosos. Para uso em produção, crie seu próprio app OAuth para obter cota dedicada.
Ações disponíveis
Seção intitulada “Ações disponíveis”Adicionar vídeo à playlist
Seção intitulada “Adicionar vídeo à playlist”YOUTUBE_ADD_VIDEO_TO_PLAYLIST
Adiciona um vídeo a uma playlist inserindo um item de playlist. Use ao organizar vídeos em playlists ou montar coleções curadas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
videoId | string | Sim | ID do vídeo do YouTube a adicionar à playlist (geralmente uma string de 11 caracteres). |
position | integer | Não | Posição (índice base zero) onde o vídeo deve ser inserido na playlist. Posição 0 é a primeira, posição 1 é a segunda etc. O valor não pode exceder o número atual de itens da playlist. Se não especificado, o vídeo é adicionado ao final. |
playlistId | string | Sim | ID da playlist à qual adicionar o vídeo. Você pode obter IDs de playlist usando a ação YOUTUBE_LIST_USER_PLAYLISTS. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Inserir seção de canal
Seção intitulada “Inserir seção de canal”YOUTUBE_CREATE_CHANNEL_SECTION
Cria uma nova seção no canal do YouTube do usuário autenticado. Use ao organizar o conteúdo do canal em seções como playlists em destaque, uploads recentes ou canais em destaque.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
snippet | object | Sim | O objeto snippet contém detalhes sobre a seção do canal, incluindo tipo, título e posição. |
contentDetails | object | Não | Detalhes do conteúdo da seção do canal. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Inserir resposta a comentário
Seção intitulada “Inserir resposta a comentário”YOUTUBE_CREATE_COMMENT_REPLY
Cria uma resposta a um comentário existente do YouTube. Use ao responder comentários de usuários ou participar de conversas em vídeos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
parentId | string | Sim | ID do comentário pai ao qual a resposta será vinculada. |
textOriginal | string | Sim | Texto da resposta. Não pode estar vazio e será publicado como resposta ao comentário pai. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar playlist
Seção intitulada “Criar playlist”YOUTUBE_CREATE_PLAYLIST
Cria uma nova playlist do YouTube no canal do usuário autenticado. Use ao organizar vídeos em coleções ou montar playlists curadas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
title | string | Sim | Título da nova playlist. Campo obrigatório. |
description | string | Não | Descrição da playlist. Fornece contexto adicional sobre o conteúdo. |
privacyStatus | string ("public" | "private" | "unlisted") | Não | Status de privacidade da playlist. public torna visível para todos, private restringe ao proprietário e usuários especificados, unlisted torna acessível por link mas não listado publicamente. Se não especificado, usa o padrão do YouTube. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir seção de canal
Seção intitulada “Excluir seção de canal”YOUTUBE_DELETE_CHANNEL_SECTION
Exclui uma seção de canal do YouTube. Use ao remover uma seção da página inicial de um canal. A seção deve existir e o usuário autenticado deve ter permissão para excluí-la.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID da seção de canal do YouTube a ser excluída. Parâmetro obrigatório. |
onBehalfOfContentOwner | string | Não | Parâmetro exclusivo para parceiros de conteúdo do YouTube. Indica que as credenciais de autorização identificam um usuário do YouTube CMS atuando em nome do proprietário de conteúdo especificado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir comentário
Seção intitulada “Excluir comentário”YOUTUBE_DELETE_COMMENT
Exclui um comentário do YouTube pertencente ao usuário ou canal autenticado. Use ao remover um comentário de um vídeo. O comentário deve existir e pertencer ao canal autenticado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID do comentário a excluir. Identificador único do recurso de comentário. O comentário deve pertencer ao usuário ou canal autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir playlist
Seção intitulada “Excluir playlist”YOUTUBE_DELETE_PLAYLIST
Exclui uma playlist do YouTube pertencente ao usuário/canal autenticado. Use ao remover permanentemente uma playlist do YouTube. Requer confirmação explícita via confirmDelete: true para evitar exclusões acidentais.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID da playlist do YouTube a ser excluída. A playlist deve pertencer ao usuário/canal autenticado. |
confirmDelete | boolean | Sim | Confirmação booleana explícita necessária para executar a exclusão. Deve ser definida como true para prosseguir. Medida de segurança para evitar exclusões acidentais. |
onBehalfOfContentOwner | string | Não | Indica que as credenciais de autorização identificam um usuário do YouTube CMS atuando em nome do proprietário de conteúdo especificado. Destinado a parceiros de conteúdo do YouTube que gerenciam múltiplos canais. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir item de playlist
Seção intitulada “Excluir item de playlist”YOUTUBE_DELETE_PLAYLIST_ITEM
Exclui um item de playlist (remove um vídeo de uma playlist). Use ao remover vídeos específicos de playlists.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID do item de playlist a ser excluído. É o identificador único de um vídeo específico dentro de uma playlist (não o ID do vídeo em si). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir vídeo
Seção intitulada “Excluir vídeo”YOUTUBE_DELETE_VIDEO
Exclui um vídeo do YouTube pertencente ao usuário/canal autenticado. Use ao remover permanentemente um vídeo do YouTube. Requer confirmação explícita via confirmDelete: true para evitar exclusões acidentais.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
videoId | string | Sim | ID do vídeo do YouTube a ser excluído (geralmente uma string de 11 caracteres). O vídeo deve pertencer ao usuário/canal autenticado. |
confirmDelete | boolean | Sim | Confirmação booleana explícita necessária para executar a exclusão. Deve ser definida como true para prosseguir. Medida de segurança para evitar exclusões acidentais. |
onBehalfOfContentOwner | string | Não | Parâmetro opcional usado por parceiros de conteúdo do YouTube para indicar que a requisição está sendo feita em nome de um proprietário de conteúdo. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter atividades do canal
Seção intitulada “Obter atividades do canal”YOUTUBE_GET_CHANNEL_ACTIVITIES
Obtém atividades recentes de um canal do YouTube, incluindo uploads de vídeos, adições a playlists, curtidas e outros eventos do canal.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
part | string | Não | Lista separada por vírgulas de propriedades do recurso de atividade a incluir (ex.: snippet, contentDetails, id). |
channelId | string | Sim | ID do canal do YouTube para recuperar as atividades. IDs de canal geralmente começam com UC. |
pageToken | string | Não | Token de paginação de uma resposta anterior para obter a próxima página de resultados. |
maxResults | integer | Não | Número máximo de atividades a retornar. |
publishedAfter | string | Não | Retornar atividades publicadas após esta data e hora (formato RFC 3339: YYYY-MM-DDTHH:MM:SSZ). |
publishedBefore | string | Não | Retornar atividades publicadas antes desta data e hora (formato RFC 3339: YYYY-MM-DDTHH:MM:SSZ). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter ID do canal pelo handle
Seção intitulada “Obter ID do canal pelo handle”YOUTUBE_GET_CHANNEL_ID_BY_HANDLE
Obtém o ID do canal do YouTube para um handle específico.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
channel_handle | string | Sim | Handle do canal do YouTube (ex.: @Google ou Google). Aceita handles com ou sem o prefixo @. Também aceita URLs completas do YouTube (ex.: https://www.youtube.com/@Google), das quais o handle será extraído automaticamente. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter estatísticas do canal
Seção intitulada “Obter estatísticas do canal”YOUTUBE_GET_CHANNEL_STATISTICS
Obtém estatísticas detalhadas de canais do YouTube, incluindo contagem de inscritos, visualizações e vídeos. Os canais podem ser identificados por ID, handle (ex.: @Google) ou nome de usuário.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Não | Lista separada por vírgulas de IDs de canal do YouTube (ex.: UCddiUEpeqJcYeBxX1IVBKvQ). A API do YouTube suporta até 50 IDs por requisição; se mais de 50 forem fornecidos, serão divididos automaticamente em lotes. Ao menos um de id, forHandle, forUsername ou mine deve ser fornecido. |
mine | boolean | Não | Definir como true para recuperar o canal do usuário autenticado. Ao menos um de id, forHandle, forUsername ou mine deve ser fornecido. Não pode ser combinado com outros parâmetros de filtro. |
part | string | Não | Lista separada por vírgulas de propriedades do recurso de canal a incluir. Use statistics para contagem de inscritos. |
forHandle | string | Não | Handle do canal do YouTube (ex.: @Google ou GoogleDevelopers). O símbolo @ é opcional. Ao menos um de id, forHandle, forUsername ou mine deve ser fornecido. |
forUsername | string | Não | Nome de usuário do YouTube para identificar o canal. Ao menos um de id, forHandle, forUsername ou mine deve ser fornecido. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Detalhes de vídeos em lote
Seção intitulada “Detalhes de vídeos em lote”YOUTUBE_GET_VIDEO_DETAILS_BATCH
Recupera múltiplas partes de recursos de vídeo do YouTube em uma única chamada em lote. Use quando precisar de métricas para muitos vídeos de uma vez para reduzir uso de cota e latência.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
hl | string | Não | Idioma para metadados localizados (snippet.localized); tag de idioma IETF, ex.: en. |
id | array | Sim | Lista de IDs de vídeo do YouTube a recuperar. Ao menos um ID é obrigatório. Aceita lista ou string separada por vírgulas. A API do YouTube limita cada requisição a 50 IDs; se mais forem fornecidos, serão divididos automaticamente em múltiplas requisições. |
parts | array | Não | Propriedades do recurso de vídeo a incluir. Padrão: ['snippet', 'statistics'] se não especificado. Valores válidos: snippet, contentDetails, statistics, status, player, topicDetails, recordingDetails, fileDetails, processingDetails, suggestions, liveStreamingDetails, localizations, paidProductPlacementDetails, id. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter avaliação de vídeo
Seção intitulada “Obter avaliação de vídeo”YOUTUBE_GET_VIDEO_RATING
Recupera as avaliações que o usuário autorizado deu a uma lista de vídeos especificados. Use quando precisar verificar se um usuário curtiu ou não curtiu vídeos específicos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | Lista separada por vírgulas de IDs de vídeo do YouTube para os quais os dados de avaliação estão sendo recuperados. IDs de vídeo geralmente são strings de 11 caracteres (ex.: dQw4w9WgXcQ). |
onBehalfOfContentOwner | string | Não | Apenas para parceiros de conteúdo do YouTube. Este parâmetro permite autenticação em nome de um proprietário de conteúdo especificado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar legendas
Seção intitulada “Listar legendas”YOUTUBE_LIST_CAPTION_TRACK
Recupera uma lista de faixas de legenda para um vídeo do YouTube. Retorna lista de itens vazia se não houver legendas disponíveis. Gera erro de execução se o ID do vídeo for inválido ou não encontrado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
part | string | Não | Lista separada por vírgulas de partes do recurso de legenda que a resposta da API incluirá. Valores válidos: id e snippet. |
video_id | string | Sim | ID do vídeo do YouTube para o qual a API deve retornar as faixas de legenda. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar seções do canal
Seção intitulada “Listar seções do canal”YOUTUBE_LIST_CHANNEL_SECTIONS
Recupera seções de canal do YouTube. Use quando precisar obter as seções de layout da página inicial de um canal. As seções organizam conteúdo em categorias como playlists, uploads ou canais em destaque.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
hl | string | Não | Parâmetro descontinuado para metadados localizados. |
id | string | Não | Lista separada por vírgulas de IDs de seção de canal a recuperar. Use exatamente um parâmetro de filtro: channelId, id ou mine. |
mine | boolean | Não | Quando true, recupera as seções de canal do usuário autenticado. Use exatamente um parâmetro de filtro. |
part | string | Sim | Lista separada por vírgulas de propriedades do recurso de seção a incluir. Valores válidos: contentDetails, id, snippet. Ao menos um deve ser especificado. |
channelId | string | Não | ID de um canal do YouTube específico (ex.: UCddiUEpeqJcYeBxX1IVBKvQ). Use exatamente um parâmetro de filtro. |
onBehalfOfContentOwner | string | Não | Apenas para parceiros de conteúdo do YouTube. Indica que as credenciais identificam um usuário do YouTube CMS atuando em nome do proprietário de conteúdo especificado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar vídeos do canal
Seção intitulada “Listar vídeos do canal”YOUTUBE_LIST_CHANNEL_VIDEOS
Lista vídeos de um canal do YouTube especificado. Usa principalmente o endpoint playlistItems.list com a playlist de uploads do canal, que é a abordagem recomendada pelo YouTube. Se a playlist de uploads retornar erro 404 (bug conhecido da API do YouTube), a ação automaticamente usa search.list como alternativa. Nota: a alternativa de busca tem custo de cota maior (100 unidades vs 1 unidade) e é limitada a 500 resultados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
mine | boolean | Não | Definir como true para listar vídeos do canal do usuário autenticado. Quando true, channelId é automaticamente definido como me. Um de channelId ou mine deve ser fornecido. |
part | string | Não | Partes do recurso de item de playlist a retornar. snippet inclui detalhes básicos do vídeo como ID, título, descrição e miniaturas. |
channelId | string | Não | Identificador do canal do YouTube (exatamente 24 caracteres para IDs UC). Aceita: ID de canal começando com UC (ex.: UC_x5XG1OV2P6uZZ5FSM9Ttw), handle começando com @ (ex.: @Google), me para o canal do usuário autenticado, ou URLs de canal do YouTube com /@handle ou /channel/UC.... |
pageToken | string | Não | Token para paginação; use nextPageToken de uma resposta anterior para a próxima página. |
maxResults | integer | Não | Número máximo de vídeos a retornar por página. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar comentários
Seção intitulada “Listar comentários”YOUTUBE_LIST_COMMENTS
Lista comentários individuais de vídeos do YouTube. Retorna detalhes do comentário incluindo autor, texto, timestamps e métricas de engajamento. Use o parâmetro id para recuperar comentários específicos ou parentId para recuperar todas as respostas a um comentário de nível superior.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Não | Lista separada por vírgulas de IDs de comentários a recuperar. Mutuamente exclusivo com parentId. |
part | string | Não | Lista separada por vírgulas de propriedades do recurso de comentário. Use snippet para detalhes completos incluindo autor, texto, contagem de curtidas e timestamps. |
parentId | string | Não | ID do comentário pai para recuperar respostas. Mutuamente exclusivo com id. |
pageToken | string | Não | Token para paginação; use nextPageToken de uma resposta anterior. |
maxResults | integer | Não | Número máximo de comentários a retornar por página. Deve estar entre 1 e 100. Incompatível com o filtro id. |
textFormat | string ("html" | "plainText") | Não | Formato para campos de texto na resposta. html preserva formatação HTML incluindo links (padrão). plainText retorna texto sem formatação. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar threads de comentários (descontinuado)
Seção intitulada “Listar threads de comentários (descontinuado)”YOUTUBE_LIST_COMMENT_THREADS
DESCONTINUADO: Use YOUTUBE_LIST_COMMENT_THREADS2 em vez desta ação. Lista threads de comentários de vídeos ou canais do YouTube para análise qualitativa. Retorna comentários de nível superior com respostas opcionais (até 5 por thread). Use o parâmetro videoId para recuperar comentários de um vídeo específico.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Não | Lista separada por vírgulas de IDs de thread de comentário a recuperar. Mutuamente exclusivo com videoId e allThreadsRelatedToChannelId. |
part | string | Não | Lista separada por vírgulas de partes do recurso commentThread. snippet inclui metadados do comentário de nível superior. replies inclui até 5 respostas. |
order | string ("time" | "relevance") | Não | Ordem de classificação para threads de comentários. time retorna os mais recentes primeiro (padrão). relevance retorna os mais relevantes primeiro. |
videoId | string | Não | Retorna threads associados ao ID de vídeo especificado. Mutuamente exclusivo com id e allThreadsRelatedToChannelId. |
pageToken | string | Não | Token para paginação; use nextPageToken de uma resposta anterior. |
maxResults | integer | Não | Número máximo de threads a retornar por página. Deve estar entre 1 e 100. |
textFormat | string ("html" | "plainText") | Não | Formato para campos de texto. html preserva formatação HTML (padrão). plainText retorna texto sem formatação. |
searchTerms | string | Não | Filtra threads para apenas aqueles que correspondem à consulta de pesquisa. Funciona apenas com allThreadsRelatedToChannelId. |
allThreadsRelatedToChannelId | string | Não | Retorna todos os threads de comentários associados ao canal especificado. Mutuamente exclusivo com videoId e id. Requer autorização OAuth. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar threads de comentários
Seção intitulada “Listar threads de comentários”YOUTUBE_LIST_COMMENT_THREADS2
Recupera threads de comentários de vídeos ou canais do YouTube correspondentes aos parâmetros da requisição. Use quando precisar buscar comentários filtrados por vídeo, canal ou IDs de thread específicos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Não | Lista separada por vírgulas de IDs de thread a recuperar. Mutuamente exclusivo com allThreadsRelatedToChannelId, channelId e videoId. |
part | string | Sim | Lista separada por vírgulas de propriedades do recurso commentThread a incluir. Mais comum: snippet,replies para dados completos do comentário. |
order | string ("relevance" | "time") | Não | Ordem de classificação. time retorna os mais recentes primeiro (padrão), relevance retorna os mais relevantes primeiro. |
videoId | string | Não | Retorna threads associados ao ID de vídeo especificado. Caso de uso mais comum. Mutuamente exclusivo com allThreadsRelatedToChannelId, channelId e id. |
channelId | string | Não | Retorna threads para o ID de canal especificado. Recupera comentários sobre o canal em si, não sobre vídeos do canal. Mutuamente exclusivo com allThreadsRelatedToChannelId, videoId e id. |
pageToken | string | Não | Token para paginação. Use nextPageToken de uma resposta anterior. |
maxResults | integer | Não | Número máximo de threads a retornar por página. Deve estar entre 1 e 100. Padrão: 20. |
textFormat | string ("html" | "plainText") | Não | Formato para campos de texto. html preserva formatação HTML (padrão), plainText retorna texto sem formatação. |
searchTerms | string | Não | Filtra threads para apenas aqueles que correspondem à consulta. Funciona apenas com allThreadsRelatedToChannelId. |
moderationStatus | string ("heldForReview" | "likelySpam" | "published") | Não | Filtra threads por status de moderação. Válido apenas para comentários nos próprios vídeos do canal quando autorizado como proprietário. |
allThreadsRelatedToChannelId | string | Não | Retorna todos os threads associados ao canal especificado. Mutuamente exclusivo com channelId, videoId e id. Requer autorização OAuth. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar idiomas de i18n
Seção intitulada “Listar idiomas de i18n”YOUTUBE_LIST_I18N_LANGUAGES
Retorna uma lista de idiomas de aplicativo suportados pelo site do YouTube. Use quando precisar recuperar todas as opções de idioma disponíveis para a interface do YouTube ou para localizar conteúdo.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
hl | string | Não | Especifica o idioma a ser usado para valores de texto na resposta da API. Padrão: en_US. Use códigos de idioma BCP-47 (ex.: en_US, es, fr, de, ja). |
part | string | Não | Define as propriedades do recurso i18nLanguage que a resposta incluirá. Defina como snippet para obter código do idioma e nome legível. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar regiões de i18n
Seção intitulada “Listar regiões de i18n”YOUTUBE_LIST_I18N_REGIONS
Recupera uma lista de regiões de conteúdo suportadas pelo site do YouTube. Retorna códigos de região (ISO 3166-1 alpha-2) e nomes de região localizados. Use quando precisar identificar regiões geográficas disponíveis para filtragem ou exibição de conteúdo.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
hl | string | Não | Código de idioma que especifica o idioma para valores de texto na resposta (ex.: en_US, es, fr). Afeta os nomes legíveis retornados. Padrão: en_US. |
part | string | Não | Define as propriedades do recurso i18nRegion que a resposta incluirá. Deve ser definido como snippet para obter código e nome da região. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar mensagens do chat ao vivo
Seção intitulada “Listar mensagens do chat ao vivo”YOUTUBE_LIST_LIVE_CHAT_MESSAGES
Lista mensagens do chat ao vivo para um chat específico. Use para monitorar o chat ao vivo durante transmissões ou recuperar histórico de chat. Retorna mensagens com detalhes do autor, timestamps e tipos de mensagem (texto, Super Chat, eventos de moderação).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
hl | string | Não | Código de idioma para exibição localizada de moeda em eventos de Super Chat. Formato BCP 47 (ex.: en, es, ja). |
part | string | Não | Lista separada por vírgulas de partes do recurso liveChatMessage a incluir. Valores válidos: id, snippet (conteúdo, tipo, timestamp), authorDetails (informações do canal do autor, badges, imagem de perfil). |
pageToken | string | Não | Token que identifica uma página específica no conjunto de resultados. Use nextPageToken de uma resposta anterior para paginação. |
liveChatId | string | Sim | ID do chat cujas mensagens serão retornadas. Deve ser obtido da propriedade snippet.liveChatId de um recurso liveBroadcast. |
maxResults | integer | Não | Número máximo de mensagens a retornar. Valores válidos: 200 a 2000. Padrão: 500. |
profileImageSize | integer | Não | Tamanho das fotos de perfil em pixels. Valores válidos: 16 a 720. Padrão: 88. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar vídeos mais populares
Seção intitulada “Listar vídeos mais populares”YOUTUBE_LIST_MOST_POPULAR_VIDEOS
DESCONTINUADO: Use YOUTUBE_UPDATE_VIDEO em vez desta ação. Lista os vídeos mais populares (charts/em alta) do YouTube para uma região e/ou categoria via videos.list(chart=mostPopular). Use quando precisar recuperar os vídeos oficialmente em alta do YouTube.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
part | string | Não | Lista separada por vírgulas de partes do recurso de vídeo a incluir. Valores válidos: id, snippet, contentDetails, statistics, status, player, topicDetails, recordingDetails, liveStreamingDetails, localizations, fileDetails, processingDetails, suggestions, paidProductPlacementDetails. |
chart | string | Não | Identifica o chart a recuperar. O único valor suportado é mostPopular. |
pageToken | string | Não | Token para paginação; use nextPageToken de uma resposta anterior. |
maxResults | integer | Não | Número máximo de itens a retornar por página. Deve estar entre 1 e 50. |
regionCode | string | Não | Código de país ISO 3166-1 alpha-2 (ex.: US, GB, JP) para seleção de chart regional. |
videoCategoryId | string | Não | ID de categoria de vídeo do YouTube para restringir o chart a uma categoria específica. IDs conhecidos que funcionam: 1 (Film & Animation), 10 (Music), 20 (Gaming), 24 (Entertainment), 25 (News & Politics), 28 (Science & Technology). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar imagens de playlist
Seção intitulada “Listar imagens de playlist”YOUTUBE_LIST_PLAYLIST_IMAGES
Recupera imagens de playlist associadas a uma playlist específica. Use ao buscar imagens de miniatura personalizadas para playlists.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Não | IDs de imagem de playlist separados por vírgulas a recuperar. Deve especificar id ou parent. |
part | string | Não | Lista separada por vírgulas de propriedades do recurso playlistImage. Valor válido: snippet. |
parent | string | Não | ID único da playlist para a qual recuperar imagens. Deve especificar id ou parent. |
pageToken | string | Não | Token para paginação; use nextPageToken de uma resposta anterior. |
maxResults | integer | Não | Número máximo de imagens a retornar. Deve estar entre 0 e 50. |
onBehalfOfContentOwner | string | Não | Apenas para parceiros de conteúdo do YouTube. Identifica um usuário CMS atuando em nome de um proprietário de conteúdo. |
onBehalfOfContentOwnerChannel | string | Não | Apenas para parceiros de conteúdo do YouTube. Especifica o ID do canal do YouTube para a requisição. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar itens de playlist
Seção intitulada “Listar itens de playlist”YOUTUBE_LIST_PLAYLIST_ITEMS
Lista vídeos em uma playlist com suporte a paginação. Use ao percorrer a playlist de uploads de um canal para enumerar todos os vídeos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
part | string | Não | Lista separada por vírgulas de partes do recurso playlistItem a incluir. Valores válidos: snippet, contentDetails, id, status. |
fields | string | Não | Seletor especificando quais campos incluir em uma resposta parcial. |
videoId | string | Não | Filtra resultados para apenas aqueles que contêm o ID de vídeo especificado. |
pageToken | string | Não | Token para a página de resultados a recuperar, obtido de uma chamada anterior via nextPageToken. |
maxResults | integer | Não | Número máximo de itens a retornar por página. Deve estar entre 0 e 50. |
playlistId | string | Sim | ID único da playlist. Formatos comuns: PL... para playlists criadas pelo usuário, UU... para uploads do canal (derivado do ID do canal substituindo UC por UU). Não passe IDs de canal (começando com UC) diretamente. |
onBehalfOfContentOwner | string | Não | Para parceiros de conteúdo do YouTube. Autorize usando uma conta com escopo adequado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar eventos de Super Chat
Seção intitulada “Listar eventos de Super Chat”YOUTUBE_LIST_SUPER_CHAT_EVENTS
Lista eventos de Super Chat de um canal, mostrando compras de apoiadores durante transmissões ao vivo. Retorna eventos de Super Chat e Super Sticker dos últimos 30 dias. Use para rastrear e reconhecer contribuições de apoiadores.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
hl | string | Não | Código de idioma para formatar displayString de acordo com as convenções do idioma. Use tag de idioma BCP 47 válida (ex.: en, es, ja). Padrão: en. |
part | string | Não | Lista separada por vírgulas de partes do recurso superChatEvent a incluir. Valores válidos: id (ID único do evento), snippet (metadados incluindo detalhes do apoiador, texto do comentário, valor, moeda e string de exibição). Use id,snippet para obter ambos. |
pageToken | string | Não | Token para paginação. Use nextPageToken de uma resposta anterior. |
maxResults | integer | Não | Número máximo de eventos de Super Chat a retornar por página. Deve estar entre 1 e 50. Padrão: 5. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar playlists do usuário
Seção intitulada “Listar playlists do usuário”YOUTUBE_LIST_USER_PLAYLISTS
Recupera playlists pertencentes ao usuário autenticado, usando implicitamente mine=True.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
part | string | Não | Lista separada por vírgulas de propriedades do recurso de playlist a incluir. Valores comuns: snippet, id, contentDetails. |
pageToken | string | Não | Token para paginação para recuperar uma página específica de resultados. |
maxResults | integer | Não | Número máximo de playlists a retornar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar inscrições do usuário
Seção intitulada “Listar inscrições do usuário”YOUTUBE_LIST_USER_SUBSCRIPTIONS
Recupera as inscrições em canais do YouTube do usuário autenticado, permitindo especificação de partes da resposta e paginação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
part | string | Não | Partes do recurso de inscrição a incluir, separadas por vírgula. Valores válidos: id, snippet, contentDetails, subscriberSnippet. |
pageToken | string | Não | Token para uma página específica de resultados, obtido de uma resposta anterior. Omita na primeira página. |
maxResults | integer | Não | Número máximo de itens de inscrição a retornar por página. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar motivos de denúncia de abuso de vídeo
Seção intitulada “Listar motivos de denúncia de abuso de vídeo”YOUTUBE_LIST_VIDEO_ABUSE_REPORT_REASONS
Recupera uma lista de motivos de denúncia de abuso que podem ser usados para denunciar vídeos abusivos no YouTube. Use quando precisar exibir as categorias de denúncia disponíveis ou antes de chamar videos.reportAbuse. Retorna rótulos de motivo localizados e categorizações secundárias opcionais.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
hl | string | Não | Código de idioma para texto exibido na resposta da API (formato BCP-47, ex.: en_US, fr_FR, ja_JP). Padrão: en_US. |
part | string | Não | Lista separada por vírgulas de partes do recurso videoAbuseReportReason. Valores válidos: id (ID único do motivo) e snippet (texto de rótulo localizado e motivos secundários). Use snippet para obter descrições legíveis. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar categorias de vídeo
Seção intitulada “Listar categorias de vídeo”YOUTUBE_LIST_VIDEO_CATEGORIES
Lista categorias de vídeo do YouTube que podem ser associadas a vídeos. Use quando precisar recuperar categorias disponíveis para uma região específica ou obter detalhes sobre IDs de categoria específicos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
hl | string | Não | Código de idioma para valores de texto na resposta (ex.: en_US, es_ES). Padrão: en_US. |
id | string | Não | Lista separada por vírgulas de IDs de categoria de vídeo a recuperar. Retorna apenas as categorias especificadas. |
part | string | Não | Propriedades do recurso videoCategory que a resposta incluirá. Defina como snippet. |
regionCode | string | Não | Código de país ISO 3166-1 alpha-2 (ex.: US, GB, JP) para retornar categorias disponíveis naquela região. id ou regionCode deve ser especificado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Baixar faixa de legenda do YouTube
Seção intitulada “Baixar faixa de legenda do YouTube”YOUTUBE_LOAD_CAPTIONS
Baixa uma faixa de legenda específica do YouTube, que deve pertencer ao usuário autenticado, e retorna seu conteúdo como texto. Nota: Esta ação requer que você seja o proprietário do vídeo (restrição da YouTube Data API v3). Vídeos de outros usuários retornarão erros 403 Forbidden.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID único da faixa de legenda atribuído pelo YouTube. Este NÃO é o ID do vídeo. Para obter este ID, chame primeiro YOUTUBE_LIST_CAPTION_TRACK com um video_id para obter a lista de faixas disponíveis. |
tfmt | string | Não | Formato desejado para a faixa de legenda. Formatos suportados: srt (SubRip), sbv (SubViewer), vtt (WebVTT). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Marcar comentário como spam
Seção intitulada “Marcar comentário como spam”YOUTUBE_MARK_COMMENT_AS_SPAM
Marca um ou mais comentários do YouTube como spam. Use ao moderar comentários para sinalizar conteúdo indesejado. Nota: Este endpoint está descontinuado, mas ainda funciona conforme a documentação da API do YouTube.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | Lista separada por vírgulas de IDs de comentários a marcar como spam. Cada ID deve ser um ID de comentário válido do YouTube. Múltiplos IDs podem ser marcados em uma única requisição. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Upload de vídeo multipart
Seção intitulada “Upload de vídeo multipart”YOUTUBE_MULTIPART_UPLOAD_VIDEO
Faz upload de um vídeo para o YouTube usando upload multipart em uma única requisição. Use quando quiser fazer upload dos metadados e do arquivo de vídeo juntos. Esta ação envia o arquivo de vídeo e os metadados em uma única requisição, diferente do upload retomável que requer dois passos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tags | array | Não | Lista de tags de palavras-chave (strings) para o vídeo, usadas para melhorar a descoberta. |
title | string | Sim | Título do vídeo. |
videoFile | object | Sim | Arquivo de vídeo para fazer upload no YouTube. |
categoryId | string | Sim | ID de categoria do YouTube (ex.: 22 para People & Blogs). Pode ser fornecido como string ou inteiro. |
description | string | Sim | Descrição detalhada do conteúdo do vídeo. |
privacyStatus | string | Sim | Status de privacidade: public, private (apenas para o uploader/usuários especificados), ou unlisted (acessível por link, não listado publicamente). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Publicar comentário em vídeo
Seção intitulada “Publicar comentário em vídeo”YOUTUBE_POST_COMMENT
Publica um novo comentário de nível superior em um vídeo do YouTube. Use ao criar comentários para engajar com conteúdo de vídeo.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
videoId | string | Sim | ID do vídeo no qual comentar. Obrigatório para criar um comentário de nível superior. |
channelId | string | Sim | ID do canal que fez o upload do vídeo. Obrigatório para criar comentários. |
textOriginal | string | Sim | Texto do comentário. Esta é a mensagem real que será publicada no vídeo. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Avaliar vídeo
Seção intitulada “Avaliar vídeo”YOUTUBE_RATE_VIDEO
Adiciona uma avaliação de curtida ou não-curtida a um vídeo do YouTube, ou remove uma avaliação existente. Use quando precisar avaliar vídeos em nome do usuário autenticado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID do vídeo do YouTube a avaliar ou remover avaliação (geralmente uma string de 11 caracteres como dQw4w9WgXcQ). |
rating | string ("like" | "dislike" | "none") | Sim | Avaliação a aplicar ao vídeo. Use like para aprovar, dislike para desaprovar, ou none para remover qualquer avaliação existente. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Denunciar vídeo por abuso
Seção intitulada “Denunciar vídeo por abuso”YOUTUBE_REPORT_VIDEO_ABUSE
Denuncia um vídeo do YouTube por conter conteúdo abusivo. Use quando precisar sinalizar vídeos que violam as diretrizes da comunidade do YouTube ou contêm conteúdo prejudicial.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
videoId | string | Sim | Identifica o vídeo que está sendo denunciado. Defina o valor como o ID do vídeo do YouTube (geralmente uma string de 11 caracteres). |
comments | string | Não | Informações adicionais que o denunciante deseja adicionar. |
language | string | Não | Identifica um idioma falado pelo denunciante (ex.: en para inglês, es para espanhol). |
reasonId | string ("N" | "V" | "C" | "M" | "E" | "H") | Sim | Especifica o motivo pelo qual o vídeo está sendo denunciado. Valores válidos: N (Sexo ou nudez), V (Violento, odioso ou perigoso), C (Abuso infantil), M (Desinformação médica), E (Extremismo violento), H (Assédio ou bullying). |
secondaryReasonId | string | Não | Especifica o motivo secundário. Fornece uma descrição mais específica do conteúdo objetável do que o motivo principal. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Pesquisar no YouTube
Seção intitulada “Pesquisar no YouTube”YOUTUBE_SEARCH_YOU_TUBE
Pesquisa no YouTube por vídeos, canais ou playlists usando um termo de consulta, retornando a resposta bruta da API.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
q | string | Sim | Termo de consulta de pesquisa. Suporta: texto básico (machine learning), frases exatas ("exact phrase"), exclusões (python -snake), múltiplos termos (AI OR ML), busca por canal (@channelhandle ou nome do canal). |
part | string | Não | Especifica as propriedades a incluir na resposta. Para o endpoint search.list, apenas snippet é um valor válido. O objeto id é sempre retornado automaticamente. |
type | string | Não | Restringe a pesquisa a video, channel ou playlist; separe por vírgula para múltiplos tipos (ex.: video,channel). |
order | string ("date" | "rating" | "relevance" | "title" | "videoCount" | "viewCount") | Não | Ordem de classificação para os resultados de pesquisa do YouTube. |
pageToken | string | Não | Token de paginação de uma resposta anterior via nextPageToken ou prevPageToken. |
maxResults | integer | Não | Número máximo de itens a retornar por página. |
regionCode | string | Não | Retorna resultados para vídeos visualizáveis no país especificado. Código de país ISO 3166-1 alpha-2. |
publishedAfter | string | Não | Filtra resultados para incluir apenas recursos criados após o tempo especificado. Data e hora formatadas em RFC 3339. |
publishedBefore | string | Não | Filtra resultados para incluir apenas recursos criados antes do tempo especificado. Data e hora formatadas em RFC 3339. |
relevanceLanguage | string | Não | Retorna resultados mais relevantes para o idioma especificado. Código de idioma ISO 639-1 de duas letras. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Definir status de moderação de comentário
Seção intitulada “Definir status de moderação de comentário”YOUTUBE_SET_COMMENT_MODERATION_STATUS
Define o status de moderação de um ou mais comentários do YouTube. Use ao moderar comentários para colocá-los em revisão, publicá-los ou rejeitá-los. Opcionalmente, bane o autor do comentário ao rejeitar.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | Lista separada por vírgulas de IDs que identificam os comentários para os quais o status de moderação está sendo atualizado. São IDs de comentários, não IDs de thread. |
banAuthor | boolean | Não | Se true, o autor do comentário é adicionado à lista de banidos. Este parâmetro só é válido quando moderationStatus é rejected. Padrão: false. |
moderationStatus | string ("heldForReview" | "published" | "rejected") | Sim | Identifica o novo status de moderação dos comentários especificados. heldForReview coloca em revisão, published torna visível, rejected remove da visualização pública. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Inscrever-se em canal
Seção intitulada “Inscrever-se em canal”YOUTUBE_SUBSCRIBE_CHANNEL
Inscreve o usuário autenticado em um canal do YouTube especificado, identificado pelo seu channelId único que deve ser válido e existente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
channelId | string | Sim | Identificador único (ID) do canal do YouTube em que se inscrever (geralmente começa com UC). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Cancelar inscrição em canal
Seção intitulada “Cancelar inscrição em canal”YOUTUBE_UNSUBSCRIBE_CHANNEL
Cancela a inscrição do usuário autenticado em um canal do YouTube excluindo uma inscrição. Use quando precisar remover uma inscrição existente. O ID de inscrição pode ser obtido com a ferramenta YOUTUBE_LIST_USER_SUBSCRIPTIONS.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
subscriptionId | string | Sim | ID único da inscrição a excluir. Este ID pode ser obtido com a ferramenta YOUTUBE_LIST_USER_SUBSCRIPTIONS. A inscrição deve pertencer ao usuário autenticado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar faixa de legenda
Seção intitulada “Atualizar faixa de legenda”YOUTUBE_UPDATE_CAPTION
Atualiza os metadados de uma faixa de legenda do YouTube, como nome, idioma ou status de rascunho. Use para modificar propriedades de faixas de legenda existentes sem fazer upload de novo conteúdo. Nota: Apenas as propriedades especificadas no snippet serão atualizadas; propriedades não especificadas mantêm seus valores atuais.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID único da faixa de legenda atribuído pelo YouTube. Este NÃO é o ID do vídeo. Para obter este ID, chame YOUTUBE_LIST_CAPTION_TRACK com um video_id para obter a lista de faixas disponíveis. |
snippet | object | Sim | Objeto snippet contendo as propriedades de legenda a atualizar. Apenas os campos especificados serão atualizados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar canal
Seção intitulada “Atualizar canal”YOUTUBE_UPDATE_CHANNEL
Atualiza os metadados de um canal, incluindo configurações de branding e localizações. Apenas as propriedades brandingSettings, invideoPromotion e localizations podem ser atualizadas. Requer que o canal pertença ao usuário autenticado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID do canal a ser atualizado. Identificador único do canal do YouTube que geralmente começa com UC. |
part | string | Não | Lista separada por vírgulas de propriedades do canal a atualizar. Deve incluir ao menos um de: brandingSettings, invideoPromotion ou localizations. |
localizations | object | Não | Metadados traduzidos para o canal, indexados por código de idioma BCP-47 (ex.: es para espanhol, fr para francês). |
brandingSettings | object | Não | Contêiner para configurações de branding do canal. |
invideoPromotion | object | Não | O objeto invideoPromotion encapsula informações sobre uma campanha promocional associada ao canal. |
onBehalfOfContentOwner | string | Não | Apenas para requisições autorizadas. Permite que parceiros de conteúdo ajam em nome do proprietário do canal especificado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar seção de canal
Seção intitulada “Atualizar seção de canal”YOUTUBE_UPDATE_CHANNEL_SECTION
Atualiza uma seção de canal do YouTube existente pelo ID. Use ao modificar propriedades de seção como título, posição ou conteúdo em destaque.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID que o YouTube usa para identificar exclusivamente a seção do canal a atualizar. Campo obrigatório. |
snippet | object | Não | Detalhes do snippet para a atualização da seção do canal. |
contentDetails | object | Não | Detalhes do conteúdo para a seção do canal. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar comentário
Seção intitulada “Atualizar comentário”YOUTUBE_UPDATE_COMMENT
Modifica o texto de um comentário existente do YouTube. Use ao atualizar ou corrigir um comentário publicado anteriormente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID único do comentário a atualizar. Identifica qual comentário específico deve ser modificado. |
textOriginal | string | Sim | Novo conteúdo de texto para o comentário. Substituirá o texto existente do comentário. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar playlist
Seção intitulada “Atualizar playlist”YOUTUBE_UPDATE_PLAYLIST
Modifica os metadados de uma playlist existente do YouTube (título, descrição, status de privacidade). Use ao atualizar informações de playlist do canal do usuário autenticado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID único da playlist no YouTube. Identifica qual playlist atualizar. |
part | string | Não | Lista separada por vírgulas de propriedades do recurso de playlist que a resposta incluirá. Valores válidos: contentDetails, id, localizations, player, snippet, status. |
status | object | Não | Informações sobre o status de privacidade e podcast da playlist. |
snippet | object | Sim | O objeto snippet contém detalhes básicos da playlist, incluindo título e descrição. O título é obrigatório. |
onBehalfOfContentOwner | string | Não | Destinado exclusivamente a parceiros de conteúdo do YouTube. Indica que as credenciais de autorização identificam um usuário do YouTube CMS atuando em nome do proprietário de conteúdo especificado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar item de playlist
Seção intitulada “Atualizar item de playlist”YOUTUBE_UPDATE_PLAYLIST_ITEM
Modifica as propriedades de um item de playlist, como posição ou nota. Use ao reordenar vídeos em uma playlist ou atualizar metadados do item.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID do item de playlist a atualizar. Identificador único do recurso de item de playlist. |
part | string | Não | Lista separada por vírgulas de propriedades do playlistItem a incluir na resposta. Valores válidos: id, snippet, contentDetails, status. Propriedades incluídas no part terão seus valores existentes substituídos. |
status | object | Não | Objeto de status para atualizar privacidade do item de playlist. |
snippet | object | Sim | O objeto snippet contém detalhes básicos modificáveis do item de playlist. |
contentDetails | object | Não | Detalhes de conteúdo contendo propriedades adicionais modificáveis. |
onBehalfOfContentOwner | string | Não | Apenas para parceiros de conteúdo do YouTube. Indica o proprietário de conteúdo em nome de quem a requisição está sendo feita. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar miniatura
Seção intitulada “Atualizar miniatura”YOUTUBE_UPDATE_THUMBNAIL
Define a miniatura personalizada de um vídeo do YouTube usando uma imagem de uma URL. Requisitos: o usuário autenticado deve ser proprietário do vídeo ou ter permissão para editá-lo; o canal do YouTube deve estar verificado (verificação por telefone obrigatória) para fazer upload de miniaturas personalizadas; a imagem deve ser JPG, PNG ou GIF; menor que 2 MB; resolução recomendada de 1280x720 (proporção 16:9).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
videoId | string | Sim | Identificador do vídeo do YouTube para o qual atualizar a miniatura. |
thumbnailUrl | string | Sim | URL acessível publicamente da nova imagem de miniatura. Deve ser JPG, GIF ou PNG; menor que 2 MB. Recomendado: proporção 16:9, resolução 1280x720 (largura mínima de 640px). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar vídeo
Seção intitulada “Atualizar vídeo”YOUTUBE_UPDATE_VIDEO
Atualiza os metadados de um vídeo do YouTube identificado por videoId, que deve existir; uma lista vazia para tags remove todas as tags existentes.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tags | array | Não | Novas tags como lista de strings. Deve ser uma lista/array real como ['tag1', 'tag2'], NÃO uma string JSON. Substitui todas as tags existentes. Uma lista vazia remove todas as tags. Sem alteração se omitido ou None. Restrições do YouTube: colchetes angulares < > são proibidos e serão removidos automaticamente. O total de caracteres em todas as tags não pode exceder 500. |
title | string | Não | Novo título do vídeo como string. Máximo de 100 caracteres. Sem alteração se omitido ou None. |
video_id | string | Sim | ID único do vídeo no YouTube (string). Geralmente uma string alfanumérica de 11 caracteres encontrada na URL do vídeo (ex.: dQw4w9WgXcQ). |
category_id | string | Não | Novo ID de categoria do YouTube como string. Sem alteração se omitido ou None. Valores numéricos serão convertidos para strings. |
description | string | Não | Nova descrição do vídeo como string. Máximo de 5000 bytes (não caracteres). Caracteres UTF-8 multibyte como emojis (4 bytes cada) e letras acentuadas (2 bytes cada) contam mais que caracteres ASCII. Sem alteração se omitido ou None. |
privacy_status | string ("public" | "private" | "unlisted") | Não | Novo status de privacidade. Sem alteração se omitido ou None. |
composio_execution_message | string | Não | Campo interno para mensagens de execução sobre processamento de entrada. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Fazer upload de vídeo
Seção intitulada “Fazer upload de vídeo”YOUTUBE_UPLOAD_VIDEO
Faz upload de um vídeo de um caminho de arquivo local para um canal do YouTube; o arquivo de vídeo deve estar em um formato suportado pelo YouTube.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tags | array | Sim | Lista de tags de palavras-chave (strings) para o vídeo, usadas para melhorar a descoberta. |
title | string | Sim | Título do vídeo. |
categoryId | string | Sim | ID de categoria do YouTube (ex.: 22 para People & Blogs). Pode ser fornecido como string ou inteiro. Consulte a documentação da YouTube Data API para a lista completa de IDs de categoria. |
description | string | Sim | Descrição detalhada do conteúdo do vídeo, incluindo opcionalmente palavras-chave e contexto. |
privacyStatus | string ("public" | "private" | "unlisted") | Sim | Status de privacidade. |
videoFilePath | object | Sim | Arquivo de vídeo para fazer upload no YouTube. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |