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 になります。削除されたユーザーであってはなりません。削除されたユーザーの場合は、Directory API で showDeleted=true を指定して 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 は、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
(deprecated)

string

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

レポートする組織部門の ID。アクティビティ レコードは、指定した組織部門に属するユーザーに対してのみ表示されます。
pageToken

string

次のページを指定するトークン。複数ページのレポートの場合、レスポンスに nextPageToken プロパティが含まれます。レポートの次のページを取得する後続のリクエストで、nextPageToken 値を pageToken クエリ文字列に入力します。
startTime

string

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

string

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

ユーザー アクティビティをフィルタリングするグループ 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 ブラウザと Chrome OS のイベントに関する情報が返されます。
data_studio データポータルのアクティビティ レポートは、さまざまなタイプのデータポータル アクティビティ イベントに関する情報を返します。
keep Keep アプリケーションのアクティビティ レポートは、さまざまな Google Keep アクティビティ イベントに関する情報を返します。Keep アクティビティ レポートは、Google Workspace Business および Enterprise をご利用のお客様のみが利用できます。
classroom Classroom アクティビティ レポートは、さまざまなタイプの Classroom アクティビティ イベントに関する情報を返します。