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.

Solicitação

Solicitação HTTP

GET https://www.googleapis.com/youtube/v3/channels

Parâmetros

A tabela a seguir lista os parâmetros que esta consulta suporta. Todos os parâmetros listados são os parâmetros de consulta.

Parâmetros
Parâmetros obrigatórios
part string
O parâmetro part especifica uma lista separada por vírgulas de uma ou mais propriedades de recurso channel que serão incluídas pela resposta da API. Os nomes part que podem ser incluídos no valor do parâmetro são id, snippet, brandingSettings, contentDetails, invideoPromotion, statistics e topicDetails.

Se o parâmetro identificar uma propriedade que contenha propriedades criança, estas serão incluídas na resposta. Por exemplo, em um recurso channel, a propriedade contentDetails contém outras propriedades, como uploads. Como tal, se você definir part=contentDetails, a resposta da API conterá todas essas propriedades.
Filtros (especifique exatamente um dos seguintes parâmetros)
categoryId string
O parâmetro categoryId especifica uma categoria de guia do YouTube, solicitando, assim, canais do YouTube associados a ela.
forUsername string
O parâmetro forUsername especifica um nome de usuário do YouTube, solicitando, assim, o canal associado a esse nome de usuário.
id string
O parâmetro id especifica uma lista separada por vírgulas dos IDs do canal do YouTube para os recursos que estiverem sendo recuperados. Em um recurso channel, a propriedade id especifica o ID do canal do YouTube.
managedByMe boolean
Este parâmetro só pode ser usado em uma solicitação autorizada adequadamente. Observação: este parâmetro é destinado exclusivamente a parceiros de conteúdo do YouTube.

Defina o valor deste parâmetro como true para instruir a API a retornar apenas os canais gerenciados pelo proprietário do conteúdo que o parâmetro onBehalfOfContentOwner especifica. O usuário deve ser autenticado como uma conta do CMS vinculada ao proprietário do conteúdo especificado, e onBehalfOfContentOwner deve ser fornecido.
mine boolean
Este parâmetro pode ser usado apenas em uma solicitação autorizada adequadamente. Defina o valor deste parâmetro como true para instruir a API a retornar apenas canais de propriedade do usuário autenticado.
mySubscribers boolean
Este parâmetro foi suspenso. Este parâmetro pode ser usado apenas em uma solicitação autorizada adequadamente. Use o método subscriptions.list e seu parâmetro mySubscribers para recuperar uma lista de inscritos para o canal do usuário autenticado.
Parâmetros opcionais
maxResults unsigned integer
O parâmetro maxResults especifica o número máximo de itens que deve ser retornado no conjunto de resultados Os valores aceitáveis são {{0/}/} a 50, inclusive. O valor padrão é 5.
onBehalfOfContentOwner string
Este parâmetro só pode ser usado em uma solicitação autorizada adequadamente. Observação: este parâmetro é destinado exclusivamente a parceiros de conteúdo do YouTube.

O parâmetro onBehalfOfContentOwner indica que as credenciais de autorização da solicitação identificam um usuário do CMS do YouTube que age em nome do proprietário do conteúdo especificado no valor do parâmetro. Este parâmetro destina-se a parceiros de conteúdo do YouTube que possuem e gerenciam vários canais do YouTube diferentes. Ele permite que os proprietários de conteúdo autentiquem uma vez e tenham acesso a todos os dados de seu canal e de seus vídeos sem ter que fornecer credenciais de autenticação para cada canal. A conta do CMS com a qual o usuário autentica deve estar vinculada ao proprietário do conteúdo do YouTube especificado.
pageToken string
O parâmetro pageToken identifica uma página específica no conjunto de resultados que será retornado. Em uma resposta da API, as propriedades nextPageToken e prevPageToken identificam outras páginas que podem ser recuperadas.

Corpo de solicitação

Não forneça um corpo de solicitação ao chamar este método.

Resposta

Se for bem-sucedido, este método retorna um corpo de resposta com a seguinte estrutura:

{
  "kind": "youtube#channelListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    channel Resource
  ]
}

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#channelListResponse.
etag etag
A Etag deste recurso.
nextPageToken string
O token que pode ser utilizado como o valor do parâmetro pageToken para recuperar a página seguinte do conjunto de resultados.
prevPageToken string
O token que pode ser utilizado como o valor do parâmetro pageToken para recuperar a página anterior do conjunto de resultados.
pageInfo object
O objeto pageInfo encapsula informações de paginação para o conjunto de resultados.
pageInfo.totalResults integer
O número total de resultados no conjunto de resultados.
pageInfo.resultsPerPage integer
O número de resultados incluídos na resposta da API.
items[] list
A lista de canais que correspondem aos critérios de solicitação.

Exemplos

Observação: os exemplos de código a seguir não representam todas as linguagens de programação suportadas. Consulte a documentação bibliotecas clientes para uma lista das linguagens suportadas.

Apps Script

This function retrieves the current script user's uploaded videos. To execute, it requires the OAuth read/write scope for YouTube as well as user authorization. In Apps Script's runtime environment, the first time a user runs a script, Apps Script will prompt the user for permission to access the services called by the script. After permissions are granted, they are cached for some periodF of time. The user running the script will be prompted for permission again once the permissions required change, or when they are invalidated by the ScriptApp.invalidateAuth() function.

This script takes the following steps to retrieve the active user's uploaded videos: 1. Fetches the user's channels 2. Fetches the user's 'uploads' playlist 3. Iterates through this playlist and logs the video IDs and titles 4. Fetches a next page token (if any). If there is one, fetches the next page. GOTO Step 3
/**
 * This function retrieves the current script user's uploaded videos. To execute,
 * it requires the OAuth read/write scope for YouTube as well as user authorization.
 * In Apps Script's runtime environment, the first time a user runs a script, Apps
 * Script will prompt the user for permission to access the services called by the
 * script. After permissions are granted, they are cached for some periodF of time.
 * The user running the script will be prompted for permission again once the
 * permissions required change, or when they are invalidated by the
 * ScriptApp.invalidateAuth() function.
 *
 * This script takes the following steps to retrieve the active user's uploaded videos:
 *    1. Fetches the user's channels
 *    2. Fetches the user's 'uploads' playlist
 *    3. Iterates through this playlist and logs the video IDs and titles
 *    4. Fetches a next page token (if any). If there is one, fetches the next page. GOTO Step 3
 */
function retrieveMyUploads() {
  var results = YouTube.Channels.list('contentDetails', {mine: true});
  for(var i in results.items) {
    var item = results.items[i];
    // Get the playlist ID, which is nested in contentDetails, as described in the
    // Channel resource: https://developers.google.com/youtube/v3/docs/channels
    var playlistId = item.contentDetails.relatedPlaylists.uploads;

    var nextPageToken = '';

    // This loop retrieves a set of playlist items and checks the nextPageToken in the
    // response to determine whether the list contains additional items. It repeats that process
    // until it has retrieved all of the items in the list.
    while (nextPageToken != null) {
      var playlistResponse = YouTube.PlaylistItems.list('snippet', {
        playlistId: playlistId,
        maxResults: 25,
        pageToken: nextPageToken
      });

      for (var j = 0; j < playlistResponse.items.length; j++) {
        var playlistItem = playlistResponse.items[j];
        Logger.log('[%s] Title: %s',
                   playlistItem.snippet.resourceId.videoId,
                   playlistItem.snippet.title);

      }
      nextPageToken = playlistResponse.nextPageToken;
    }
  }
}

Erros

A tabela abaixo identifica as mensagens de erro que a API pode retornar em resposta a uma chamada para este método. Consulte a documentação mensagem de erro para mais detalhes.

Tipo de erro Detalhe do erro Descrição
forbidden channelForbidden O canal especificado pelo parâmetro id não suporta a solicitação ou a solicitação não está apropriadamente autorizada.
notFound categoryNotFound A categoria identificada pelo parâmetro categoryId não pode ser encontrada. Use o método guideCategories.list para recuperar uma lista de valores válidos.
notFound channelNotFound O canal especificado no parâmetro id não pode ser encontrado.

Conheça agora.

Use o Explorador de API para chamar este método em dados ativos e ver a solicitação e a resposta da API.