Activities: list

YouTube は、チャンネルの掲示板機能を非推奨にしました。activities.list メソッドはチャンネルの掲示板を返さなくなり、activities.insert メソッドはサポートされなくなりました。詳しくは、 YouTube ヘルプセンターをご覧ください。

リクエスト条件に一致するチャネル アクティビティ イベントのリストを返します。たとえば、特定のチャンネルまたはユーザー自身のチャンネルに関連付けられたイベントを取得できます。

割り当てへの影響: このメソッドの呼び出しには、1 ユニットの割り当てコストがかかります。

一般的なユースケース

リクエスト

HTTP リクエスト

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

パラメータ

次の表に、このクエリでサポートされているパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。

パラメータ
必須パラメータ
part string
part パラメータは、API レスポンスに含める 1 つ以上の activity リソース プロパティのカンマ区切りリストを指定します。

このパラメータで子プロパティを含むプロパティを指定すると、子プロパティがレスポンスに含まれます。たとえば、activity リソースの snippet プロパティには、アクティビティのタイプ、アクティビティの表示タイトルなどを識別する他のプロパティが含まれています。part=snippet を設定すると、API レスポンスにはこれらのネストされたプロパティもすべて含まれます。

次のリストに、パラメータ値に含めることができる part 名を示します。
  • contentDetails
  • id
  • snippet
フィルタ （次のパラメータのいずれか 1 つを指定）
channelId string
channelId パラメータは、一意の YouTube チャンネル ID を指定します。API は、そのチャンネルのアクティビティのリストを返します。
home boolean
注: このパラメータは非推奨になりました。
このパラメータを設定するリクエストの場合、API レスポンスには、ログアウトしたユーザーが YouTube ホームで表示するアイテムと同様のアイテムが含まれます。このパラメータは、適切に認可されたリクエストでのみ使用できます。
mine boolean
このパラメータは、適切に認可されたリクエストでのみ使用できます。認証済みユーザーのアクティビティのフィードを取得するには、このパラメータの値を true に設定します。
オプション パラメータ
maxResults unsigned integer
maxResults パラメータは、結果セットで返されるアイテムの最大数を指定します。有効な値は 0～50（両端を含む）です。デフォルト値は 5 です。
pageToken string
pageToken パラメータは、返される結果セット内の特定のページを指定します。API レスポンスでは、nextPageToken プロパティと prevPageToken プロパティで、取得できる他のページを指定します。
publishedAfter datetime
publishedAfter パラメータは、アクティビティが API レスポンスに含まれるために発生した可能性がある最も早い日時を指定します。パラメータ値で日付を指定しても時刻を指定しない場合、その日に発生したアクティビティはすべて結果セットに含まれます。値は ISO 8601（YYYY-MM-DDThh:mm:ss.sZ）形式で指定します。
publishedBefore datetime
publishedBefore パラメータは、アクティビティが API レスポンスに含まれるために発生したアクティビティの日時を指定します。パラメータ値で日付を指定しても時刻を指定しない場合、その日に発生したアクティビティは結果セットから除外されます。値は ISO 8601（YYYY-MM-DDThh:mm:ss.sZ）形式で指定します。
regionCode string
regionCode パラメータは、指定された国の結果を返すように API に指示します。パラメータ値は ISO 3166-1 alpha-2 国コードです。承認されたユーザーがこれまでに YouTube で行ったアクティビティでは、アクティビティ フィードを生成するのに不十分な場合、YouTube はこの値を使用します。

リクエストの本文

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

Response

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

{
  "kind": "youtube#activityListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    activity Resource
  ]
}

プロパティ

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

プロパティ
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 が返す可能性があるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。

エラーのタイプ エラーの詳細 説明
forbidden (403) forbidden リクエストが適切に認可されていません。
forbidden (403) homeParameterDeprecated この API では、ユーザーのホームページのアクティビティ データを使用できません。認可されていないリクエストで home パラメータを true に設定すると、このエラーが発生する可能性があります。
notFound (404) channelNotFound リクエストの channelId パラメータで指定されたチャンネル ID が見つかりません。
notFound (404) homeChannelNotFound 現在認証されているユーザーの YouTube ホーム フィードが見つかりません。
unauthorized (401) authorizationRequired リクエストで home パラメータを使用していますが、適切に認可されていません。

試してみよう:

APIs Explorer を使用してこの API を呼び出し、API リクエストとレスポンスを確認します。