Activities: list

チャンネルのお知らせ機能のサポートを終了しました。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 パラメータでは、結果セットで返される商品アイテムの最大数を指定します。有効な値は 050(指定した値を含む)です。デフォルト値は 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": [
    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 のリクエストとレスポンスを確認します。