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 8601YYYY-MM-DDThh:mm:ss.sZ)形式で指定します。
snippet.channelTitle string
動画が属する登録チャンネルのチャンネル タイトル。
snippet.title string
登録チャンネルのタイトル。
snippet.description string
登録チャンネルの詳細。
snippet.resourceId object
id オブジェクトには、ユーザーがチャンネル登録したチャンネルに関する情報が格納されます。
snippet.resourceId.kind string
API リソースのタイプ。
snippet.resourceId.channelId string
ユーザーの登録先チャンネルを一意に識別するために YouTube により使用される ID。
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
画像の高さ。