Method: activities.list

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
userKey or all

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。アクティビティ記録は、指定した組織部門に所属するユーザーにのみ表示されます。
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 と Google Workspace Enterprise をご利用のお客様にのみご利用いただけます。
gcp Google Cloud Platform アプリケーションのアクティビティ レポートは、さまざまな GCP アクティビティ イベントに関する情報を返します。
gplus Google+ アプリケーションのアクティビティ レポートでは、さまざまな Google+ アクティビティ イベントに関する情報が返されます。
groups

Google グループ アプリケーションのアクティビティ レポートでは、さまざまなグループのアクティビティ イベントに関する情報が返されます。
groups_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 と Google Workspace Enterprise をご利用のお客様にのみご利用いただけます。
vault Vault アクティビティ レポートでは、さまざまな種類の Vault アクティビティ イベントに関する情報が返されます。

アクティビティ

アクティビティ リソースの 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

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 は、特定の Google Workspace サービスまたは機能に関連付けられており、API によってイベントのタイプに整理されます。
eventName リクエスト パラメータの一般的な例:

  • eventName が指定されていない場合、レポートは eventName に該当するすべてのインスタンスを返します。
  • eventName をリクエストすると、API のレスポンスで、その eventName を含むすべてのアクティビティが返されます。

eventName プロパティについて詳しくは、上記の applicationName で各種アプリケーションのイベント名の一覧をご覧ください。
events[].parameters[]

object

さまざまな用途に対応するパラメータ値のペア。eventName パラメータについて詳しくは、上記の applicationName で、さまざまな用途のイベント名の一覧をご覧ください。
events[].parameters[].messageValue

object

このパラメータに関連付けられているネストされたパラメータ値のペア。パラメータの複合値の型は、パラメータ値のリストとして返されます。たとえば、アドレス パラメータの値は [{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 か、ロボット アカウントの識別子を指定できます。