Subscriptions

Um recurso de subscription contém informações sobre uma inscrição de usuário do YouTube. Uma inscrição notifica o usuário quando novos vídeos são adicionados a um canal ou quando outro usuário executa uma das várias ações no YouTube, como o upload ou a classificação de um vídeo ou comentários sobre um vídeo.

Métodos

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

list
Retorna recursos de inscrição que correspondem a critérios da solicitação da API. Faça um teste agora.
insert
Adiciona uma inscrição para o canal do usuário autenticado. Faça um teste agora.
delete
Exclui uma inscrição. Faça um teste agora.

Representação de recurso

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

{
  "kind": "youtube#subscription",
  "etag": etag,
  "id": string,
  "snippet": {
    "publishedAt": datetime,
    "channelTitle": string,
    "title": string,
    "description": string,
    "resourceId": {
      "kind": string,
      "channelId": string,
    },
    "channelId": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    }
  },
  "contentDetails": {
    "totalItemCount": unsigned integer,
    "newItemCount": unsigned integer,
    "activityType": string
  },
  "subscriberSnippet": {
    "title": string,
    "description": string,
    "channelId": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    }
  }
}

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#subscription.
etag etag
A Etag deste recurso.
id string
O ID que o YouTube usa para identificar a inscrição de forma exclusiva.
snippet object
O objeto snippet contém detalhes básicos sobre a inscrição, incluindo o seu título e o canal ao qual o usuário está inscrito.
snippet.publishedAt datetime
A data e a hora em que a inscrição foi criada. O valor é especificado no formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.channelTitle string
O título do canal ao qual a inscrição pertence.
snippet.title string
O título da inscrição.
snippet.description string
Os detalhes da inscrição.
snippet.resourceId object
O objeto id contém informações sobre o canal ao qual o usuário está inscrito.
snippet.resourceId.kind string
O tipo do recurso da API.
snippet.resourceId.channelId string
O valor que o YouTube usa para identificar o canal ao qual o usuário está inscrito de forma exclusiva.
snippet.channelId string
O ID que o YouTube usa para identificar o canal do inscrito de forma exclusiva. O objeto resource_id identifica o canal ao qual o usuário está inscrito.
snippet.thumbnails object
Um mapa de imagens em miniatura associadas à inscrição. 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 contém estatísticas básicas sobre a inscrição.
contentDetails.totalItemCount unsigned integer
O número aproximado de itens para os quais a inscrição aponta.
contentDetails.newItemCount unsigned integer
O número de novos itens na inscrição desde a última leitura de seu conteúdo.
contentDetails.activityType string
O tipo de atividade desta inscrição (apenas envios, tudo).

Os valores válidos para esta propriedade são:
  • all
  • uploads
subscriberSnippet object
O objeto subscriberSnippet contém detalhes básicos sobre o inscrito.
subscriberSnippet.title string
O título do canal do inscrito.
subscriberSnippet.description string
A descrição do canal do inscrito.
subscriberSnippet.channelId string
O ID atribuído pelo YouTube para identificar o canal do inscrito de forma exclusiva.
subscriberSnippet.thumbnails object
As imagens em miniatura para o canal do inscrito.
subscriberSnippet.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.
subscriberSnippet.thumbnails.(key).url string
O URL da imagem.
subscriberSnippet.thumbnails.(key).width unsigned integer
A largura da imagem.
subscriberSnippet.thumbnails.(key).height unsigned integer
A altura da imagem.