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