Esta página foi traduzida pela API Cloud Translation.

Subscriptions

Um recurso 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 oferece suporte aos seguintes métodos para recursos subscriptions:

list: Retorna recursos de assinatura que correspondem aos critérios de solicitação da API. Faça um teste agora.
inserir: Adiciona uma inscrição ao canal do usuário autenticado. Faça um teste agora.
excluir: Exclui uma assinatura. Faça um teste agora.

Representação de recurso

A estrutura JSON a seguir 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` Identifica o tipo de recurso da API. O valor será `youtube#subscription`.
`etag`	`etag` A Etag desse recurso.
`id`	`string` O ID que o YouTube usa para identificar de forma exclusiva a inscrição.
`snippet`	`object` O objeto `snippet` contém detalhes básicos sobre a inscrição, incluindo o título e o canal em que o usuário se inscreveu.
`snippet.publishedAt`	`datetime` A data e a hora em que a assinatura foi criada. O valor é especificado no formato ISO 8601.
`snippet.channelTitle`	`string` O título do canal a que a inscrição pertence.
`snippet.title`	`string` O título da assinatura.
`snippet.description`	`string` Detalhes da assinatura.
`snippet.resourceId`	`object` O objeto `id` contém informações sobre o canal em que o usuário se inscreveu.
`snippet.resourceId.kind`	`string` O tipo de recurso da API.
`snippet.resourceId.channelId`	`string` O valor que o YouTube usa para identificar de forma exclusiva o canal em que o usuário se inscreveu.
`snippet.channelId`	`string` O ID que o YouTube usa para identificar de forma exclusiva o canal do inscrito. O objeto `resource_id` identifica o canal em que o usuário se inscreveu.
`snippet.thumbnails`	`object` Um mapa de imagens em miniatura associadas à assinatura. 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` As chaves-valor válidas são: `default` – A imagem em miniatura padrão do recurso. 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 assinatura.
`contentDetails.totalItemCount`	`unsigned integer` O número aproximado de itens para os quais a assinatura aponta.
`contentDetails.newItemCount`	`unsigned integer` É o número de novos itens na assinatura desde a última leitura do conteúdo.
`contentDetails.activityType`	`string` O tipo de atividade a que a assinatura se destina (apenas uploads, tudo). Os valores válidos para esta propriedade são: `all` `uploads`
`subscriberSnippet`	`object` O objeto `subscriberSnippet` contém detalhes básicos sobre o assinante.
`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 que o YouTube atribui para identificar de forma exclusiva o canal do inscrito.
`subscriberSnippet.thumbnails`	`object` Imagens em miniatura do canal do inscrito.
`subscriberSnippet.thumbnails.(key)`	`object` As chaves-valor válidas são: `default` – A imagem em miniatura padrão do recurso. 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.