Activities: list

リクエスト条件に一致するチャネル アクティビティ イベントのリストを返します。たとえば、特定のチャンネルに関連付けられたイベント、ユーザーの登録チャンネルや Google+ の友だちに関連付けられたイベント、各ユーザーに合わせてカスタマイズされた YouTube トップページ フィードなどを取得できます。 今すぐ試す

リクエスト

HTTP リクエスト

GET https://www.googleapis.com/youtube/v3/activities

パラメータ

下記の表は、このクエリでサポートされているパラメータの一覧です。このリストのパラメータはすべてクエリ パラメータです。

パラメータ
必須パラメータ
part string
part パラメータには、API レスポンスに含める 1 つまたは複数の activity リソース プロパティをカンマ区切りリストの形式で指定します。このパラメータ値として指定できる part 名は、idsnippetcontentDetails です。

このパラメータに子プロパティを持つプロパティが指定されている場合、その子プロパティもレスポンスに含まれます。たとえば activity リソースで、snippet プロパティに、アクティビティのタイプ、アクティビティの表示タイトルなどを示す他のプロパティが含まれているとします。この場合、part=snippet と設定すると、API レスポンスには、ネストされているプロパティもすべて含まれることになります。
フィルタ(以下のパラメータのいずれか 1 つのみを指定します)
channelId string
channelId パラメータには一意の YouTube チャンネル ID を指定します。API はそのチャンネルのアクティビティのリストを返します。
home boolean
このパラメータは、適切に承認されたリクエストでのみ使用できます。現在認証されているユーザーの YouTube ホーム ページに表示されるアクティビティ フィードを取得するには、このパラメータの値を true に設定します。
mine boolean
このパラメータは、適切に承認されたリクエストでのみ使用できます。認証されたユーザーのアクティビティのフィードを取得するには、このパラメータの値を true に設定します。
省略可能なパラメータ
maxResults unsigned integer
maxResults パラメータには、結果セットで返されるアイテムの最大数を指定します。0 以上 50 以下の値を指定できます。デフォルト値は 5 です。
pageToken string
pageToken パラメータには、返される結果セットに含める特定のページを指定します。API レスポンスでは、nextPageToken および prevPageToken プロパティは取得可能な他のページを表します。
publishedAfter datetime
publishedAfter パラメータで日時を指定すると、それ以降に発生したアクティビティが API レスポンスに含まれます。時刻を指定せずに日付のみを指定した場合は、その日に発生したすべてのアクティビティが結果セットに含まれます。値は ISO 8601YYYY-MM-DDThh:mm:ss.sZ)形式で指定します。
publishedBefore datetime
publishedBefore パラメータで日時を指定すると、その日時より前に発生したアクティビティが API レスポンスに含まれます。時刻を指定せずに日付のみを指定した場合は、その日に発生したすべてのアクティビティが結果セットから除外されます。値は ISO 8601YYYY-MM-DDThh:mm:ss.sZ)形式で指定します。
regionCode string
regionCode パラメータでは、指定した国の検索結果を返すように API に指示します。パラメータの値は ISO 3166-1 alpha-2 の国コードです。承認されたユーザーがこれまでに YouTube で行ったアクティビティでは、アクティビティ フィードを生成するのに不十分な場合、YouTube はこの値を使用します。

リクエストの本文

このメソッドを呼び出す場合は、リクエストの本文を指定しないでください。

レスポンス

成功すると、このメソッドは次の構造を持つレスポンスの本文を返します。

{
  "kind": "youtube#activityListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    アクティビティ リソース
  ]
}

プロパティ

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

プロパティ
kind string
API リソースのタイプ。値は youtube#activityListResponse です。
etag etag
このリソースの Etag。
nextPageToken string
結果セットの次のページを取得するために、pageToken パラメータの値として使用できるトークン。
prevPageToken string
結果セットの前のページを取得するために、pageToken パラメータの値として使用できるトークン。
pageInfo object
pageInfo オブジェクトは、結果セットのページング情報をカプセル化します。
pageInfo.totalResults integer
結果セット内の結果の総数。
pageInfo.resultsPerPage integer
API レスポンスに含まれる結果の数。
items[] list
リクエスト条件に一致するアクティビティまたはイベントのリスト。

エラー

次の表は、このメソッドを呼び出したときに API からレスポンスとして返される可能性のあるエラー メッセージの一覧です。詳細については、エラー メッセージのドキュメントを参照してください。

エラー タイプ エラーの詳細 説明
notFound channelNotFound リクエストの channelId パラメータで特定されているチャンネル ID が見つかりません。
notFound homeChannelNotFound 現在認証されているユーザーの YouTube のトップページ フィードが見つかりません。
unauthorized authorizationRequired リクエストに home パラメータが使用されていますが、このリクエストは適切に承認されていません。

実際に試してみる

API Explorer を使用し、ライブ データに対してこのメソッドを呼び出して、API リクエストとレスポンスを確認してください。