Method: activities.watch

アカウント アクティビティに関する通知の受信を開始します。詳細については、プッシュ通知の受信をご覧ください。

HTTP リクエスト

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

この 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
(deprecated)

string

Deprecated。このフィールドは非推奨で、サポートされなくなりました。

レポートを作成する組織部門の 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」

リクエスト本文

リクエストの本文には SubscriptionChannel のインスタンスが含まれます。

レスポンスの本文

リソースの変更を監視するために使用される通知チャンネル。

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

JSON 表現 
{
  "id": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "payload": boolean,
  "params": {
    string: string,
    ...
  },
  "resourceId": string,
  "resourceUri": string,
  "kind": string
}
フィールド
id

string

このチャンネルを識別する UUID または一意の文字列。
token

string

このチャンネル経由で通知と一緒に対象のアドレスに配布される任意の文字列。省略可能。
expiration

string (int64 format)

通知チャンネルの有効期限。Unix のタイムスタンプでミリ秒単位で表示されます。省略可能。
type

string

このチャンネルで使用される配信方法の種類。値は "web_hook" に設定する必要があります。
address

string

このチャンネルの通知が配信されるアドレス。
payload

boolean

ペイロードが必要かどうかを表すブール値。ペイロードは、HTTP POST、PUT、PATCH メッセージの本文で送信されるデータで、リクエストに関する重要な情報が含まれます。省略可。
params

map (key: string, value: string)

配信チャンネルの操作を制御する追加のパラメータ。省略可。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
resourceId

string

このチャンネルで監視するリソースを識別する不透明な ID。異なる API バージョンでも安定しています。
resourceUri

string

監視対象のリソースのバージョン固有の ID。
kind

string

リソース「api#channel」の変更を監視するために使用される通知チャンネルであることを指定します。

認可スコープ

次の 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 をご利用のお客様のみご利用いただけます。