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 になります。削除されたユーザーであってはなりません。削除されたユーザーの場合は、Directory API で showDeleted=true を指定して users.list を呼び出し、返された IDuserKey として使用します。

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 日間のアクティビティが返されます。

Gmail のリクエストの場合、startTimeendTime を指定する必要があります。また、その差が 30 日を超えてはなりません。

eventName

string

API によってクエリされるイベントの名前。各 eventName は、API がイベントのタイプに分類する特定の Google Workspace サービスまたは機能に関連しています。たとえば、管理コンソール アプリケーションのレポートに表示される 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 テーブルに移動し、目的のアプリケーションの付録にあるアクティビティ イベント ページをクリックしてください。

次のドライブ アクティビティの例では、返されるリストは、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 プロパティが含まれます。レポートの次のページを取得する後続のリクエストで、nextPageToken 値を pageToken クエリ文字列に入力します。

startTime

string

レポートに表示される期間の開始日を設定します。日付は RFC 3339 形式(例: 2010-10-28T10:26:35.000Z)です。レポートには、startTime から endTime までのすべてのアクティビティが返されます。startTime は、endTime(指定されている場合)とリクエストが行われた現在の時刻よりも前である必要があります。そうでない場合、API はエラーを返します。

Gmail のリクエストの場合、startTimeendTime を指定する必要があります。また、その差が 30 日を超えてはなりません。

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 アクティビティ イベントに関する情報を返します。
gmail Gmail アプリケーションのアクティビティ レポートには、さまざまな Gmail アクティビティ イベントに関する情報が返されます。
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 ブラウザと Chrome OS のイベントに関する情報が返されます。

data_studio データポータルのアクティビティ レポートは、さまざまなタイプのデータポータル アクティビティ イベントに関する情報を返します。
keep Keep アプリケーションのアクティビティ レポートは、さまざまな Google Keep アクティビティ イベントに関する情報を返します。Keep アクティビティ レポートは、Google Workspace Business および Enterprise をご利用のお客様のみが利用できます。
vault Vault アクティビティ レポートは、さまざまな種類の Vault アクティビティ イベントに関する情報を返します。
gemini_in_workspace_apps Gemini for Workspace アクティビティ レポートは、Workspace アプリケーション内でユーザーが実行したさまざまなタイプの Gemini アクティビティ イベントに関する情報を返します。
classroom Classroom アクティビティ レポートは、さまざまなタイプの Classroom アクティビティ イベントに関する情報を返します。

アクティビティ

アクティビティ リソースの 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)
                }
              ]
            }
          ]
        }
      ],
      "resourceIds": [
        string
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string,
    "applicationInfo": {
      "oauthClientId": string,
      "applicationName": string,
      "impersonation": boolean
    }
  },
  "networkInfo": {
    object (NetworkInfo)
  },
  "resourceDetails": [
    {
      object (ResourceDetails)
    }
  ]
}
フィールド
kind

string

API リソースのタイプ。アクティビティ レポートの場合、値は audit#activity です。

etag

string

エントリの ETag。

ownerDomain

string

これは、レポートのイベントの影響を受けるドメインです。たとえば、管理コンソールのドメインやドライブ アプリケーションのドキュメントのオーナーなどです。

ipAddress

string

操作を行ったユーザーの IP アドレス。これは、Google Workspace にログインしたときのユーザーのインターネット プロトコル(IP)アドレスです。ユーザーの物理的な場所を反映している場合もあれば、反映していない場合もあります。たとえば、IP アドレスはユーザーのプロキシ サーバーのアドレスや仮想プライベート ネットワーク(VPN)のアドレスである可能性があります。この API は IPv4IPv6 をサポートしています。

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

このパラメータに関連付けられたネストされたパラメータ値のペア。パラメータの複合値の型は、パラメータ値のリストとして返されます。たとえば、アドレス パラメータの値は [{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

activities.messageValue オブジェクトのリスト。

events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

パラメータの値

events[].resourceIds[]

string

イベントに関連付けられたリソース ID。

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

callerTypeKEY の場合にのみ存在します。OAuth 2LO API リクエストのリクエスト元の consumer_key、またはロボット アカウントの識別子を指定できます。

actor.applicationInfo

object

アクティビティのアクターであったアプリケーションの詳細。

actor.applicationInfo.oauthClientId

string

アクションの実行に使用されたサードパーティ アプリケーションの OAuth クライアント ID。

actor.applicationInfo.applicationName

string

アクションの実行に使用されたアプリケーションの名前。

actor.applicationInfo.impersonation

boolean

アプリがユーザーを偽装していたかどうか。

networkInfo

object (NetworkInfo)

アクションを実行しているユーザーのネットワーク情報。

resourceDetails[]

object (ResourceDetails)

アクションが実行されたリソースの詳細。

NetworkInfo

アクションを実行しているユーザーのネットワーク情報。

JSON 表現
{
  "ipAsn": [
    integer
  ],
  "regionCode": string,
  "subdivisionCode": string
}
フィールド
ipAsn[]

integer

操作を行ったユーザーの IP アドレス。

regionCode

string

アクションを実行しているユーザーの ISO 3166-1 alpha-2 地域コード。

subdivisionCode

string

アクションを実行しているユーザーの国の ISO 3166-2 地域コード(州と県)。

ResourceDetails

アクションが実行されたリソースの詳細。

JSON 表現
{
  "id": string,
  "title": string,
  "type": string,
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "relation": string
}
フィールド
id

string

リソースの識別子。

title

string

リソースのタイトル。たとえば、ドライブ ドキュメントの場合、これはドキュメントのタイトルになります。メールの場合、これは件名になります。

type

string

リソースのタイプ - ドキュメント、メール、チャット メッセージ

appliedLabels[]

object (AppliedLabel)

リソースに適用されたラベルの activities.list

relation

string

リソースとイベントの関係を定義します

AppliedLabel

リソースに適用されたラベルの詳細。

JSON 表現
{
  "id": string,
  "title": string,
  "fieldValues": [
    {
      object (FieldValue)
    }
  ],
  "reason": {
    object (Reason)
  }
}
フィールド
id

string

ラベルの識別子 - 完全な OnePlatform リソース名ではなく、ラベル ID のみ。

title

string

ラベルのタイトル

fieldValues[]

object (FieldValue)

activities.list: ラベルの一部であり、ユーザーによって設定されたフィールドのリスト。ユーザーが設定していないフィールドがラベルに含まれている場合、そのラベルはこのリストに表示されません。

reason

object (Reason)

ラベルがリソースに適用された理由。

FieldValue

特定のラベルに対してユーザーが設定したフィールド値の詳細。

JSON 表現
{
  "id": string,
  "displayName": string,
  "type": string,
  "reason": {
    object (Reason)
  },

  // Union field value can be only one of the following:
  "unsetValue": boolean,
  "longTextValue": string,
  "textValue": string,
  "textListValue": {
    object (TextListValue)
  },
  "selectionValue": {
    object (SelectionValue)
  },
  "selectionListValue": {
    object (SelectionListValue)
  },
  "integerValue": string,
  "userValue": {
    object (UserValue)
  },
  "userListValue": {
    object (UserListValue)
  },
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
フィールド
id

string

フィールドの識別子

displayName

string

フィールドの表示名

type

string

フィールドの型

reason

object (Reason)

フィールドがラベルに適用された理由。

共用体フィールド value。フィールドに格納される値 value は、次のいずれか 1 つのみです。
unsetValue

boolean

フィールドが設定されていない場合、これは true になります。

longTextValue

string

長いテキスト値を設定します。

textValue

string

テキスト値を設定します。

textListValue

object (TextListValue)

テキスト リストの値を設定します。

selectionValue

object (SelectionValue)

プルダウンから単一の値を選択して選択値を設定します。

selectionListValue

object (SelectionListValue)

プルダウンから複数の値を選択して選択リストの値を設定する。

integerValue

string (int64 format)

整数値を設定します。

userValue

object (UserValue)

1 人のユーザーを選択してユーザー値を設定する。

userListValue

object (UserListValue)

複数のユーザーを選択してユーザーリストの値を設定する。

dateValue

object (Date)

日付値を設定します。

TextListValue

テキスト リストの値を設定します。

JSON 表現
{
  "values": [
    string
  ]
}
フィールド
values[]

string

アクティビティ。テキスト値のリスト。

SelectionValue

プルダウンから単一の値を選択して選択値を設定します。

JSON 表現
{
  "id": string,
  "displayName": string,
  "badged": boolean
}
フィールド
id

string

選択の識別子。

displayName

string

選択の表示名。

badged

boolean

選択肢にバッジが付いているかどうか。

SelectionListValue

プルダウンから複数の値を選択して選択リストの値を設定する。

JSON 表現
{
  "values": [
    {
      object (SelectionValue)
    }
  ]
}
フィールド
values[]

object (SelectionValue)

activities.list の選択。

UserValue

1 人のユーザーを選択してユーザー値を設定する。

JSON 表現
{
  "email": string
}
フィールド
email

string

ユーザーのメールアドレス。

UserListValue

複数のユーザーを選択してユーザーリストの値を設定する。

JSON 表現
{
  "values": [
    {
      object (UserValue)
    }
  ]
}
フィールド
values[]

object (UserValue)

activities.list of users。

日付

誕生日などのように、カレンダーの日付全体またはその一部を表します。時間帯とタイムゾーンは、他の場所で指定されているか、重要ではありません。日付は西暦を基準にしており、これは次のいずれかを表します。

  • 年の値がゼロ以外である月と日の値を含む完全な日付
  • 年の値がゼロである月と日(記念日など)。
  • 月と日の値がゼロである単独の年。
  • 日の値がゼロである年と月(クレジット カードの有効期限など)

関連するタイプ:

JSON 表現
{
  "year": integer,
  "month": integer,
  "day": integer
}
フィールド
year

integer

その日付の年。1~9999、または年のない日付を指定する場合は 0 にする必要があります。

month

integer

1 年の中の月。1~12、または月と日のない年を指定する場合は 0 にする必要があります。

day

integer

1 月の中の日付。1~31 で、その年と月で有効な値にする必要があります。または、日が重要でない場合は年のみか年と月を指定するには 0 にする必要があります。

理由

ラベル/フィールドが適用された理由。

JSON 表現
{
  "reasonType": string
}
フィールド
reasonType

string

理由のタイプ。