Reports API は、ユーザーの Google Workspace アクティビティに関する情報へのアクセスに使用できる RESTful API です。Reports API は Admin SDK API の一部です。
Reports API には次の 2 種類のレポートがあります。
- アクティビティ レポート。Google ドライブや管理コンソールなど、特定のアプリケーションやサービスのイベントを報告します。
- 使用状況レポート。ユーザーによって引き起こされたワークスペース イベントが一覧表示されます。
- お客様の使用状況レポートには、ドメイン内のすべてのユーザーのイベントが一覧表示されます。
- ユーザー使用状況レポートには、ユーザー別に整理されたイベントが一覧表示されます。
Reports API で使用される一般的な用語は次のとおりです。
- アクティビティ レポート
アクティビティ レポートには、特定の Google Workspace アプリケーションまたはサービスにおけるアクティビティの情報が一覧表示されます。アクティビティ レポートには、日付、時刻、ユーザー、アクティビティの種類が含まれます。アクティビティ レポートとそのレポートに含まれる情報の一覧については、API リファレンスをご覧ください。 以下に、アプリケーションまたはサービス別にリストされたアクティビティ レポートの例を示します。
- 管理アクティビティ レポートには、管理者が管理コンソールで行ったアクティビティが表示されます。たとえば、管理者が管理コンソールを使用してユーザー名を変更した日時のリストを取得できます。
- Google ドライブ アクティビティ レポートには、ドメインのユーザーがドライブのドキュメントをどのように編集、表示しているかが一覧表示されます。たとえば、ドライブ上での特定のユーザーのアクティビティのリストを取得できます。
- ログイン アクティビティ レポートでは、アカウントのユーザーがアカウントのログインとログアウトを行ったタイミングに関する情報が提供されます。たとえば、特定の期間におけるドメインのすべてのログインに関するレポートを取得できます。
- モバイル アクティビティ レポートには、Google モバイル管理で管理されているモバイル デバイスを使用したアクティビティが表示されます。たとえば、ユーザーが新しいデバイスを登録したときに通知を受け取ることができます。
- OAuth トークン アクティビティ レポートには、サードパーティのウェブサイトやアプリケーションで使用される認証トークンをユーザーが付与または取り消した際のイベントが一覧表示されます。Reports API を使用すると、ユーザーの Google Workspace データへのすべてのサードパーティ アクセス権のリストを取得できます。
- 使用状況レポート
使用状況レポートには、ドメイン内の Google Workspace イベントに関する情報が表示されます。API を使用して、ユーザーに関する特定の情報をリクエストできます。
- 顧客使用状況レポートには、アカウント内のアプリケーションとサービスの詳しいアクティビティの一覧が表示されます。この使用情報はアプリの種類別に整理されており、そのアプリに固有の情報が含まれています。
- ユーザー使用状況レポートには、アカウントのユーザーによるアクティビティが表示されます。これらのレポートは、特定の使用状況情報に合わせてカスタマイズし、フィルタリングできます。使用状況情報はアプリの種類別に整理されており、そのアプリに固有の情報が含まれています。
- エンティティ使用状況レポートには、Currents アプリケーションでアカウントのユーザーが使用しているエンティティに関連するアクティビティが一覧表示されます。
- 通知
- Reports API は、リソースの変更などのイベントを監視できる通知を提供します。監視しているリソースでそのリソースが変更されると、Reports API から通知が送信されます。Reports API からの通知の設定と受信の詳細については、プッシュ通知の受信に関するガイドをご覧ください。
次のステップ
Reports API の概要とその動作を確認するには、クイックスタートを使用してください。クイックスタートは、左側のナビゲーション バーにプログラミング言語別にリストされています。このセクションに進んで、アカウントの設定に関する一般的な情報を確認することもできます。
認可セクションでは、OAuth 2.0 アクセス トークンを使用して Google Workspace のアプリケーションとサービスからユーザーデータを取得する方法について説明します。
特定のリソースタイプまたはメソッドの詳細を確認するには、API リファレンスをご覧ください。
詳細については、Admin SDK API 公開バグトラッカー、Google Workspace デベロッパー ブログ、Google Workspace 管理者ヘルプセンターをご覧ください。