Channels

Agora, a API permite 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 para crianças" desse canal ou vídeo. Os Termos de Serviço e as Políticas do desenvolvedor dos serviços da API 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 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 um conjunto de zero ou mais recursos channel que correspondem aos critérios da solicitação. Teste agora mesmo.
update
Atualiza os metadados de um canal. No momento, esse método só oferece suporte a atualizações dos objetos brandingSettings e invideoPromotion do recurso channel e das propriedades filhas deles. Teste agora mesmo.

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 de recurso da API. O valor será youtube#channel.
etag etag
A Etag desse recurso.
id string
O ID que o YouTube usa para identificar de forma exclusiva o canal.
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 ter um URL personalizado e como configurá-lo.
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 em 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 exibir miniaturas no seu aplicativo, verifique se o código usa os URLs de imagem exatamente como são retornados nas respostas da API. Por exemplo, seu aplicativo não deve usar o domínio http em vez do domínio https em um URL retornado em uma resposta da API.

Os URLs de miniaturas de canais estão disponíveis somente no domínio https, que é como os URLs aparecem nas respostas da API. Talvez você veja imagens corrompidas no seu aplicativo se ele tentar carregar imagens do YouTube do domínio http. As imagens em miniatura podem ficar vazias para canais recém-criados e podem levar até um dia para serem preenchidas.
snippet.thumbnails.(key) object
As chaves-valor válidas são:
  • default – A imagem em 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 de resolução mais alta da imagem em miniatura. 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 de alta resolução da imagem em 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. Consulte a definição da propriedade snippet.thumbnails para ver outras diretrizes sobre o uso de URLs de miniaturas no seu aplicativo.
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 contém o título e a descrição do canal no idioma padrão para os 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 para o qual o texto localizado precisa ser retornado, se 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 serã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 localizada do canal.
snippet.country string
O país a que o canal está associado. Para definir o valor desta 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 playlists associadas ao canal, como vídeos enviados ou marcados com "Gostei". Você pode 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
Esta 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.

Observe que o YouTube suspendeu o uso da 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, esse valor de 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 do 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
Essa 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 algarismos significativos. Consulte o Histórico de revisões ou a Central de Ajuda do YouTube para mais detalhes sobre como as contagens de inscritos são arredondadas.
statistics.hiddenSubscriberCount boolean
Indica se a contagem de inscritos do canal é visível publicamente.
statistics.videoCount unsigned long
O número de vídeos públicos enviados para o canal. O valor reflete apenas a contagem dos vídeos públicos do canal, mesmo para os proprietários. Esse comportamento é consistente com as contagens exibidas no site do YouTube.
topicDetails object
O objeto topicDetails encapsula informações sobre temas associados ao canal.

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

Essa propriedade foi descontinuada em 10 de novembro de 2016. Eles terão suporte até 10 de novembro de 2017.

Importante:devido à descontinuação do Freebase e da API Freebase, os IDs de tópico começaram a funcionar de forma diferente a partir de 27 de fevereiro de 2017. Naquela época, o YouTube começou a retornar um pequeno conjunto de IDs de tópicos 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
É o 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 que já está 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 autorizar a solicitação de API. Acesse a Central de Ajuda do YouTube para mais informações sobre esse recurso.

Os valores válidos para essa propriedade são:
  • allowed – Este canal pode enviar vídeos com mais de 15 minutos de duração.
  • disallowed – Este canal não pode ou está qualificado para enviar vídeos com mais de 15 minutos de duração. Um canal só estará qualificado para enviar vídeos longos se estiver em situação regular com base nas diretrizes da comunidade do YouTube e não tiver bloqueios globais do Content ID no conteúdo.

    Depois que o proprietário do canal resolver os problemas que estão impedindo o canal de enviar vídeos mais longos, o canal voltará para o estado allowed ou eligible.
  • eligible – Este canal está qualificado para enviar vídeos com mais de 15 minutos de duração. No entanto, o proprietário do canal precisa ativar o recurso de envio de vídeos mais longos em https://www.youtube.com/verify. Consulte a Central de Ajuda do YouTube para informações mais detalhadas sobre esse recurso.
status.madeForKids boolean
Esse valor indica se o canal foi designado como feito para crianças e contém o status atual "conteúdo para crianças". Por exemplo, o status pode ser determinado com base no valor da propriedade selfDeclaredMadeForKids. Acesse a Central de Ajuda do YouTube para mais informações sobre como configurar o público do seu canal, vídeos ou transmissões.
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ó será retornado se o proprietário do canal autorizar a solicitação de API.
brandingSettings object
O objeto brandingSettings encapsula informações sobre a marca do canal.
brandingSettings.channel object
O objeto channel encapsula as propriedades de marca 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, que aparece na caixa de informações 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 de canal poderão ser truncadas se excederem o comprimento máximo permitido de 500 caracteres ou se contiverem aspas sem escape ("). O limite de 500 caracteres não é um limite por palavra-chave, mas um limite 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 rastrear 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 encontrar outro vídeo que destaca a atividade mais recente do canal.

Se especificado, o valor da propriedade precisa ser o ID de um vídeo público ou não listado do YouTube 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 a que o canal está associado. Atualize esta propriedade para definir o valor da propriedade snippet.country.
brandingSettings.watch object
Observação:o uso desse objeto e de todas as propriedades filhas dele foi descontinuado.

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

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

A cor do plano de fundo da área da marca da página de exibição do vídeo.
brandingSettings.watch.featuredPlaylistId string
Observação:essa propriedade foi descontinuada. Se você tentar definir o valor, a API retornará um erro.
brandingSettings.image object
Esta propriedade e todas as propriedades filhas dela foram descontinuadas.

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

O URL para a 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
Essa propriedade foi descontinuada.

O URL para a imagem do banner exibida na página do canal em apps para dispositivos móveis. A imagem tem 640 px por 175 px.
brandingSettings.image.watchIconImageUrl string
Essa 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
Essa propriedade foi descontinuada.

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

É o URL de uma imagem de banner de baixa resolução exibida na página do canal em aplicativos para tablet. O tamanho máximo da imagem é de 1.138 px por 188 px.
brandingSettings.image.bannerTabletImageUrl string
Essa propriedade foi descontinuada.

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

É o URL de uma imagem de banner de alta resolução exibida na página do canal em aplicativos para tablet. O tamanho máximo da imagem é de 2.276 px por 377 px.
brandingSettings.image.bannerTabletExtraHdImageUrl string
Essa propriedade foi descontinuada.

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

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

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

É o URL de uma imagem de banner de alta resolução exibida na página do canal em aplicativos para dispositivos móveis. O tamanho máximo da imagem é de 1.280 px por 360 px.
brandingSettings.image.bannerMobileExtraHdImageUrl string
Essa propriedade foi descontinuada.

O URL para uma imagem de banner de resolução muito alta exibida na página do canal em aplicativos para dispositivos móveis. O tamanho máximo da imagem é de 1.440 px por 395 px.
brandingSettings.image.bannerTvImageUrl string
Essa propriedade foi descontinuada.

É o URL de uma imagem de banner de resolução extra-alta exibida na página do canal em aplicativos para televisão. O tamanho máximo da imagem é de 2.120 px por 1.192 px.
brandingSettings.image.bannerTvLowImageUrl string
Essa propriedade foi descontinuada.

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

O URL de uma imagem de banner de resolução média exibida na página do canal em aplicativos para televisão. O tamanho máximo da imagem é de 1.280 px por 720 px.
brandingSettings.image.bannerTvHighImageUrl string
Essa propriedade foi descontinuada.

É o URL de uma imagem de banner de alta resolução exibida na página do canal em aplicativos para televisão. O tamanho máximo da imagem é de 1.920 px por 1.080 px.
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 para um canal.
brandingSettings.hints[] list
Esta propriedade e todas as propriedades filhas dela foram descontinuadas.

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

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

O valor da propriedade.
auditDetails object
O objeto auditDetails encapsula os dados do canal que uma rede multicanal (RM) avalia ao determinar se aceita ou rejeita um canal específico. Observe que qualquer solicitação de API que recupera 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 precisará ser revogado quando a RM decidir aceitar ou rejeitar o canal ou até duas semanas após a data de 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, o que significa que essa propriedade tem o valor true se todas as outras propriedades também tiverem o valor true. No entanto, essa propriedade vai ter um valor de false se alguma delas tiver o 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 alguma reivindicação não resolvida.
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 localizada do canal.