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 Issue Tracker、Google Workspace Developers ブログ、Google Workspace 管理者ヘルプセンターをご覧ください。