Subscriptions

subscription リソースには、YouTube ユーザーの定期購入に関する情報が含まれます。subscription は、新しい動画がチャンネルに追加された場合や、別のユーザーが YouTube で動画のアップロード、動画の評価、動画へのコメントといった何らかの操作を行った場合に、ユーザーに通知します。

メソッド

この API は、subscriptions リソースに対して次のメソッドをサポートしています。

list
API リクエストの条件に一致するサブスクリプション リソースを返します。今すぐ試す
insert
認証済みユーザーのチャンネルのサブスクリプションを追加します。今すぐ試す
delete
定期購入を削除します。今すぐ試す

リソース表現

次の JSON 構造は、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
      }
    }
  }
}

プロパティ

次の表は、このリソースで使用されているプロパティの定義を示したものです。

プロパティ
kind string
API リソースのタイプを識別します。値は youtube#subscription になります。
etag etag
このリソースの Etag。
id string
YouTube が定期購入を一意に識別するために使用する ID。
snippet object
snippet オブジェクトには、定期購入のタイトルやユーザーが登録したチャンネルなど、定期購入に関する基本的な詳細情報が含まれます。
snippet.publishedAt datetime
サブスクリプションが作成された日時。値は ISO 8601 形式で指定します。
snippet.title string
定期購入のタイトル。
snippet.description string
サブスクリプションの詳細。
snippet.resourceId object
id オブジェクトには、ユーザーが登録したチャンネルに関する情報が含まれます。
snippet.resourceId.kind string
API リソースのタイプ。
snippet.resourceId.channelId string
ユーザーが登録したチャンネルを一意に識別するために YouTube が使用する値。
snippet.channelId string
YouTube がチャンネル登録者のチャンネルを一意に識別するために使用する ID。resource_id オブジェクトは、ユーザーが登録したチャンネルを識別します。
snippet.thumbnails object
定期購入に関連付けられたサムネイル画像のマップ。マップ内の各オブジェクトでは、キーはサムネイル画像の名前で、値はサムネイルに関するその他の情報を含むオブジェクトになります。
snippet.thumbnails.(key) object
有効なキー値は次のとおりです。
  • default - このリソースのデフォルトのサムネイル画像。動画（または、再生リストのアイテムや検索結果など、動画を参照するリソース）のデフォルト サムネイルは幅 120px、高さ 90px です。チャンネルのデフォルト サムネイルは幅 88px、高さ 88px です。
  • medium - サムネイル画像の高解像度版。動画（または動画を参照するリソース）の場合、この画像は幅 320px、高さ 180px です。チャンネルの場合は、幅 240px、高さ 240px です。
  • high - サムネイル画像の高解像度版。動画（または動画を参照するリソース）の場合、この画像は幅 480px、高さ 360px です。チャンネルの場合、幅 800px、高さ 800px です。
snippet.thumbnails.(key).url string
画像の URL。
snippet.thumbnails.(key).width unsigned integer
画像の幅。
snippet.thumbnails.(key).height unsigned integer
画像の高さ。
contentDetails object
contentDetails オブジェクトには、サブスクリプションに関する基本的な統計情報が含まれています。
contentDetails.totalItemCount unsigned integer
サブスクリプションが参照するアイテムのおおよその数。
contentDetails.newItemCount unsigned integer
コンテンツが最後に読まれたときから、定期購入の新しいアイテムの数。
contentDetails.activityType string
このサブスクリプションの対象となるアクティビティのタイプ（アップロードのみ、すべて）。

このプロパティの有効な値は次のとおりです。
  • all
  • uploads
subscriberSnippet object
subscriberSnippet オブジェクトには、サブスクライバーに関する基本情報が含まれます。
subscriberSnippet.title string
チャンネル登録者のチャンネルのタイトル。
subscriberSnippet.description string
チャンネル登録者のチャンネルの説明。
subscriberSnippet.channelId string
YouTube が割り当てる、チャンネル登録者のチャンネルを一意に識別する ID。
subscriberSnippet.thumbnails object
チャンネル登録者のチャンネルのサムネイル画像。
subscriberSnippet.thumbnails.(key) object
有効なキー値は次のとおりです。
  • default - このリソースのデフォルトのサムネイル画像。動画（または、再生リストのアイテムや検索結果など、動画を参照するリソース）のデフォルト サムネイルは幅 120px、高さ 90px です。チャンネルのデフォルト サムネイルは幅 88px、高さ 88px です。
  • medium - サムネイル画像の高解像度版。動画（または動画を参照するリソース）の場合、この画像は幅 320px、高さ 180px です。チャンネルの場合は、幅 240px、高さ 240px です。
  • high - サムネイル画像の高解像度版。動画（または動画を参照するリソース）の場合、この画像は幅 480px、高さ 360px です。チャンネルの場合、幅 800px、高さ 800px です。
subscriberSnippet.thumbnails.(key).url string
画像の URL。
subscriberSnippet.thumbnails.(key).width unsigned integer
画像の幅。
subscriberSnippet.thumbnails.(key).height unsigned integer
画像の高さ。