activity
リソースには、特定のチャンネルまたはユーザーが YouTube で行った操作に関する情報が格納されます。アクティビティ フィードに報告される操作には、動画の評価、動画の共有、お気に入りへの動画の追加、動画へのコメントの投稿、動画のアップロードなどがあります。各 activity
リソースは、操作の種類、操作に関連付けられたチャンネル、および操作に関連付けられたリソース(評価またはアップロードされた動画など)を識別します。
メソッド
この API では、activities
リソースについて以下のメソッドがサポートされています。
- list
- リクエスト条件に一致するチャネル アクティビティ イベントのリストを返します。たとえば、特定のチャンネルと関連付けられたイベント、ユーザーの登録チャンネルや Google+ フレンドに関連付けられたイベント、各ユーザーにカスタマイズされた YouTube トップページ フィードなどを取得できます。 今すぐ試す。
- insert
- 特定のチャンネルに対するお知らせメッセージを投稿します(リクエストを送信するユーザーは、チャンネルの代理で行動する権限を与えられていることが必要です)。
注:activity
リソースには、動画の評価やお気に入りへの動画の追加といった操作に関する情報が含まれますが、これらのactivity
リソースを生成するには別の API メソッドを使う必要があります。たとえば動画を評価する場合は API のvideos.rate()
メソッド、お気に入りに追加する場合はplaylistItems.insert()
メソッドを使います。
今すぐ試す。
リソース表現
下記の 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 } }, "bulletin": { "resourceId": { "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 |
string API リソースのタイプ。値は youtube#activity です。 |
etag |
etag このリソースの Etag。 |
id |
string アクティビティを一意に識別するために YouTube によって使用される ID。 |
snippet |
object snippet オブジェクトには、アクティビティのタイプやグループ ID など、アクティビティに関する基本的な詳細情報が格納されます。 |
snippet.publishedAt |
datetime アクティビティの発生日時。値は ISO 8601( YYYY-MM-DDThh:mm:ss.sZ )形式で指定します。 |
snippet.channelId |
string アクティビティに関連付けられているチャンネルを一意に識別するために YouTube によって使用される 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 |
object contentDetails オブジェクトには、アクティビティに関連付けられているコンテンツに関する情報が格納されます。たとえば、snippet.type 値が videoRated である場合、contentDetails オブジェクトのコンテンツは評価された動画を特定します。 |
contentDetails.upload |
object upload オブジェクトには、アップロード済み動画に関する情報が格納されます。このプロパティが使用されるのは、snippet.type が upload である場合だけです。 |
contentDetails.upload.videoId |
string アップロード済み動画を一意に識別するために YouTube によって使用される ID。 |
contentDetails.like |
object like オブジェクトには、好意的な評価(高評価)を受けたリソースに関する情報が格納されます。このプロパティが使用されるのは、snippet.type が like である場合だけです。 |
contentDetails.like.resourceId |
object resourceId オブジェクトには、評価されたリソースを特定する情報が格納されます。 |
contentDetails.like.resourceId.kind |
string API リソースのタイプ。 |
contentDetails.like.resourceId.videoId |
string 評価されたリソースが動画である場合に、動画を一意に識別するために YouTube によって使用される ID。このプロパティが使用されるのは、 resourceId.kind が youtube#video である場合だけです。 |
contentDetails.favorite |
object favorite オブジェクトには、お気に入り動画としてマークされた動画に関する情報が格納されます。このプロパティが使用されるのは、snippet.type が favorite である場合だけです。 |
contentDetails.favorite.resourceId |
object resourceId オブジェクトには、お気に入りとしてマークされたリソースを特定する情報が格納されます。 |
contentDetails.favorite.resourceId.kind |
string API リソースのタイプ。 |
contentDetails.favorite.resourceId.videoId |
string お気に入り動画を一意に識別するために YouTube によって使用される ID。このプロパティが使用されるのは、 resourceId.kind が youtube#video である場合だけです。 |
contentDetails.comment |
object comment オブジェクトには、コメントを受けたリソースに関する情報が格納されます。このプロパティが使用されるのは、snippet.type が comment である場合だけです。 |
contentDetails.comment.resourceId |
object resourceId オブジェクトには、コメントに関連付けられているリソースを特定する情報が格納されます。 |
contentDetails.comment.resourceId.kind |
string API リソースのタイプ。 |
contentDetails.comment.resourceId.videoId |
string コメントに関連付けられている動画を一意に識別するために YouTube によって使用される ID。このプロパティが使用されるのは、 resourceId.kind が youtube#video である場合だけです。 |
contentDetails.comment.resourceId.channelId |
string コメントに関連付けられているチャンネルを一意に識別するために YouTube によって使用される ID。このプロパティが使用されるのは、 resourceId.kind が youtube#channel である場合だけです。 |
contentDetails.subscription |
object subscription オブジェクトには、ユーザーがチャンネル登録したチャンネルに関する情報が格納されます。このプロパティが使用されるのは、snippet.type が subscription である場合だけです。 |
contentDetails.subscription.resourceId |
object resourceId オブジェクトには、ユーザーがチャンネル登録したリソースを特定する情報が格納されます。 |
contentDetails.subscription.resourceId.kind |
string API リソースのタイプ。 |
contentDetails.subscription.resourceId.channelId |
string ユーザーがチャンネル登録したチャンネルを一意に識別するために YouTube によって使用される ID。このプロパティが使用されるのは、 resourceId.kind が youtube#channel である場合だけです。 |
contentDetails.playlistItem |
object playlistItem オブジェクトには、新しい再生リスト アイテムに関する情報が格納されます。このプロパティが使用されるのは、snippet.type が playlistItem である場合だけです。 |
contentDetails.playlistItem.resourceId |
object resourceId オブジェクトには、再生リストに追加されたリソースを特定する情報が格納されます。 |
contentDetails.playlistItem.resourceId.kind |
string API リソースのタイプ。 |
contentDetails.playlistItem.resourceId.videoId |
string 再生リストに追加された動画を一意に識別するために YouTube によって使用される ID。このプロパティが使用されるのは、 resourceId.kind が youtube#video である場合だけです。 |
contentDetails.playlistItem.playlistId |
string 再生リストを一意に識別するために YouTube によって使用される値。 |
contentDetails.playlistItem.playlistItemId |
string 再生リスト内のアイテムを一意に識別するために YouTube によって使用される値。 |
contentDetails.recommendation |
object recommendation オブジェクトには、おすすめされたリソースに関する情報が格納されます。このプロパティが使用されるのは、snippet.type が recommendation である場合だけです。 |
contentDetails.recommendation.resourceId |
object resourceId オブジェクトには、おすすめされたリソースを特定する情報が格納されます。 |
contentDetails.recommendation.resourceId.kind |
string API リソースのタイプ。 |
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 |
object seedResourceId オブジェクトには、おすすめの発生元となったリソースに関する情報が格納されます。 |
contentDetails.recommendation.seedResourceId.kind |
string API リソースのタイプ。 |
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.bulletin |
object bulletin オブジェクトには、チャンネルのお知らせメッセージの記事に関する詳細が格納されます。このオブジェクトは、snippet.type が bulletin である場合のみ存在します。 |
contentDetails.bulletin.resourceId |
object resourceId オブジェクトには、お知らせメッセージの記事に関連付けられているリソースを特定する情報が格納されます。 |
contentDetails.bulletin.resourceId.kind |
string API リソースのタイプ。 |
contentDetails.bulletin.resourceId.videoId |
string お知らせメッセージの記事が動画に言及している場合に、その動画を一意に識別するために YouTube によって使用される ID。このプロパティは、 bulletin.resourceId.kind プロパティの値が youtube#video である場合のみ存在します。 |
contentDetails.bulletin.resourceId.channelId |
string お知らせメッセージの記事がチャンネルに言及している場合に、取り上げられているチャンネルを一意に識別するために YouTube によって使用される ID。このプロパティは、 bulletin.resourceId.kind プロパティの値が youtube#channel である場合のみ存在します。 |
contentDetails.bulletin.resourceId.playlistId |
string お知らせメッセージの記事が再生リストに言及している場合に、取り上げられている再生リストを一意に識別するために YouTube によって使用される ID。このプロパティは、 bulletin.resourceId.kind プロパティの値が youtube#playlist である場合のみ存在します。 |
contentDetails.social |
object social オブジェクトには、ソーシャル ネットワークの投稿に関する詳細が格納されます。このプロパティが使用されるのは、snippet.type が social である場合だけです。 |
contentDetails.social.type |
string ソーシャル ネットワークの名前。 このプロパティで有効な値は以下のとおりです。
|
contentDetails.social.resourceId |
object resourceId オブジェクトは、ソーシャル ネットワークの投稿に関連付けられているリソースを特定する情報をカプセル化します。 |
contentDetails.social.resourceId.kind |
string API リソースのタイプ。 |
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 |
object channelItem オブジェクトには、チャンネルに追加されたリソースに関する詳細が格納されます。このプロパティが使用されるのは、snippet.type が channelItem である場合だけです。 |
contentDetails.channelItem.resourceId |
object resourceId オブジェクトには、チャンネルに追加されたリソースを特定する情報が格納されます。 |