Channels

Agora, a API oferece suporte para marcar seu canal ou vídeos como "conteúdo para crianças". Além disso, os recursos channel e video agora também contêm uma propriedade que identifica o status "Conteúdo destinado a crianças" do canal ou vídeo. Os Termos de Serviço e as Políticas de desenvolvedor dos serviços de API do YouTube também foram atualizados em 10 de janeiro de 2020. Para mais informações, consulte os históricos de revisão do serviço da API YouTube Data e os Termos de Serviço dos serviços da API YouTube.

Um recurso channel contém informações sobre um canal do YouTube.

Métodos

A API oferece suporte aos seguintes métodos para recursos channels:

list
Retorna uma coleção de zero ou mais recursos channel que correspondem aos critérios da solicitação. Teste agora.
update
Atualiza os metadados de um canal. No momento, esse método só oferece suporte a atualizações nos objetos brandingSettings e invideoPromotion do recurso channel e nas propriedades filhas deles. Teste agora.

Representação de recurso

A estrutura JSON a seguir mostra o formato de um recurso channels:

{
  "kind": "youtube#channel",
  "etag": etag,
  "id": string,
  "snippet": {
    "title": string,
    "description": string,
    "customUrl": string,
    "publishedAt": datetime,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    },
    "defaultLanguage": string,
    "localized": {
      "title": string,
      "description": string
    },
    "country": string
  },
  "contentDetails": {
    "relatedPlaylists": {
      "likes": string,
      "favorites": string,
      "uploads": string
    }
  },
  "statistics": {
    "viewCount": unsigned long,
    "subscriberCount": unsigned long,  // this value is rounded to three significant figures
    "hiddenSubscriberCount": boolean,
    "videoCount": unsigned long
  },
  "topicDetails": {
    "topicIds": [
      string
    ],
    "topicCategories": [
      string
    ]
  },
  "status": {
    "privacyStatus": string,
    "isLinked": boolean,
    "longUploadsStatus": string,
    "madeForKids": boolean,
    "selfDeclaredMadeForKids": boolean
  },
  "brandingSettings": {
    "channel": {
      "title": string,
      "description": string,
      "keywords": string,
      "trackingAnalyticsAccountId": string,
      "unsubscribedTrailer": string,
      "defaultLanguage": string,
      "country": string
    },
    "watch": {
      "textColor": string,
      "backgroundColor": string,
      "featuredPlaylistId": string
    }
  },
  "auditDetails": {
    "overallGoodStanding": boolean,
    "communityGuidelinesGoodStanding": boolean,
    "copyrightStrikesGoodStanding": boolean,
    "contentIdClaimsGoodStanding": boolean
  },
  "contentOwnerDetails": {
    "contentOwner": string,
    "timeLinked": datetime
  },
  "localizations": {
    (key): {
      "title": string,
      "description": string
    }
  }
}

Propriedades

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

Propriedades
kind string
Identifica o tipo do recurso da API. O valor será youtube#channel.
etag etag
A Etag deste recurso.
id string
O ID que o YouTube usa para identificar o canal de forma exclusiva.
snippet object
O objeto snippet contém detalhes básicos sobre o canal, como título, descrição e imagens de miniatura.
snippet.title string
O título do canal.
snippet.description string
A descrição do canal. O valor da propriedade tem um comprimento máximo de 1.000 caracteres.
snippet.customUrl string
O URL personalizado do canal. A Central de Ajuda do YouTube explica os requisitos de qualificação para receber um URL personalizado e como configurar o URL.
snippet.publishedAt datetime
A data e a hora em que o canal foi criado. O valor é especificado no formato ISO 8601.
snippet.thumbnails object
Um mapa de imagens de miniatura associadas ao canal. Para cada objeto no mapa, a chave é o nome da imagem em miniatura, e o valor é um objeto que contém outras informações sobre a miniatura.

Ao mostrar miniaturas no seu aplicativo, verifique se o código usa os URLs de imagem exatamente como eles são retornados nas respostas da API. Por exemplo, seu aplicativo não pode usar o domínio http em vez do domínio https em um URL retornado em uma resposta da API.

Os URLs de miniaturas do canal estão disponíveis apenas no domínio https, que é como os URLs aparecem nas respostas da API. Imagens corrompidas podem aparecer no seu app se ele tentar carregar imagens do YouTube do domínio http. As imagens de miniatura podem ficar vazias em canais recém-criados e podem levar até um dia para serem preenchidas.
snippet.thumbnails.(key) object
Os valores de chave válidos são:
  • default: a imagem de miniatura padrão. A miniatura padrão para um vídeo ou um recurso que se refere a um vídeo, como um item da playlist ou o resultado da pesquisa, tem 120 px de largura e 90px de altura. A miniatura padrão de um canal tem 88 px de largura e 88 px de altura.
  • medium: uma versão da imagem em miniatura com resolução mais alta. Para um vídeo (ou um recurso que se refira a um vídeo), esta imagem tem 320 px de largura e 180 px de altura. Para um canal, esta imagem tem 240 px de largura e 240 px de altura.
  • high: uma versão em alta resolução da imagem da miniatura. Para um vídeo (ou um recurso que se refira a um vídeo), esta imagem tem 480 px de largura e 360 px de altura. Para um canal, esta imagem tem 800 px de largura e 800 px de altura.
snippet.thumbnails.(key).url string
O URL da imagem. Para mais diretrizes sobre como usar URLs de miniaturas no seu app, consulte a definição da propriedade snippet.thumbnails.
snippet.thumbnails.(key).width unsigned integer
A largura da imagem.
snippet.thumbnails.(key).height unsigned integer
A altura da imagem.
snippet.defaultLanguage string
O idioma do texto nas propriedades snippet.title e snippet.description do recurso channel.
snippet.localized object
O objeto snippet.localized contém um título e uma descrição localizados para o canal ou o título e a descrição do canal na língua padrão dos metadados do canal.
  • O texto localizado será retornado no snippet de recurso se a solicitação channels.list tiver usado o parâmetro hl para especificar um idioma em que o texto localizado será retornado, o valor do parâmetro hl identificar um idioma do aplicativo do YouTube e o texto localizado estiver disponível nesse idioma.
  • Os metadados do idioma padrão são retornados se um valor de parâmetro hl não for especificado ou se um valor for especificado, mas os metadados localizados não estiverem disponíveis para o idioma especificado.
A propriedade contém um valor somente leitura. Use o objeto localizations para adicionar, atualizar ou excluir metadados localizados.
snippet.localized.title string
O título do canal localizado.
snippet.localized.description string
A descrição do canal localizada.
snippet.country string
O país ao qual o canal está associado. Para definir o valor dessa propriedade, atualize o valor da propriedade brandingSettings.channel.country.
contentDetails object
O objeto contentDetails encapsula informações sobre o conteúdo do canal.
contentDetails.relatedPlaylists object
O objeto relatedPlaylists é um mapa que identifica as playlists associadas ao canal, como os vídeos enviados ou marcados com "Gostei". É possível recuperar qualquer uma dessas playlists usando o método playlists.list.
contentDetails.relatedPlaylists.likes string
O ID da playlist que contém os vídeos marcados com "Gostei" do canal. Use os métodos playlistItems.insert e playlistItems.delete para adicionar ou remover itens dessa lista.
contentDetails.relatedPlaylists.favorites string
Essa propriedade foi descontinuada.

O ID da playlist que contém os vídeos favoritos do canal. Use os métodos playlistItems.insert e playlistItems.delete para adicionar ou remover itens dessa lista.

O YouTube desativou a funcionalidade de vídeos favoritos. Por exemplo, a propriedade statistics.favoriteCount do recurso video foi descontinuada em 28 de agosto de 2015. Como resultado, por motivos históricos, o valor da propriedade pode conter um ID de playlist que se refere a uma playlist vazia e, portanto, não pode ser buscado.
contentDetails.relatedPlaylists.uploads string
O ID da playlist que contém os vídeos enviados pelo canal. Use o método videos.insert para enviar novos vídeos e o método videos.delete para excluir vídeos enviados anteriormente.
statistics object
O objeto statistics encapsula as estatísticas do canal.
statistics.viewCount unsigned long
O número de vezes que o canal foi visualizado.
statistics.commentCount unsigned long
Esta propriedade foi descontinuada.

O número de comentários do canal.
statistics.subscriberCount unsigned long
O número de inscritos do canal. Esse valor é arredondado para três casas decimais. Para mais detalhes sobre como as contagens de inscritos são arredondadas, consulte a Histórico de revisões ou a Central de Ajuda do YouTube.
statistics.hiddenSubscriberCount boolean
Indica se a contagem de inscritos do canal está visível publicamente.
statistics.videoCount unsigned long
O número de vídeos públicos enviados para o canal. O valor reflete a contagem de vídeos públicos do canal, mesmo para os proprietários. Esse comportamento é consistente com as contagens mostradas no site do YouTube.
topicDetails object
O objeto topicDetails encapsula informações sobre os temas associados ao canal.

Importante:para mais detalhes sobre as mudanças relacionadas aos IDs de tópico, consulte a definição da propriedade topicDetails.topicIds[] e o histórico de revisões.
topicDetails.topicIds[] list
Uma lista de IDs de tópicos associados ao canal.

Essa propriedade foi descontinuada em 10 de novembro de 2016. O suporte vai ser mantido até 10 de novembro de 2017.

Importante:devido à descontinuação do Freebase e da API do Freebase, os IDs de tópicos começaram a funcionar de maneira diferente a partir de 27 de fevereiro de 2017. Naquela época, o YouTube começou a retornar um pequeno conjunto de IDs de temas selecionados.
topicDetails.topicCategories[] list
Uma lista de URLs da Wikipédia que descrevem o conteúdo do canal.
status object
O objeto status encapsula informações sobre o status de privacidade do canal.
status.privacyStatus string
Status de privacidade do canal.

Os valores válidos para essa propriedade são:
  • private
  • public
  • unlisted
status.isLinked boolean
Indica se os dados do canal identificam um usuário já vinculado a um nome de usuário do YouTube ou a uma conta do Google+. Um usuário que tenha um desses links já tem uma identidade pública do YouTube, que é um pré-requisito para várias ações, como enviar vídeos.
status.longUploadsStatus string
Indica se o canal está qualificado para enviar vídeos com mais de 15 minutos. Essa propriedade só é retornada se o proprietário do canal autorizou a solicitação da API. Para mais informações sobre esse recurso, acesse a Central de Ajuda do YouTube.

Os valores válidos para essa propriedade são:
  • allowed: esse canal pode enviar vídeos com mais de 15 minutos.
  • disallowed: este canal não pode enviar vídeos com mais de 15 minutos. Um canal só pode enviar vídeos mais longos se estiver em dia com as diretrizes da comunidade do YouTube e não tiver nenhum bloqueio do Content ID em todo o mundo.

    Depois que o proprietário do canal resolver os problemas que estão impedindo o envio de vídeos mais longos, o canal vai voltar ao estado allowed ou eligible.
  • eligible: esse canal pode enviar vídeos com mais de 15 minutos. No entanto, o proprietário do canal precisa ativar a opção de enviar vídeos mais longos pela verificação por telefone. Para mais detalhes sobre esse recurso, acesse a Central de Ajuda do YouTube.
status.madeForKids boolean
Esse valor indica se o canal é destinado a crianças e contém o status "conteúdo para crianças" atual do canal. Por exemplo, o status pode ser determinado com base no valor da propriedade selfDeclaredMadeForKids. Para mais informações sobre como definir o público do seu canal, vídeos ou transmissões, consulte a Central de Ajuda do YouTube .
status.selfDeclaredMadeForKids boolean
Em uma solicitação channels.update, essa propriedade permite que o proprietário do canal designe o canal como direcionado a crianças. O valor da propriedade só é retornado se o proprietário do canal tiver autorizado a solicitação da API.
brandingSettings object
O objeto brandingSettings encapsula informações sobre o branding do canal.
brandingSettings.channel object
O objeto channel encapsula as propriedades de branding da página do canal.
brandingSettings.channel.title string
O título do canal. O título deve ter no máximo 30 caracteres.
brandingSettings.channel.description string
A descrição do canal, que aparece na caixa de informações do canal na página do canal. O valor da propriedade tem um comprimento máximo de 1.000 caracteres.
brandingSettings.channel.keywords string
Palavras-chave associadas ao seu canal. O valor é uma lista de strings separadas por espaços. As palavras-chave do canal podem ser truncadas se excederem o comprimento máximo permitido de 500 caracteres ou se contiverem aspas não codificadas ("). O limite de 500 caracteres não é por palavra-chave, mas sim no comprimento total de todas as palavras-chave.
brandingSettings.channel.trackingAnalyticsAccountId string
O ID de uma conta do Google Analytics que você quer usar para acompanhar e medir o tráfego do seu canal.
brandingSettings.channel.unsubscribedTrailer string
O vídeo que será reproduzido no módulo de vídeo em destaque na visualização de navegação da página do canal para espectadores não inscritos. Os espectadores inscritos podem assistir um vídeo diferente que destaca as atividades mais recentes do canal.

Se especificado, o valor da propriedade precisa ser o ID do vídeo do YouTube de um vídeo público ou não listado que pertence ao proprietário do canal.
brandingSettings.channel.defaultLanguage string
O idioma do texto nas propriedades snippet.title e snippet.description do recurso channel.
brandingSettings.channel.country string
O país ao qual o canal está associado. Atualize essa propriedade para definir o valor da propriedade snippet.country.
brandingSettings.watch object
Observação:esse objeto e todas as propriedades filhas dele foram descontinuados.

O objeto watch encapsula as propriedades de branding das páginas de exibição dos vídeos do canal.
brandingSettings.watch.textColor string
Observação:essa propriedade foi descontinuada.

A cor do texto da área de marca da página de exibição do vídeo.
brandingSettings.watch.backgroundColor string
Observação:essa propriedade foi descontinuada.

A cor de fundo da área de marca da página de exibição do vídeo.
brandingSettings.watch.featuredPlaylistId string
Observação:essa propriedade foi descontinuada. A API vai retornar um erro se você tentar definir o valor dela.
brandingSettings.image object
O uso dessa propriedade e de todas as propriedades filhas dela foi descontinuado.

O objeto image encapsula informações sobre as imagens que aparecem na página do canal ou nas páginas de exibição de vídeo.
brandingSettings.image.bannerImageUrl string
Esta propriedade foi descontinuada.

O URL da imagem do banner exibida na página do canal no site do YouTube. A imagem tem 1060 px por 175 px.
brandingSettings.image.bannerMobileImageUrl string
Esta propriedade foi descontinuada.

O URL da imagem do banner mostrada na página do canal em aplicativos para dispositivos móveis. A imagem tem 640 px por 175 px.
brandingSettings.image.watchIconImageUrl string
Esta propriedade foi descontinuada.

O URL da imagem que aparece acima do player de vídeo. Esta é uma imagem de 25 pixels de altura com uma largura flexível que não pode exceder 170 pixels. Se você não fornecer esta imagem, o nome de seu canal será exibido, em vez de uma imagem.
brandingSettings.image.trackingImageUrl string
Esta propriedade foi descontinuada.

O URL de um pixel de rastreamento de 1 x 1 pixel que pode ser usado para coletar estatísticas de visualizações das páginas do canal ou do vídeo.
brandingSettings.image.bannerTabletLowImageUrl string
Esta propriedade foi descontinuada.

O URL de uma imagem de banner de baixa resolução que aparece na página do canal em aplicativos para tablet. O tamanho máximo da imagem é 1.138 x 188 pixels.
brandingSettings.image.bannerTabletImageUrl string
Esta propriedade foi descontinuada.

O URL de uma imagem de banner que aparece na página do canal em aplicativos para tablet. A imagem tem 1.707 px por 283 px.
brandingSettings.image.bannerTabletHdImageUrl string
Esta propriedade foi descontinuada.

O URL de uma imagem de banner em alta resolução que aparece na página do canal em aplicativos para tablet. O tamanho máximo da imagem é 2.276 x 377 pixels.
brandingSettings.image.bannerTabletExtraHdImageUrl string
Esta propriedade foi descontinuada.

O URL de uma imagem de banner de resolução extra-alta que aparece na página do canal em aplicativos para tablet. O tamanho máximo da imagem é 2.560 x 424 pixels.
brandingSettings.image.bannerMobileLowImageUrl string
Esta propriedade foi descontinuada.

O URL de uma imagem de banner em baixa resolução que aparece na página do canal em aplicativos para dispositivos móveis. O tamanho máximo da imagem é 320 x 88 pixels.
brandingSettings.image.bannerMobileMediumHdImageUrl string
Esta propriedade foi descontinuada.

O URL de uma imagem de banner de resolução média que aparece na página do canal em aplicativos para dispositivos móveis. O tamanho máximo da imagem é 960 x 263 pixels.
brandingSettings.image.bannerMobileHdImageUrl string
Esta propriedade foi descontinuada.

O URL de uma imagem de banner em alta resolução que aparece na página do canal em aplicativos para dispositivos móveis. O tamanho máximo da imagem é 1.280 x 360 pixels.
brandingSettings.image.bannerMobileExtraHdImageUrl string
Esta propriedade foi descontinuada.

O URL de uma imagem de banner em alta resolução que aparece na página do canal em aplicativos para dispositivos móveis. O tamanho máximo da imagem é 1.440 x 395 pixels.
brandingSettings.image.bannerTvImageUrl string
Esta propriedade foi descontinuada.

O URL de uma imagem de banner de resolução extra-alta que aparece na página do canal em aplicativos de TV. O tamanho máximo da imagem é 2.120 x 1.192 pixels.
brandingSettings.image.bannerTvLowImageUrl string
Esta propriedade foi descontinuada.

O URL de uma imagem de banner de baixa resolução que aparece na página do canal em aplicativos de TV. O tamanho máximo da imagem é 854 x 480 pixels.
brandingSettings.image.bannerTvMediumImageUrl string
Esta propriedade foi descontinuada.

O URL de uma imagem de banner de resolução média que aparece na página do canal em aplicativos de TV. O tamanho máximo da imagem é 1.280 x 720 pixels.
brandingSettings.image.bannerTvHighImageUrl string
Esta propriedade foi descontinuada.

O URL de uma imagem de banner em alta resolução que aparece na página do canal em aplicativos de TV. O tamanho máximo da imagem é 1920 x 1080 pixels.
brandingSettings.image.bannerExternalUrl string
Essa propriedade especifica o local da imagem do banner que o YouTube usa para gerar os vários tamanhos de imagem de banner de um canal.
brandingSettings.hints[] list
O uso dessa propriedade e de todas as propriedades filhas dela foi descontinuado.

O objeto hints encapsula outras propriedades de branding.
brandingSettings.hints[].property string
Esta propriedade foi descontinuada.

Uma propriedade.
brandingSettings.hints[].value string
Esta propriedade foi descontinuada.

O valor da propriedade.
auditDetails object
O objeto auditDetails encapsula os dados do canal que uma rede multicanal (RM) avaliaria ao determinar se aceita ou rejeita um canal específico. Qualquer solicitação de API que extraia essa parte do recurso precisa fornecer um token de autorização que contenha o escopo https://www.googleapis.com/auth/youtubepartner-channel-audit. Além disso, qualquer token que use esse escopo precisa ser revogado quando a MCN decidir aceitar ou rejeitar o canal ou em até duas semanas após a emissão do token.
auditDetails.overallGoodStanding boolean
Esse campo indica se há algum problema com o canal. Atualmente, esse campo representa o resultado da operação lógica AND nas propriedades communityGuidelinesGoodStanding, copyrightStrikesGoodStanding e contentIdClaimsGoodStanding. Isso significa que essa propriedade tem um valor de true se todas as outras propriedades também tiverem um valor de true. No entanto, essa propriedade terá um valor de false se qualquer uma dessas propriedades tiver um valor de false. No entanto, a metodologia usada para definir o valor dessa propriedade está sujeita a mudanças.
auditDetails.communityGuidelinesGoodStanding boolean
Indica se o canal respeita as diretrizes da comunidade do YouTube.
auditDetails.copyrightStrikesGoodStanding boolean
Indica se o canal tem avisos de direitos autorais.
auditDetails.contentIdClaimsGoodStanding boolean
Indica se o canal tem reivindicações não resolvidas.
contentOwnerDetails object
O objeto contentOwnerDetails encapsula os dados do canal que são visíveis apenas para o parceiro do YouTube que vinculou o canal ao Gerenciador de conteúdo.
contentOwnerDetails.contentOwner string
O ID do proprietário do conteúdo vinculado ao canal.
contentOwnerDetails.timeLinked datetime
A data e a hora em que o canal foi vinculado ao proprietário do conteúdo. O valor é especificado no formato ISO 8601.
localizations object
O objeto localizations encapsula as traduções dos metadados do canal.
localizations.(key) object
O idioma dos metadados localizados associados ao valor da chave. O valor é uma string que contém um código de idioma BCP-47.
localizations.(key).title string
O título do canal localizado.
localizations.(key).description string
A descrição do canal localizada.