このページは Cloud Translation API によって翻訳されました。

Method: activities.list

HTTP リクエスト
パスパラメータ
クエリパラメータ
リクエストの本文
レスポンスの本文
- JSON 表現
認可スコープ
ApplicationName
アクティビティ
- JSON 表現
  - JSON 表現
試してみる

特定のお客様のアカウントとアプリケーション（管理コンソールアプリケーションや Google ドライブアプリケーションなど）のアクティビティのリストを取得します。詳しくは、管理者と Google ドライブのアクティビティレポートのガイドをご覧ください。アクティビティレポートのパラメータについて詳しくは、アクティビティパラメータのリファレンスガイドをご覧ください。

HTTP リクエスト

GET https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ

パラメータ
`userKey`	`string` データをフィルタするプロフィール ID またはユーザーのメールアドレスを表します。すべての情報の場合は `all`、ユーザーの一意の Google Workspace プロフィール ID またはメインのメールアドレスの場合は `userKey` です。削除済みのユーザーは対象外です。削除されたユーザーの場合は、 `showDeleted=true` を使用して Directory API で `users.list` を呼び出し、返された `ID` を `userKey` として使用します。
`applicationName`	`enum (ApplicationName)` イベントを取得するアプリケーション名。

userKey

string

データをフィルタするプロフィール ID またはユーザーのメールアドレスを表します。すべての情報の場合は all、ユーザーの一意の Google Workspace プロフィール ID またはメインのメールアドレスの場合は userKey です。削除済みのユーザーは対象外です。削除されたユーザーの場合は、 showDeleted=true を使用して Directory API で users.list を呼び出し、返された ID を userKey として使用します。

applicationName

enum (ApplicationName)

イベントを取得するアプリケーション名。

クエリパラメータ

パラメータ
`actorIpAddress`	`string` イベントが実行されたホストのインターネットプロトコル（IP）アドレス。これは、アクティビティが報告されているユーザーの IP アドレスを使用してレポートの概要をフィルタする別の方法です。この IP アドレスは、ユーザーの実際の所在地を反映している場合も、そうでない場合もあります。たとえば、IP アドレスはユーザーのプロキシサーバーのアドレスや仮想プライベートネットワーク（VPN）のアドレスにすることができます。このパラメータは、IPv4 と IPv6 の両方のアドレスバージョンをサポートしています。
`customerId`	`string` データを取得するお客様の一意の ID。
`endTime`	`string` レポートに表示される期間の終了日を設定します。日付は RFC 3339 形式で指定します。例: 2010-10-28T10:26:35.000Z。デフォルト値は API リクエストのおおよその時間です。API レポートには、次の 3 つの基本的な時間概念があります。 API によるレポートのリクエストの日付: API がレポートを作成して取得した日付。レポートの開始時刻: レポートに表示する期間の開始日時です。`startTime` は、`endTime`（指定されている場合）とリクエストが行われた現在の時刻より前である必要があります。指定しない場合、API はエラーを返します。レポートの終了時間: レポートに表示される期間の終了時間。たとえば、レポートにまとめられるイベントの期間は 4 月から 5 月までで、レポート自体は 8 月にリクエストできます。 `endTime` が指定されていない場合、レポートには `startTime` から現在の時刻までのすべてのアクティビティが返されます。`startTime` が 180 日以上前の場合は、直近の 180 日間のアクティビティが返されます。
`eventName`	`string` API によってクエリされるイベントの名前。各 `eventName` は特定の Google Workspace サービスまたは機能に関連付けられており、API によってイベントの種類別に整理されます。たとえば、管理コンソールアプリケーションのレポートに表示される Google カレンダーの予定などです。カレンダー設定の `type` 構造には、API によって報告されたすべてのカレンダー `eventName` アクティビティが含まれます。管理者がカレンダーの設定を変更すると、API はカレンダーの設定 `type` パラメータと `eventName` パラメータでこのアクティビティを報告します。`eventName` クエリ文字列とパラメータの詳細については、上記の `applicationName` でさまざまなアプリのイベント名のリストをご覧ください。
`filters`	`string` `filters` クエリ文字列は、関係演算子によって操作されるイベントパラメータで構成されるカンマ区切りのリストです。イベントパラメータの形式は `{parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...` です。これらのイベントパラメータは、特定の `eventName` に関連付けられています。リクエストのパラメータが `eventName` に属していない場合、空のレポートが返されます。各アプリケーションで使用可能な `eventName` フィールドと関連するパラメータの詳細については、[ApplicationName] テーブルに移動してから、目的のアプリケーションの付録にある [Activity Events] ページに移動してください。次のドライブアクティビティの例では、返されるリストは、`doc_id` パラメータ値が関係演算子で定義された条件に一致するすべての `edit` イベントで構成されます。最初の例では、`doc_id` 値が `12345` に等しい、編集済みのすべてのドキュメントが返されます。2 つ目の例では、`doc_id` 値が `98765` と等しくない編集済みドキュメントがレポートに返されます。`<>` 演算子は、リクエストのクエリ文字列（`%3C%3E`）で URL エンコードされます。 `GET...&eventName=edit&filters=doc_id==12345 GET...&eventName=edit&filters=doc_id%3C%3E98765` `filters` クエリは、次の関係演算子をサポートしています。 `==` - 「等しい」 `<>` - 「等しくない」。URL エンコード（%3C%3E）する必要があります。 `<` - 「より小さい」URL エンコード（%3C）する必要があります。 `<=` - 「次の値以下」URL エンコード（%3C=）する必要があります。 `>` - 「次より大きい」。URL エンコード（%3E）する必要があります。 `>=` - 「以上」。URL エンコード（%3E=）する必要があります。注: API では、同じパラメータの複数の値を指定できません。API リクエストでパラメータが複数回指定された場合、API はパラメータの最後の値のみを受け入れます。また、API リクエストで無効なパラメータが渡された場合、API はそのパラメータを無視し、残りの有効なパラメータに対応するレスポンスを返します。パラメータがリクエストされていない場合は、すべてのパラメータが返されます。
`maxResults`	`integer` 各レスポンスページに表示するアクティビティレコードの数を決定します。たとえば、リクエストで `maxResults=1` が設定され、レポートに 2 つのアクティビティがある場合、レポートには 2 つのページがあります。レスポンスの `nextPageToken` プロパティには、2 ページ目へのトークンが含まれています。`maxResults` クエリ文字列はリクエストで省略可能です。デフォルト値は 1,000 です。
`orgUnitID`	`string` レポートを作成する組織部門の ID。アクティビティレコードは、指定した組織部門に属するユーザーにのみ表示されます。 2018 年 12 月 17 日より前のデータは、フィルタ後の結果に表示されません。
`pageToken`	`string` 次のページを指定するトークン。複数ページのレポートの場合、レスポンスには `nextPageToken` プロパティが含まれます。レポートの次のページを取得する後続のリクエストで、`pageToken` クエリ文字列に `nextPageToken` 値を入力します。
`startTime`	`string` レポートに表示される期間の開始日を設定します。日付は RFC 3339 形式です（例: 2010-10-28T10:26:35.000Z）。レポートには、`startTime` から `endTime` までのすべてのアクティビティが返されます。`startTime` は、`endTime`（指定されている場合）とリクエストの現在の時刻より前にする必要があります。そうでない場合、API からエラーが返されます。
`groupIdFilter`	`string` ユーザーアクティビティをフィルタするためのカンマ区切りのグループ ID（難読化）。つまり、レスポンスには、ここに記載されているグループ ID の少なくとも 1 つに属するユーザーのアクティビティのみが含まれます。形式: "id:abc123,id:xyz456"

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

アクティビティのコレクションの JSON テンプレート。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現
{ "kind": string, "etag": string, "items": [ { object (`Activity`) } ], "nextPageToken": string }

フィールド
`kind`	`string` API リソースのタイプ。アクティビティレポートの場合、値は `reports#activities` です。
`etag`	`string` リソースの ETag。
`items[]`	`object (Activity)` レスポンスの各アクティビティレコード。
`nextPageToken`	`string` レポートの次のページを取得するためのトークン。`nextPageToken` 値は、リクエストの `pageToken` クエリ文字列で使用されます。

認可スコープ

次の OAuth スコープが必要です。

https://www.googleapis.com/auth/admin.reports.audit.readonly

詳しくは、認可ガイドをご覧ください。

ApplicationName

列挙型
`access_transparency`	Google Workspace のアクセスの透明性アクティビティレポートには、さまざまな種類のアクセスの透明性アクティビティイベントに関する情報が返されます。
`admin`	管理コンソールアプリケーションのアクティビティレポートには、さまざまな種類の管理者アクティビティイベントに関するアカウント情報が返されます。
`calendar`	Google カレンダーアプリケーションのアクティビティレポートでは、カレンダーの予定に関する情報が返されます。
`chat`	Chat アクティビティレポートには、さまざまな Chat アクティビティイベントに関する情報が返されます。
`drive`	Google ドライブアプリのアクティビティレポートには、さまざまな Google ドライブのアクティビティイベントに関する情報が返されます。ドライブアクティビティレポートは、Google Workspace Business および Enterprise をご利用のお客様のみご利用いただけます。
`gcp`	Google Cloud Platform アプリケーションのアクティビティレポートは、さまざまな GCP アクティビティイベントに関する情報を返します。
`gplus`	Google+ アプリケーションのアクティビティレポートでは、さまざまな Google+ アクティビティイベントに関する情報が返されます。
`groups`	Google グループアプリケーションのアクティビティレポートでは、グループのさまざまなアクティビティイベントに関する情報を確認できます。
`groups_enterprise`	エンタープライズグループアクティビティレポートでは、さまざまな Enterprise グループアクティビティイベントに関する情報が返されます。
`jamboard`	Jamboard アクティビティレポートは、さまざまな Jamboard アクティビティイベントに関する情報を返します。
`login`	ログインアプリケーションのアクティビティレポートには、さまざまな種類のログインアクティビティイベントに関するアカウント情報が返されます。
`meet`	Meet 監査アクティビティレポートには、さまざまなタイプの Meet 監査アクティビティイベントに関する情報が返されます。
`mobile`	デバイス監査アクティビティレポートには、さまざまな種類のデバイス監査アクティビティイベントに関する情報が返されます。
`rules`	ルールのアクティビティレポートには、さまざまな種類のルールのアクティビティイベントに関する情報が表示されます。
`saml`	SAML アクティビティレポートには、さまざまなタイプの SAML アクティビティイベントに関する情報が返されます。
`token`	トークンアプリケーションのアクティビティレポートでは、さまざまな種類のトークンアクティビティイベントに関するアカウント情報が返されます。
`user_accounts`	ユーザーアカウントアプリケーションのアクティビティレポートでは、さまざまな種類のユーザーアカウントアクティビティイベントに関するアカウント情報が返されます。
`context_aware_access`	コンテキストアウェアアクセスアクティビティレポートは、コンテキストアウェアアクセスルールが原因でユーザーのアクセスが拒否されたイベントに関する情報を返します。
`chrome`	Chrome アクティビティレポートは、 Chrome ブラウザと ChromeOS のイベントに関する情報を返します。
`data_studio`	データポータルアクティビティレポートには、さまざまな種類のデータポータルアクティビティイベントに関する情報が返されます。
`keep`	Keep アプリのアクティビティレポートでは、Google Keep のさまざまなアクティビティイベントに関する情報が返されます。Keep アクティビティレポートは、Google Workspace Business および Enterprise をご利用のお客様のみご利用いただけます。
`vault`	Vault アクティビティレポートは、さまざまな種類の Vault アクティビティイベントに関する情報を返します。

アクティビティ

アクティビティリソースの JSON テンプレート。

JSON 表現

JSON 表現
{ "kind": string, "etag": string, "ownerDomain": string, "ipAddress": string, "events": [ { "type": string, "name": string, "parameters": [ { "messageValue": { "parameter": [ { object (`NestedParameter`) } ] }, "name": string, "value": string, "multiValue": [ string ], "intValue": string, "multiIntValue": [ string ], "boolValue": boolean, "multiMessageValue": [ { "parameter": [ { object (`NestedParameter`) } ] } ] } ] } ], "id": { "time": string, "uniqueQualifier": string, "applicationName": string, "customerId": string }, "actor": { "profileId": string, "email": string, "callerType": string, "key": string } }

{
  "kind": string,
  "etag": string,
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "messageValue": {
            "parameter": [
              {
                object (NestedParameter)
              }
            ]
          },
          "name": string,
          "value": string,
          "multiValue": [
            string
          ],
          "intValue": string,
          "multiIntValue": [
            string
          ],
          "boolValue": boolean,
          "multiMessageValue": [
            {
              "parameter": [
                {
                  object (NestedParameter)
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string
  }
}

フィールド
`kind`	`string` API リソースのタイプ。アクティビティレポートの場合、値は `audit#activity` です。
`etag`	`string` エントリの ETag。
`ownerDomain`	`string` これは、レポートのイベントの影響を受けるドメインです。たとえば、管理コンソールまたはドライブアプリケーションのドキュメントオーナーのドメインなどです。
`ipAddress`	`string` 操作を行ったユーザーの IP アドレス。これは、Google Workspace にログインする際のユーザーのインターネットプロトコル（IP）アドレスで、ユーザーの物理的な場所を反映しているとは限りません。たとえば、IP アドレスはユーザーのプロキシサーバーのアドレスや仮想プライベートネットワーク（VPN）のアドレスにすることができます。API は IPv4 と IPv6 をサポートしています。
`events[]`	`object` レポート内のアクティビティイベント。
`events[].type`	`string` イベントの種類。管理者が変更した Google Workspace のサービスまたは機能は、`eventName` プロパティを使用してイベントを識別する `type` プロパティで識別されます。API の `type` カテゴリの完全なリストについては、上記の `applicationName` でさまざまなアプリケーションのイベント名のリストをご覧ください。
`events[].name`	`string` イベントの名前。これは、API によってレポートされるアクティビティの具体的な名前です。各 `eventName` は、API がイベントの種類に分類する特定の Google Workspace サービスまたは機能に関連しています。 `eventName` リクエストパラメータ全般: `eventName` が指定されていない場合、レポートは `eventName` のすべてのインスタンスを返します。 `eventName` をリクエストすると、API のレスポンスで、その `eventName` を含むすべてのアクティビティが返されます。 `eventName` プロパティの詳細については、上記の `applicationName` でさまざまなアプリのイベント名のリストをご覧ください。
`events[].parameters[]`	`object` さまざまなアプリケーションのパラメータ値のペア。`eventName` パラメータの詳細については、上記の `applicationName` でさまざまなアプリケーションのイベント名のリストをご覧ください。
`events[].parameters[].messageValue`	`object` このパラメータに関連付けられている、ネストされたパラメータ値のペア。パラメータの複合値型は、パラメータ値のリストとして返されます。たとえば、address パラメータの値は `[{parameter: [{name: city, value: abc}]}]` です。
`events[].parameters[].messageValue.parameter[]`	`object (NestedParameter)` パラメータの値
`events[].parameters[].name`	`string` パラメータの名前。
`events[].parameters[].value`	`string` パラメータの文字列値。
`events[].parameters[].multiValue[]`	`string` パラメータの文字列値。
`events[].parameters[].intValue`	`string (int64 format)` パラメータの整数値。
`events[].parameters[].multiIntValue[]`	`string (int64 format)` パラメータの整数値。
`events[].parameters[].boolValue`	`boolean` パラメータのブール値。
`events[].parameters[].multiMessageValue[]`	`object` `messageValue` オブジェクトの activity.list。
`events[].parameters[].multiMessageValue[].parameter[]`	`object (NestedParameter)` パラメータの値
`id`	`object` 各アクティビティレコードの一意の識別子。
`id.time`	`string` アクティビティが発生した時刻。これは UNIX エポック時間（秒単位）です。
`id.uniqueQualifier`	`string (int64 format)` 複数のイベントが同じ時刻にある場合に、一意の修飾子。
`id.applicationName`	`string` イベントが属するアプリケーション名。有効な値については、上記の `applicationName` のアプリケーションのリストをご覧ください。
`id.customerId`	`string` Google Workspace アカウントの一意の識別子。
`actor`	`object` 操作を行ったユーザー。
`actor.profileId`	`string` アクターの一意の Google Workspace プロフィール ID。この値は、アクターが Google Workspace ユーザーでない場合、存在しないか、プレースホルダ ID として機能する数字 105250506097979753968 である可能性があります。
`actor.email`	`string` アクターのメインのメールアドレス。アクターに関連付けられているメールアドレスがない場合、このフィールドは空になります。
`actor.callerType`	`string` アクターのタイプ。
`actor.key`	`string` `callerType` が `KEY` の場合にのみ存在します。OAuth 2LO API リクエストのリクエスト元の `consumer_key` またはロボットアカウントの ID にできます。