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 はこの値を使用します。

リクエスト本文

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

レスポンス

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

{
  "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 のリクエストとレスポンスを確認します。