Os exemplos a seguir mostram como usar a API de dados do YouTube (v3) para executar funções relacionadas a inscrições.
Recuperar as inscrições de um canal
Chame o método subscriptions.list
para recuperar assinaturas de um canal específico. Há duas maneiras de identificar o canal:
-
Para recuperar as assinaturas do usuário autenticado no momento, defina o valor do parâmetro
mine
comotrue
. Uma solicitação que usa o parâmetromine
precisa ser autorizada usando o OAuth 2.0.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.list? part=snippet,contentDetails &mine=true
-
Para recuperar inscrições em qualquer outro canal, defina o valor do parâmetro
channelId
como o ID exclusivo do canal do YouTube. O exemplo abaixo recupera uma lista de canais inscritos pelo canal TED no YouTube.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.list? part=snippet,contentDetails &channelId=UCAuUUnT6oDeKwE6v1NGQxug
Observação:a API retornará um código de resposta HTTP
403 (Forbidden)
se o canal especificado não expor as inscrições publicamente e a solicitação não for autorizada pelo proprietário do canal.
Consulte a documentação do método subscriptions.list
para ver exemplos de código.
Adicione uma assinatura
Chame o método subscriptions.insert
para adicionar uma inscrição de canal. Essa solicitação precisa ser autorizada usando o OAuth 2.0. O corpo da solicitação é um recurso subscription
que define os seguintes valores:
- O
snippet.resourceId.kind
contém o valoryoutube#channel
. - A propriedade
snippet.resourceId.channelId
identifica o canal que está sendo inscrito. O valor da propriedade é um ID exclusivo do canal do YouTube. O ID do canal pode ser recebido de várias maneiras, incluindo a chamada do métodochannels.list
ou a recuperação dos resultados da pesquisa para canais.
A solicitação de API abaixo inscreve você no canal do TED no YouTube:
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.insert? part=snippet
O corpo da solicitação é:
{ "snippet": { "resourceId": { "kind": "youtube#channel", "videoId": "UCAuUUnT6oDeKwE6v1NGQxug" } } }
Consulte a documentação do método subscriptions.insert
para ver exemplos de código.
Excluir uma inscrição
Este exemplo exclui uma assinatura. Essa solicitação precisa ser autorizada usando o OAuth 2.0. Este exemplo tem duas etapas:
-
Etapa 1: recuperar as assinaturas do canal do usuário autenticado
Chame o método
subscriptions.list
para recuperar a lista de assinaturas. O exemplo acima para recuperar as inscrições de um canal explica como fazer esta solicitação.O aplicativo que chama a API pode processar a resposta da API para exibir uma lista de assinaturas usando o ID de cada assinatura como chave. Na resposta, a propriedade
id
de cada item identifica o ID da assinatura que identifica de forma exclusiva a assinatura correspondente. Você usará esse valor para remover um item da lista na próxima etapa. -
Etapa 2: excluir uma assinatura
Chame o método
subscriptions.delete
para excluir uma assinatura. Defina o parâmetroid
da solicitação como o ID da assinatura que você quer remover. Essa solicitação precisa ser autorizada usando o OAuth 2.0.Para concluir a solicitação no APIs Explorer, você precisa definir o valor da propriedade
id
.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.delete? id=SUBSCRIPTION_ID
Consulte a documentação do método subscriptions.delete
para ver exemplos de código.
Recuperar uma lista de inscritos no canal do usuário autorizado
Para recuperar uma lista de canais que se inscrevem no canal do usuário autenticado no momento, chame o método subscriptions.list
e defina o valor do parâmetro mySubscribers
como true
. A solicitação precisa ser autorizada usando o OAuth 2.0.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.list? part=snippet,contentDetails &mySubscribers=true