Reports API の概要

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 について学習し、動作を確認するには、クイックスタートを使用してください。クイックスタートは、左側のナビゲーション バーにプログラミング言語別にリストされています。このセクションに進んで、アカウントの設定に関する一般的な情報を確認することもできます。

  • Reports API を使用するには、前提条件の手順に沿ってアカウントを設定し、管理者となります。また、Google API Console を使用してプロジェクトを作成して登録し、Reports API サービスを有効にします。

  • 承認セクションでは、OAuth 2.0 アクセス トークンを使用して Google Workspace アプリケーションとサービスからユーザーデータを取得する方法について説明します。

  • 特定のリソースタイプまたはメソッドの詳細については、API リファレンスをご覧ください。

  • 詳細については、Admin SDK API Issue TrackerGoogle Workspace デベロッパー ブログGoogle Workspace 管理者ヘルプセンターをご覧ください。