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 アドレスは、ユーザーの物理的な所在地を反映する場合もあれば、反映しない場合もあります。たとえば、ユーザーのプロキシ サーバーのアドレスや、バーチャル プライベート ネットワーク（VPN）のアドレスを IP アドレスとして使用できます。このパラメータは、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 カレンダーの予定が挙げられます。Calendar Settings 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

エンタープライズ グループ アクティビティ レポートでは、さまざまな 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）アドレスで、ユーザーの物理的な場所を反映しているとは限りません。たとえば、ユーザーのプロキシ サーバーのアドレスや、バーチャル プライベート ネットワーク（VPN）のアドレスを IP アドレスとして使用できます。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

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