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 を呼び出し、返された IDuserKey として使用します。

applicationName

enum (ApplicationName)

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

クエリ パラメータ

パラメータ
actorIpAddress

string

イベントが実行されたホストのインターネット プロトコル(IP)アドレス。これは、アクティビティが報告されているユーザーの IP アドレスを使用してレポートの概要をフィルタする追加の方法です。この IP アドレスは、ユーザーの物理的な場所を反映している場合もあれば、そうでない場合もあります。たとえば、IP アドレスはユーザーのプロキシ サーバーのアドレスや仮想プライベート ネットワーク(VPN)のアドレスにすることができます。このパラメータは、IPv4IPv6 の両方のアドレス バージョンをサポートしています。

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 は、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 プロパティが含まれます。レポートの次のページを取得するフォローアップ リクエストで、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 グループ アクティビティ レポートは、さまざまな 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 表現
{
  "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
    }
  },
  "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 をリクエストすると、その eventName を含むすべてのアクティビティが API のレスポンスで返されます。

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 オブジェクトの activities.list。

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 またはロボット アカウントの ID にできます。

actor.applicationInfo

object

アクティビティのアクターでもあったアプリの詳細。

actor.applicationInfo.oauthClientId

string

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

actor.applicationInfo.applicationName

string

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

actor.applicationInfo.impersonation

boolean

アプリがユーザーになりすましていたかどうか。

resourceDetails[]

object (ResourceDetails)

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

ResourceDetails

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

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

string

リソースの識別子。

title

string

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

type

string

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

appliedLabels[]

object (AppliedLabel)

activities.リソースに適用されているラベルのリスト

relation

string

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

AppliedLabel

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

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

string

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

title

string

ラベルのタイトル

fieldValues[]

object (FieldValue)

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

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 には次のいずれかの値のみを指定できます。
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

activities.list のテキスト値。

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

理由のタイプ。