Subscriptions

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

Methods

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
      }
    }
  }
}

プロパティ

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

プロパティ
kindstring
API リソースのタイプを識別します。値は youtube#subscription です。
etagetag
このリソースの Etag。
idstring
定期購入を一意に識別するために YouTube によって使用される ID。
snippetobject
snippet オブジェクトには、定期購入に関する基本情報(タイトル、ユーザーが登録したチャンネルなど)が格納されます。
snippet.publishedAtdatetime
サブスクリプションが作成された日時。値は ISO 8601 形式で指定します。
snippet.channelTitlestring
定期購入が属しているチャンネルのタイトル。
snippet.titlestring
定期購入のタイトル。
snippet.descriptionstring
定期購入の詳細。
snippet.resourceIdobject
id オブジェクトには、ユーザーが登録したチャンネルに関する情報が含まれます。
snippet.resourceId.kindstring
API リソースのタイプ。
snippet.resourceId.channelIdstring
ユーザーが登録したチャンネルを一意に識別するために YouTube によって使用される値。
snippet.channelIdstring
チャンネル登録者のチャンネルを一意に識別するために YouTube によって使用される ID。resource_id オブジェクトは、ユーザーが登録したチャンネルを識別します。
snippet.thumbnailsobject
定期購入に関連付けられているサムネイル画像のマップ。マップ内の各オブジェクトでは、キーはサムネイル画像の名前で、値はサムネイルに関するその他の情報を含むオブジェクトになります。
snippet.thumbnails.(key)object
有効なキー値は次のとおりです。
  • default – このリソースのデフォルトのサムネイル画像。動画(または、再生リストのアイテムや検索結果など、動画を参照するリソース)のデフォルト サムネイルは幅 120px、高さ 90px です。チャンネルのデフォルト サムネイルは幅 88px、高さ 88px です。
  • medium – 高解像度バージョンのサムネイル画像。動画(または動画を参照するリソース)の場合、この画像は幅 320px、高さ 180px です。チャンネルの場合は、幅 240px、高さ 240px です。
  • high – サムネイル画像の高解像度バージョン。動画(または動画を参照するリソース)の場合、この画像は幅 480px、高さ 360px です。チャンネルの場合、幅 800px、高さ 800px です。
snippet.thumbnails.(key).urlstring
画像の URL。
snippet.thumbnails.(key).widthunsigned integer
画像の幅。
snippet.thumbnails.(key).heightunsigned integer
画像の高さ。
contentDetailsobject
contentDetails オブジェクトには、定期購入に関する基本的な統計情報が格納されます。
contentDetails.totalItemCountunsigned integer
定期購入で参照されているアイテムのおおよその数。
contentDetails.newItemCountunsigned integer
コンテンツが最後に読み取られてから定期購入に追加された新しいアイテムの数。
contentDetails.activityTypestring
この定期購入の対象となるアクティビティのタイプ(アップロードのみ、すべて)。

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