subscription
リソースには、YouTube ユーザーのチャンネル登録に関する情報が含まれます。subscription は、新しい動画がチャンネルに追加された場合や、別のユーザーが YouTube で動画のアップロード、動画の評価、動画へのコメントといった何らかの操作を行った場合に、ユーザーに通知します。
Methods
API は、subscriptions
リソースについて次のメソッドをサポートしています。
リソース表現
次の 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.channelTitle |
string 定期購入が属するチャンネルのタイトル。 |
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 有効な Key-Value は次のとおりです。
|
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 この定期購入の対象となるアクティビティのタイプ(アップロードのみ、すべて)。 このプロパティの有効な値は次のとおりです。
|
subscriberSnippet |
object subscriberSnippet オブジェクトには、サブスクライバーに関する基本情報が含まれます。 |
subscriberSnippet.title |
string チャンネル登録者のチャンネルのタイトル。 |
subscriberSnippet.description |
string チャンネル登録者のチャンネルの説明。 |
subscriberSnippet.channelId |
string チャンネル登録者のチャンネルを一意に識別するために YouTube が割り当てる ID。 |
subscriberSnippet.thumbnails |
object チャンネル登録者のチャンネルのサムネイル画像。 |
subscriberSnippet.thumbnails.(key) |
object 有効な Key-Value は次のとおりです。
|
subscriberSnippet.thumbnails.(key).url |
string 画像の URL。 |
subscriberSnippet.thumbnails.(key).width |
unsigned integer 画像の幅。 |
subscriberSnippet.thumbnails.(key).height |
unsigned integer 画像の高さ。 |