activity リソースには、特定のチャンネルまたはユーザーが YouTube で行ったアクションに関する情報が含まれています。アクティビティ フィードに表示される操作には、動画の評価、動画の共有、動画をお気に入りに追加、動画のアップロードなどがあります。各 activity リソースは、アクションのタイプ、アクションに関連付けられたチャンネル、アクションに関連付けられたリソース(評価またはアップロードされた動画など)を識別します。
メソッド
この API は、activities リソースに対して次のメソッドをサポートしています。
リソース表現
次の JSON 構造は、activities リソースの形式を示しています。
{
"kind": "youtube#activity",
"etag": etag,
"id": string,
"snippet": {
"publishedAt": datetime,
"channelId": string,
"title": string,
"description": string,
"thumbnails": {
(key): {
"url": string,
"width": unsigned integer,
"height": unsigned integer
}
},
"channelTitle": string,
"type": string,
"groupId": string
},
"contentDetails": {
"upload": {
"videoId": string
},
"like": {
"resourceId": {
"kind": string,
"videoId": string,
}
},
"favorite": {
"resourceId": {
"kind": string,
"videoId": string,
}
},
"comment": {
"resourceId": {
"kind": string,
"videoId": string,
"channelId": string,
}
},
"subscription": {
"resourceId": {
"kind": string,
"channelId": string,
}
},
"playlistItem": {
"resourceId": {
"kind": string,
"videoId": string,
},
"playlistId": string,
"playlistItemId": string
},
"recommendation": {
"resourceId": {
"kind": string,
"videoId": string,
"channelId": string,
},
"reason": string,
"seedResourceId": {
"kind": string,
"videoId": string,
"channelId": string,
"playlistId": string
}
},
"social": {
"type": string,
"resourceId": {
"kind": string,
"videoId": string,
"channelId": string,
"playlistId": string
},
"author": string,
"referenceUrl": string,
"imageUrl": string
},
"channelItem": {
"resourceId": {
}
},
}
}プロパティ
次の表は、このリソースで使用されているプロパティの定義を示したものです。
| プロパティ | |
|---|---|
kind |
stringAPI リソースのタイプを識別します。値は youtube#activity になります。 |
etag |
etagこのリソースの Etag。 |
id |
stringYouTube がアクティビティを一意に識別するために使用する ID。 |
snippet |
objectsnippet オブジェクトには、アクティビティのタイプやグループ ID など、アクティビティに関する基本的な詳細が含まれます。 |
snippet.publishedAt |
datetimeアクティビティが発生した日時。値は ISO 8601 形式で指定します。 |
snippet.channelId |
stringYouTube がアクティビティに関連付けられたチャンネルを一意に識別するために使用する ID。 |
snippet.title |
stringアクティビティに主に関連付けられているリソースのタイトル。 |
snippet.description |
stringアクティビティに主に関連付けられているリソースの説明。 |
snippet.thumbnails |
objectアクティビティに主に関連付けられているリソースに関連付けられたサムネイル画像のマップ。マップ内の各オブジェクトでは、キーはサムネイル画像の名前で、値はサムネイルに関するその他の情報を含むオブジェクトになります。 |
snippet.thumbnails.(key) |
object有効なキー値は次のとおりです。
|
snippet.thumbnails.(key).url |
string画像の URL。 |
snippet.thumbnails.(key).width |
unsigned integer画像の幅。 |
snippet.thumbnails.(key).height |
unsigned integer画像の高さ。 |
snippet.channelTitle |
stringこのアクティビティを担当するチャンネルのチャンネル タイトル |
snippet.type |
stringリソースが記述するアクティビティのタイプ。 このプロパティの有効な値は次のとおりです。
|
snippet.groupId |
stringアクティビティに関連付けられているグループ ID。グループ ID は、同じユーザーとリソースに関連付けられているユーザー イベントを特定します。たとえばユーザーが動画を評価し、その動画をお気に入りにした場合、そのユーザーのアクティビティ フィードではこれらのイベントのグループ ID は同じになります。ユーザー インターフェースでは、同じ groupId 値を持つイベントをグループ化することで、繰り返しを回避できます。 |
contentDetails |
objectcontentDetails オブジェクトには、アクティビティに関連付けられたコンテンツに関する情報が含まれます。たとえば、snippet.type の値が videoRated の場合、contentDetails オブジェクトのコンテンツは評価対象の動画を識別します。 |
contentDetails.upload |
objectupload オブジェクトには、アップロードされた動画に関する情報が含まれます。このプロパティは、snippet.type が upload の場合にのみ存在します。 |
contentDetails.upload.videoId |
stringYouTube がアップロードされた動画を一意に識別するために使用する ID。 |
contentDetails.like |
objectlike オブジェクトには、高評価(いいね)を受けたリソースに関する情報が含まれます。このプロパティは、snippet.type が like の場合にのみ存在します。 |
contentDetails.like.resourceId |
objectresourceId オブジェクトには、評価対象のリソースを識別する情報が含まれています。 |
contentDetails.like.resourceId.kind |
stringAPI リソースのタイプ。 |
contentDetails.like.resourceId.videoId |
string評価対象のリソースが動画の場合、YouTube が動画を一意に識別するために使用する ID。このプロパティは、 resourceId.kind が youtube#video の場合にのみ存在します。 |
contentDetails.favorite |
objectfavorite オブジェクトには、お気に入り動画としてマークされた動画に関する情報が含まれます。このプロパティは、snippet.type が favorite の場合にのみ存在します。 |
contentDetails.favorite.resourceId |
objectresourceId オブジェクトには、お気に入りとしてマークされたリソースを識別する情報が含まれています。 |
contentDetails.favorite.resourceId.kind |
stringAPI リソースのタイプ。 |
contentDetails.favorite.resourceId.videoId |
stringYouTube がお気に入りの動画を一意に識別するために使用する ID。このプロパティは、 resourceId.kind が youtube#video の場合にのみ存在します。注: 現在、 activities.list メソッドは新しいコメントのリソースを返しません。 |
contentDetails.comment |
objectcomment オブジェクトには、コメントを受け取ったリソースに関する情報が含まれます。このプロパティは、snippet.type が comment の場合にのみ存在します。 |
contentDetails.comment.resourceId |
objectresourceId オブジェクトには、コメントに関連付けられたリソースを識別する情報が含まれています。 |
contentDetails.comment.resourceId.kind |
stringAPI リソースのタイプ。 |
contentDetails.comment.resourceId.videoId |
stringコメントに関連付けられている動画を一意に識別するために YouTube が使用する ID。このプロパティは、 resourceId.kind が youtube#video の場合にのみ存在します。 |
contentDetails.comment.resourceId.channelId |
stringYouTube がコメントに関連付けられたチャンネルを一意に識別するために使用する ID。このプロパティは、 resourceId.kind が youtube#channel の場合にのみ存在します。 |
contentDetails.subscription |
objectsubscription オブジェクトには、ユーザーが登録したチャンネルに関する情報が含まれます。このプロパティは、snippet.type が subscription の場合にのみ存在します。 |
contentDetails.subscription.resourceId |
objectresourceId オブジェクトには、ユーザーが登録したリソースを識別する情報が含まれます。 |
contentDetails.subscription.resourceId.kind |
stringAPI リソースのタイプ。 |
contentDetails.subscription.resourceId.channelId |
stringユーザーが登録したチャンネルを一意に識別するために YouTube が使用する ID。このプロパティは、 resourceId.kind が youtube#channel の場合にのみ存在します。 |
contentDetails.playlistItem |
objectplaylistItem オブジェクトには、新しいプレイリスト アイテムに関する情報が含まれます。このプロパティは、snippet.type が playlistItem の場合にのみ存在します。 |
contentDetails.playlistItem.resourceId |
objectresourceId オブジェクトには、再生リストに追加されたリソースを識別する情報が含まれています。 |
contentDetails.playlistItem.resourceId.kind |
stringAPI リソースのタイプ。 |
contentDetails.playlistItem.resourceId.videoId |
string再生リストに追加された動画を一意に識別するために YouTube が使用する ID。このプロパティは、 resourceId.kind が youtube#video の場合にのみ存在します。 |
contentDetails.playlistItem.playlistId |
stringYouTube が再生リストを一意に識別するために使用する値。 |
contentDetails.playlistItem.playlistItemId |
stringYouTube が再生リスト内のアイテムを一意に識別するために使用する値。 |
contentDetails.recommendation |
objectrecommendation オブジェクトには、推奨リソースに関する情報が含まれています。このプロパティは、snippet.type が recommendation の場合にのみ存在します。 |
contentDetails.recommendation.resourceId |
objectresourceId オブジェクトには、推奨リソースを識別する情報が含まれています。 |
contentDetails.recommendation.resourceId.kind |
stringAPI リソースのタイプ。 |
contentDetails.recommendation.resourceId.videoId |
string推奨リソースが動画の場合、YouTube が動画を一意に識別するために使用する ID。このプロパティは、 resourceId.kind が youtube#video の場合にのみ存在します。 |
contentDetails.recommendation.resourceId.channelId |
string推奨リソースがチャンネルの場合、YouTube がチャンネルを一意に識別するために使用する ID。このプロパティは、 resourceId.kind が youtube#channel の場合にのみ存在します。 |
contentDetails.recommendation.reason |
stringリソースがユーザーに推奨される理由。 このプロパティの有効な値は次のとおりです。
|
contentDetails.recommendation.seedResourceId |
objectseedResourceId オブジェクトには、推奨事項の原因となったリソースに関する情報が含まれています。 |
contentDetails.recommendation.seedResourceId.kind |
stringAPI リソースのタイプ。 |
contentDetails.recommendation.seedResourceId.videoId |
string特定の動画が原因で推奨事項が表示された場合、YouTube が動画を一意に識別するために使用する ID。このプロパティは、 seedResourceId.kind が youtube#video の場合にのみ存在します。 |
contentDetails.recommendation.seedResourceId.channelId |
string特定のチャンネルが原因で推奨事項が表示された場合、YouTube がチャンネルを一意に識別するために使用する ID。このプロパティは、 seedResourceId.kind が youtube#channel の場合にのみ存在します。 |
contentDetails.recommendation.seedResourceId.playlistId |
string特定のプレイリストが原因で推奨事項が表示された場合、YouTube がプレイリストを一意に識別するために使用する ID。このプロパティは、 seedResourceId.kind が youtube#playlist の場合にのみ存在します。 |
contentDetails.social |
objectsocial オブジェクトには、ソーシャル ネットワークの投稿に関する詳細が含まれます。このプロパティは、snippet.type が social の場合にのみ存在します。 |
contentDetails.social.type |
stringソーシャル ネットワークの名前。 このプロパティの有効な値は次のとおりです。
|
contentDetails.social.resourceId |
objectresourceId オブジェクトは、ソーシャル ネットワークの投稿に関連付けられたリソースを識別する情報をカプセル化します。 |
contentDetails.social.resourceId.kind |
stringAPI リソースのタイプ。 |
contentDetails.social.resourceId.videoId |
string投稿が動画を参照している場合、YouTube がソーシャル ネットワークの投稿で紹介されている動画を一意に識別するために使用する ID。このプロパティは、 social.resourceId.kind プロパティの値が youtube#video の場合にのみ存在します。 |
contentDetails.social.resourceId.channelId |
string投稿がチャンネルを参照している場合、YouTube がソーシャル ネットワークの投稿で取り上げられているチャンネルを一意に識別するために使用する ID。このプロパティは、 social.resourceId.kind プロパティの値が youtube#channel の場合にのみ存在します。 |
contentDetails.social.resourceId.playlistId |
string投稿がプレイリストを参照している場合、YouTube がソーシャル ネットワークの投稿で紹介されているプレイリストを一意に識別するために使用する ID。このプロパティは、 social.resourceId.kind プロパティの値が youtube#playlist の場合にのみ存在します。 |
contentDetails.social.author |
stringソーシャル ネットワークの投稿の作成者。 |
contentDetails.social.referenceUrl |
stringソーシャル ネットワークの投稿の URL。 |
contentDetails.social.imageUrl |
string投稿者の画像。 |
contentDetails.channelItem |
objectchannelItem オブジェクトには、チャンネルに追加されたリソースに関する詳細が含まれています。このプロパティは、snippet.type が channelItem の場合にのみ存在します。 |
contentDetails.channelItem.resourceId |
objectresourceId オブジェクトには、チャンネルに追加されたリソースを識別する情報が含まれます。 |