Esta página foi traduzida pela API Cloud Translation.

Subscriptions: list

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

Impacto da cota: uma chamada para esse método tem um custo de cota de 1 unidade.

Casos de uso comuns

Solicitação

Solicitação HTTP

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

Parâmetros

A tabela a seguir lista os parâmetros compatíveis com essa consulta. 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. Se o parâmetro identificar uma propriedade que contém propriedades filhas, elas 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 da assinatura. Se você definir `part=snippet`, a resposta da API também vai conter todas essas propriedades aninhadas. A lista a seguir contém os nomes de `part` que podem ser incluídos no valor do parâmetro: `contentDetails` `id` `snippet` `subscriberSnippet`
Filtros (especifique exatamente um dos parâmetros a seguir)
`channelId`	`string` O parâmetro `channelId` especifica um ID de canal do YouTube. A API retornará somente 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 de inscrição do YouTube.
`mine`	`boolean` Esse parâmetro só pode ser usado em uma solicitação autorizada corretamente. Defina o valor desse parâmetro como `true` para recuperar um feed das inscrições do usuário autenticado.
`myRecentSubscribers`	`boolean` Esse parâmetro só pode ser usado em uma solicitação autorizada corretamente. Defina o valor desse parâmetro como `true` para recuperar um feed dos assinantes do usuário autenticado em ordem cronológica inversa (mais recentes primeiro). O número máximo de assinantes retornados por essa API pode ser limitado.
`mySubscribers`	`boolean` Esse parâmetro só pode ser usado em uma solicitação autorizada corretamente. Defina o valor desse parâmetro como `true` para recuperar um feed dos assinantes do usuário autenticado em nenhuma ordem específica. O número máximo de assinantes retornados por essa API pode estar limitado.
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 precisam ser retornados no conjunto de resultados. Os valores aceitáveis são de `0` a `50`, inclusive. O valor padrão é `5`.
`onBehalfOfContentOwner`	`string` Observação:esse 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 está agindo 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` Esse parâmetro só pode ser usado em uma solicitação autorizada corretamente. Observação:esse 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 está sendo adicionado. Esse parâmetro é obrigatório quando uma solicitação especifica um valor para o parâmetro `onBehalfOfContentOwner` e só pode ser usado com esse parâmetro. Além disso, a solicitação precisa ser autorizada usando uma conta do CMS vinculada ao proprietário do conteúdo especificado pelo parâmetro `onBehalfOfContentOwner`. Por fim, o canal especificado pelo valor de parâmetro `onBehalfOfContentOwnerChannel` precisa estar vinculado ao proprietário do conteúdo especificado pelo parâmetro `onBehalfOfContentOwner`. Esse parâmetro é destinado a parceiros de conteúdo do YouTube que têm e gerenciam muitos canais diferentes do YouTube. 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 os seguintes: `alphabetical` – Classificar em ordem alfabética. `relevance`: classifique por relevância. `unread`: classifica 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 da solicitação

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

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta 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` Identifica o tipo de recurso da API. O valor será `youtube#subscriptionListResponse`.
`etag`	`etag` A Etag desse recurso.
`nextPageToken`	`string` O token que pode ser usado como o valor do parâmetro `pageToken` para recuperar a próxima página do conjunto de resultados.
`prevPageToken`	`string` O token que pode ser usado 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` Uma lista de assinaturas que correspondem aos critérios de solicitação.

Erros

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

Tipo de erro	Detalhe do erro	Descrição
`forbidden (403)`	`accountClosed`	As inscrições não podem ser recuperadas porque a conta do assinante está fechada.
`forbidden (403)`	`accountSuspended`	As inscrições não podem ser recuperadas porque a conta do assinante está suspensa
`forbidden (403)`	`subscriptionForbidden`	O solicitante não tem permissão para acessar as inscrições solicitadas.
`notFound (404)`	`subscriberNotFound`	O assinante identificado com a solicitação não pode ser encontrado.

Confira!

Use o APIs Explorer para chamar essa API e conferir a solicitação e a resposta da API.