Method: activities.watch

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

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
userKey

string

データをフィルタするプロフィール ID またはユーザーのメールアドレスを表します。すべての情報の場合は all、ユーザーの一意の Google Workspace プロフィール ID またはメインのメールアドレスの場合は userKey です。削除されたユーザーは使用できません。削除済みのユーザーの場合は、 showDeleted=true を使用して Directory API で 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 プロパティが含まれます。レポートの次のページを取得する後続のリクエストで、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 グループ アクティビティ レポートは、さまざまな 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 をご利用のお客様のみご利用いただけます。