Channels

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

Métodos

A API suporta os seguintes métodos para recursos channels:

list: Retorna um conjunto de zero ou mais recursos de channel que correspondem aos critérios da solicitação. Faça um teste agora.
update: Atualiza os metadados de um canal. Este método atualmente suporta apenas atualizações dos objetos brandingSettings e invideoPromotion do recurso channel e suas propriedades filho. Faça um teste agora.

Representação de recurso

A estrutura JSON abaixo mostra o formato de um recurso channels:

{
  "kind": "youtube#channel",
  "etag": etag,
  "id": string,
  "snippet": {
    "title": string,
    "description": string,
    "publishedAt": datetime,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    }
  },
  "contentDetails": {
    "relatedPlaylists": {
      "likes": string,
      "favorites": string,
      "uploads": string,
      "watchHistory": string,
      "watchLater": string
    },
    "googlePlusUserId": string
  },
  "statistics": {
    "viewCount": unsigned long,
    "commentCount": unsigned long,
    "subscriberCount": unsigned long,
    "hiddenSubscriberCount": boolean,
    "videoCount": unsigned long
  },
  "topicDetails": {
    "topicIds": [
      string
    ]
  },
  "status": {
    "privacyStatus": string,
    "isLinked": boolean
  },
  "brandingSettings": {
    "channel": {
      "title": string,
      "description": string,
      "keywords": string,
      "defaultTab": string,
      "trackingAnalyticsAccountId": string,
      "moderateComments": boolean,
      "showRelatedChannels": boolean,
      "showBrowseView": boolean,
      "featuredChannelsTitle": string,
      "featuredChannelsUrls": [
        string
      ],
      "unsubscribedTrailer": string,
      "profileColor": string
    },
    "watch": {
      "textColor": string,
      "backgroundColor": string,
      "featuredPlaylistId": string
    },
    "image": {
      "bannerImageUrl": string,
      "bannerMobileImageUrl": string,
      "backgroundImageUrl": {
        "default": string,
        "localized": [
          {
            "value": string,
            "language": string
          }
        ]
      },
      "largeBrandedBannerImageImapScript": {
        "default": string,
        "localized": [
          {
            "value": string,
            "language": string
          }
        ]
      },
      "largeBrandedBannerImageUrl": {
        "default": string,
        "localized": [
          {
            "value": string,
            "language": string
          }
        ]
      },
      "smallBrandedBannerImageImapScript": {
        "default": string,
        "localized": [
          {
            "value": string,
            "language": string
          }
        ]
      },
      "smallBrandedBannerImageUrl": {
        "default": string,
        "localized": [
          {
            "value": string,
            "language": string
          }
        ]
      },
      "watchIconImageUrl": string,
      "trackingImageUrl": string,
      "bannerTabletLowImageUrl": string,
      "bannerTabletImageUrl": string,
      "bannerTabletHdImageUrl": string,
      "bannerTabletExtraHdImageUrl": string,
      "bannerMobileLowImageUrl": string,
      "bannerMobileMediumHdImageUrl": string,
      "bannerMobileHdImageUrl": string,
      "bannerMobileExtraHdImageUrl": string,
      "bannerTvImageUrl": string,
      "bannerExternalUrl": string
    },
    "hints": [
      {
        "property": string,
        "value": string
      }
    ]
  },
  "invideoPromotion": {
    "defaultTiming": {
      "type": string,
      "offsetMs": unsigned long,
      "durationMs": unsigned long
    },
    "position": {
      "type": string,
      "cornerPosition": string
    },
    "items": [
      {
        "id": {
          "type": string,
          "videoId": string,
          "websiteUrl": string
        },
        "timing": {
          "type": string,
          "offsetMs": unsigned long,
          "durationMs": unsigned long
        },
        "customMessage": string
      }
    ]
  }
}

Propriedades

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

Propriedades
`kind`	`string` 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 seu título, sua descrição e suas imagens em miniatura.
`snippet.title`	`string` O título do canal.
`snippet.description`	`string` A descrição do canal.
`snippet.publishedAt`	`datetime` A data e a hora em que o canal foi criado. O valor é especificado no formato ISO 8601 (`YYYY-MM-DDThh:mm:ss.sZ`).
`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.
`snippet.thumbnails.(key)`	`object` Os valores de chave válidos 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.
`snippet.thumbnails.(key).width`	`unsigned integer` A largura da imagem.
`snippet.thumbnails.(key).height`	`unsigned integer` A altura da imagem.
`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 seus vídeos enviados ou favoritos. Você pode recuperar qualquer uma destas playlists utilizando o método `playlists.list`.
`contentDetails.relatedPlaylists.likes`	`string` O ID da playlist que contém os vídeos gostados do canal. Use `playlistItems.insert` e `playlistItems.delete` para adicionar ou remover itens dessa lista.
`contentDetails.relatedPlaylists.favorites`	`string` O ID da playlist que contém os vídeos favoritos do canal. Use `playlistItems.insert` e `playlistItems.delete` para adicionar ou remover itens dessa lista.
`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 `videos.delete` para excluir vídeos enviados anteriormente.
`contentDetails.relatedPlaylists.watchHistory`	`string` O ID do histórico de exibição do canal. Use `playlistItems.insert` e `playlistItems.delete` para adicionar ou remover itens dessa lista.
`contentDetails.relatedPlaylists.watchLater`	`string` O ID da playlist Assistir mais tarde do canal. Use `playlistItems.insert` e `playlistItems.delete` para adicionar ou remover itens dessa lista.
`contentDetails.googlePlusUserId`	`string` O objeto `googlePlusUserId` identifica o ID do perfil do Google+ associado a esse canal.
`statistics`	`object` O objeto `statistics` encapsula estatísticas para o canal.
`statistics.viewCount`	`unsigned long` Quantidade de visualizações do canal.
`statistics.commentCount`	`unsigned long` Quantidade de comentários do canal.
`statistics.subscriberCount`	`unsigned long` Quantidade de inscritos do canal.
`statistics.hiddenSubscriberCount`	`boolean` Indica se a contagem de inscritos do canal é visível publicamente.
`statistics.videoCount`	`unsigned long` Quantidade de vídeos enviados para o canal.
`topicDetails`	`object` O objeto `topicDetails` encapsula informações sobre tópicos Freebase associados ao canal.
`topicDetails.topicIds[]`	`list` A lista de IDs do tópico Freebase associadas ao canal. Você pode recuperar informações sobre cada tópico usando a API de tópicos Freebase.
`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 esta 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.
`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 do canal, que aparece na caixa de informações na página de seu canal.
`brandingSettings.channel.keywords`	`string` Palavras-chave associadas ao seu canal. O valor é uma lista separada por vírgulas de strings.
`brandingSettings.channel.defaultTab`	`string` A guia de conteúdo que deve ser exibida por padrão pelos usuários quando os espectadores chegam à página do canal.
`brandingSettings.channel.trackingAnalyticsAccountId`	`string` O ID de uma conta do Google Analytics que você deseja usar para acompanhar e medir o tráfego para o seu canal./0}
`brandingSettings.channel.moderateComments`	`boolean` Esta configuração determina se os comentários enviados por usuários deixados na página do canal precisam ser aprovados pelo proprietário do canal para serem visíveis publicamente. O valor padrão é `false`.
`brandingSettings.channel.showRelatedChannels`	`boolean` Esta configuração indica se o YouTube deve mostrar uma lista gerada algoritmicamente de canais disponíveis na página do canal.
`brandingSettings.channel.showBrowseView`	`boolean` Esta configuração indica se a página do canal deve exibir conteúdo em uma exibição de feed ou de navegador. Por exemplo, a exibição de navegador pode exibir seções separadas para vídeos enviados, playlists e vídeos gostados. A exibição de feed, por outro lado, mostra o feed de atividades do canal.
`brandingSettings.channel.featuredChannelsTitle`	`string` O título exibido acima do módulo de canais em destaque.
`brandingSettings.channel.featuredChannelsUrls[]`	`list` Uma lista de até 16 canais que você deseja vincular a partir do módulo de canais em destaque. O valor da propriedade é uma lista de valores de ID de canais do YouTube, cada qual identificando um canal.
`brandingSettings.channel.unsubscribedTrailer`	`string` O vídeo que deve ser reproduzido no módulo de vídeos em destaque na exibição de navegador da página do canal para espectadores não inscritos. Os espectadores inscritos podem ver uma exibição diferente, que destaca a atividade mais recente do canal.
`brandingSettings.channel.profileColor`	`string` A cor de destaque que complementa o conteúdo do canal.
`brandingSettings.watch`	`object` O objeto `watch` encapsula as propriedades de marca das páginas de exibição para os vídeos do canal.
`brandingSettings.watch.textColor`	`string` A cor de fundo para a área da marca da página de exibição de vídeos.
`brandingSettings.watch.backgroundColor`	`string` A cor do texto para a área da marca da página de exibição de vídeos.
`brandingSettings.watch.featuredPlaylistId`	`string` Um ID que identifica de forma exclusiva uma playlist exibida ao lado do player de vídeo na página de exibição de vídeos.
`brandingSettings.image`	`object` O objeto `image` encapsula informações sobre as `image`ns exibidas na página do canal ou nas páginas de exibição de vídeos.
`brandingSettings.image.bannerImageUrl`	`string` O URL para a imagem do banner mostrada na página do canal no website do YouTube. A imagem tem 1060 px por 175 px.
`brandingSettings.image.bannerMobileImageUrl`	`string` O URL para a imagem do banner mostrada na página do canal em aplicativos para celular. A imagem tem 640 px por 175 px.
`brandingSettings.image.backgroundImageUrl`	`object` O objeto `backgroundImageUrl` encapsula as configurações da imagem de fundo mostrada na página de exibição de vídeos. A imagem tem 1.200 px por 615 px, com um tamanho máximo do arquivo de 128 k.
`brandingSettings.image.backgroundImageUrl.default`	`string` O valor padrão da propriedade.
`brandingSettings.image.backgroundImageUrl.localized[]`	`list` A lista de objetos que especificam os valores específicos do idioma para a propriedade.
`brandingSettings.image.backgroundImageUrl.localized[].value`	`string` O valor da propriedade para um idioma específico.
`brandingSettings.image.backgroundImageUrl.localized[].language`	`string` O idioma associado ao valor.
`brandingSettings.image.largeBrandedBannerImageImapScript`	`object` O objeto `largeBrandedBannerImageImapScript` encapsula informações sobre o script do mapa da imagem do banner mostrada na página do canal.
`brandingSettings.image.largeBrandedBannerImageImapScript.default`	`string` O valor padrão da propriedade.
`brandingSettings.image.largeBrandedBannerImageImapScript.localized[]`	`list` A lista de objetos que especificam os valores específicos do idioma para a propriedade.
`brandingSettings.image.largeBrandedBannerImageImapScript.localized[].value`	`string` O valor da propriedade para um idioma específico.
`brandingSettings.image.largeBrandedBannerImageImapScript.localized[].language`	`string` O idioma associado ao valor.
`brandingSettings.image.largeBrandedBannerImageUrl`	`object` O URL da imagem de 854 px por 70 px que aparece abaixo do player de vídeo na exibição de vídeo expandida da página.
`brandingSettings.image.largeBrandedBannerImageUrl.default`	`string` O valor padrão da propriedade.
`brandingSettings.image.largeBrandedBannerImageUrl.localized[]`	`list` A lista de objetos que especificam os valores específicos do idioma para a propriedade.
`brandingSettings.image.largeBrandedBannerImageUrl.localized[].value`	`string` O valor da propriedade para um idioma específico.
`brandingSettings.image.largeBrandedBannerImageUrl.localized[].language`	`string` O idioma associado ao valor.
`brandingSettings.image.smallBrandedBannerImageImapScript`	`object` O script do mapa da imagem para a imagem pequena do banner. O objeto `largeBrandedBannerImageImapScript` encapsula informações sobre o script do mapa da imagem do banner mostrada na página do canal em aplicativos para celular.
`brandingSettings.image.smallBrandedBannerImageImapScript.default`	`string` O valor padrão da propriedade.
`brandingSettings.image.smallBrandedBannerImageImapScript.localized[]`	`list` A lista de objetos que especificam os valores específicos do idioma para a propriedade.
`brandingSettings.image.smallBrandedBannerImageImapScript.localized[].value`	`string` O valor da propriedade para um idioma específico.
`brandingSettings.image.smallBrandedBannerImageImapScript.localized[].language`	`string` O idioma associado ao valor.
`brandingSettings.image.smallBrandedBannerImageUrl`	`object` O URL da imagem do banner de 640 px por 70 px que aparece abaixo do player de vídeo na exibição padrão da página de exibição de vídeos.
`brandingSettings.image.smallBrandedBannerImageUrl.default`	`string` O valor padrão da propriedade.
`brandingSettings.image.smallBrandedBannerImageUrl.localized[]`	`list` A lista de objetos que especificam os valores específicos do idioma para a propriedade.
`brandingSettings.image.smallBrandedBannerImageUrl.localized[].value`	`string` O valor da propriedade para um idioma específico.
`brandingSettings.image.smallBrandedBannerImageUrl.localized[].language`	`string` O idioma associado ao valor.
`brandingSettings.image.watchIconImageUrl`	`string` 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` O URL para um pixel de rastreamento de 1 px por 1 px que pode ser usado para coletar estatísticas para exibições do canal ou de páginas do vídeo.
`brandingSettings.image.bannerTabletLowImageUrl`	`string` O URL para uma imagem de banner de baixa resolução exibida na página do canal em aplicativos de tablet. A imagem tem 1.138 px por 188 px.
`brandingSettings.image.bannerTabletImageUrl`	`string` O URL para uma imagem de banner exibida na página do canal em aplicativos de tablet. A imagem tem 1.707 px por 283 px.
`brandingSettings.image.bannerTabletHdImageUrl`	`string` O URL para uma imagem de banner de alta resolução exibida na página do canal em aplicativos de tablet. A imagem tem 2.276 px por 377 px.
`brandingSettings.image.bannerTabletExtraHdImageUrl`	`string` O URL para uma imagem de banner de resolução extremamente alta exibida na página do canal em aplicativos de tablet. A imagem tem 2.560 px por 424 px.
`brandingSettings.image.bannerMobileLowImageUrl`	`string` O URL para uma imagem de banner de baixa resolução exibida na página do canal em aplicativos para celular A imagem tem 320 px por 88 px.
`brandingSettings.image.bannerMobileMediumHdImageUrl`	`string` O URL para uma imagem de banner de média resolução exibida na página do canal em aplicativos para celular A imagem tem 960 px por 263 px.
`brandingSettings.image.bannerMobileHdImageUrl`	`string` O URL para uma imagem de banner de alta resolução exibida na página do canal em aplicativos para celular. A imagem tem 1.280 px por 360 px.
`brandingSettings.image.bannerMobileExtraHdImageUrl`	`string` O URL para uma imagem de banner de resolução muito alta exibida na página do canal em aplicativos para celular. A imagem tem 1.440 px por 395 px.
`brandingSettings.image.bannerTvImageUrl`	`string` O URL para uma imagem de banner exibida na página do canal em aplicativos de televisão. A imagem tem 2.120 px por 1.192 px.
`brandingSettings.image.bannerExternalUrl`	`string` Observação: esta propriedade só é usada em solicitações `channels.update`. Esta propriedade especifica a localização da imagem do banner que o YouTube usará para gerar os vários tamanhos de imagem de banner para um canal. Para o URL externo da imagem do banner, primeiro, é necessário enviar a imagem do banner do canal que deseja utilizar chamando o método `channelBanners.insert`.
`brandingSettings.hints[]`	`list` O objeto `hints` encapsula outras propriedades de marca.
`brandingSettings.hints[].property`	`string` Uma propriedade.
`brandingSettings.hints[].value`	`string` O valor da propriedade.
`invideoPromotion`	`object` O objeto `invideoPromotion` encapsula informações sobre a campanha promocional associada ao canal. Um canal pode usar uma campanha promocional em vídeo para exibir a imagem em miniatura de um vídeo promovido no player durante a reprodução dos vídeos do canal.
`invideoPromotion.defaultTiming`	`object` O objeto `defaultTiming` identifica as configurações de tempo padrão do canal quando um item promovido é exibido durante a reprodução de um vídeo. Essas configurações padrão podem ser substituídas por configurações `timing` mais específicas para qualquer item promovido.
`invideoPromotion.defaultTiming.type`	`string` O método de tempo que determina quando o item promovido é inserido durante a reprodução do vídeo. Se o valor for `offsetFromStart`, o campo `offsetMs` representará um deslocamento do início do vídeo. Se o valor for `offsetFromEnd`, o campo `offsetMs` representará um deslocamento do final do vídeo.
`invideoPromotion.defaultTiming.offsetMs`	`unsigned long` O ajuste de horário especificado em milissegundos que determina quando o item promovido aparece durante as reproduções do vídeo. O valor da propriedade `type` determina se o deslocamento é medido do início ou do final do vídeo.
`invideoPromotion.defaultTiming.durationMs`	`unsigned long` Define a duração em milissegundos durante a qual a promoção será exibida. Se não houver, o cliente deve usar o padrão.
`invideoPromotion.position`	`object` O objeto `position` encapsula informações sobre a posição espacial no vídeo em que o item promovido será exibido.
`invideoPromotion.position.type`	`string` A maneira na qual o item promovido é posicionado no player de vídeo. Os valores válidos para esta propriedade são: `corner`
`invideoPromotion.position.cornerPosition`	`string` O canto do player em que o item promovido aparecerá. Os valores válidos para esta propriedade são: `bottomLeft` `bottomRight` `topLeft` `topRight`
`invideoPromotion.items[]`	`list` A lista de itens promovidos na ordem em que serão exibidos em diferentes reproduções para o mesmo espectador.
`invideoPromotion.items[].id`	`object` Identifica o item promovido.
`invideoPromotion.items[].id.type`	`string` O tipo do item promovido. Os valores válidos para esta propriedade são: `video` `website`
`invideoPromotion.items[].id.videoId`	`string` Se o item promovido representar um vídeo, este valor estará presente e identificará o ID do YouTube que o YouTube atribuiu para identificar esse vídeo. Este campo só estará presente se o valor da propriedade `type` for `video`.
`invideoPromotion.items[].id.websiteUrl`	`string` Se o item promovido representar um website, este campo representará o URL que aponta para o website. Este campo estará presente somente se `type` tiver o valor `website`. Os links podem ser associados a websites, sites comerciais ou sites de redes sociais. Veja as instruções da Central de Ajuda do YouTube para websites associados e sites comerciais para mais informações sobre como ativar links para seu conteúdo. Ao adicionar links promocionais, você concorda que esses links não serão usados para redirecionar o tráfego para sites não autorizados e que eles cumprirão com as políticas do Google AdWords, as políticas de anúncios do YouTube, as Diretrizes da Comunidade do YouTube e os Termos de Serviço do YouTube.
`invideoPromotion.items[].timing`	`object` O tempo durante a reprodução de um vídeo quando o item promovido é exibido. Essas configurações de tempo substituem as configurações de tempo padrão do canal.
`invideoPromotion.items[].timing.type`	`string` O método de tempo que determina quando o item promovido é inserido durante a reprodução do vídeo. Se o valor for `offsetFromStart`, o campo `offsetMs` representará um deslocamento do início do vídeo. Se o valor for `offsetFromEnd`, o campo `offsetMs` representará um deslocamento do final do vídeo.
`invideoPromotion.items[].timing.offsetMs`	`unsigned long` O ajuste de horário especificado em milissegundos que determina quando o item promovido aparece durante as reproduções do vídeo. O valor da propriedade `type` determina se o deslocamento é medido do início ou do final do vídeo.
`invideoPromotion.items[].timing.durationMs`	`unsigned long` Define a duração em milissegundos durante a qual a promoção será exibida. Se não houver, o cliente deve usar o padrão.
`invideoPromotion.items[].customMessage`	`string` Uma mensagem personalizada a ser exibida para essa promoção. Este campo é atualmente ignorado, a menos que o item promovido seja um website.