Subscriptions: list

Retorna recursos de inscrição que correspondem a critérios da solicitação da API. Faça um teste agora.

Solicitação

Solicitação HTTP

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

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 `subscription` 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` e `contentDetails`. Se o parâmetro identifica uma propriedade que contém propriedades criança, estas serão incluídas na resposta. Por exemplo, em um recurso `subscription`, a propriedade `snippet` contém outras propriedades, como um título de exibição para a inscrição. Se você definir `part=snippet`, a resposta da API também conterá todas essas propriedades aninhadas.
Filtros (especifique exatamente um dos seguintes parâmetros)
`channelId`	`string` O parâmetro `channelId` especifica o ID de um canal do YouTube. A API retornará apenas as inscrições desse canal.
`id`	`string` O parâmetro `id` especifica uma lista separada por vírgulas dos IDs de inscrição do YouTube para os recursos que estiverem sendo recuperados. Em um recurso `subscription`, a propriedade `id` especifica o ID da inscrição.
`mine`	`boolean` Este parâmetro pode ser usado apenas em uma solicitação autorizada adequadamente. Defina o valor deste parâmetro como `true` para recuperar um feed de inscrições do usuário autenticado.
`mySubscribers`	`boolean` Este parâmetro pode ser usado apenas em uma solicitação autorizada adequadamente. Defina o valor deste parâmetro como `true` para recuperar um feed dos inscritos do usuário autenticado.
Parâmetros opcionais
`forChannelId`	`string` O parâmetro `forChannelId` especifica uma lista separada por vírgulas de IDs de canais. Dessa forma, a resposta da API conterá apenas as inscrições correspondentes a esses canais.
`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` 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.
`onBehalfOfContentOwnerChannel`	`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 `onBehalfOfContentOwnerChannel` especifica o ID do canal do YouTube ao qual um vídeo é adicionado. Este parâmetro é necessário quando uma solicitação especifica um valor para o parâmetro `onBehalfOfContentOwner` e ela só pode ser utilizada em conjunto com o referido parâmetro. Além disso, a solicitação deve ser autorizada utilizando uma conta do CMS vinculada ao proprietário do conteúdo especificado pelo parâmetro `onBehalfOfContentOwner`. Finalmente, o canal que o valor do parâmetro `onBehalfOfContentOwnerChannel` especifica deve ser vinculado ao proprietário do conteúdo especificado pelo parâmetro `onBehalfOfContentOwner`. 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 do conteúdo autentiquem uma vez e executem ações em nome do canal especificado no valor do parâmetro sem ter que fornecer credenciais de autenticação para cada canal separado.
`order`	`string` O parâmetro `order` especifica o método que será usado para classificar os recursos na resposta da API. O valor padrão é `SUBSCRIPTION_ORDER_RELEVANCE`. Os valores aceitáveis são: `alphabetical` – Classificar em ordem alfabética. `relevance` – Classificar por relevância. `unread` – Classificar por ordem de atividade.
`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#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    subscription 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#subscriptionListResponse`.
`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 inscrições que correspondem aos critérios de solicitação.

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`	`accountClosed`	As inscrições não podem ser recuperadas porque a conta do assinante está fechada.
`forbidden`	`accountSuspended`	As inscrições não podem ser recuperadas porque a conta do assinante está suspensa
`forbidden`	`subscriptionForbidden`	O solicitante não tem permissão para acessar as inscrições solicitadas.
`notFound`	`subscriberNotFound`	O assinante identificado com a solicitação 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.