Method: userUsageReport.get

アカウントを持つ一連のユーザーのプロパティと統計情報のコレクションであるレポートを取得します。詳しくは、ユーザー使用状況レポート ガイドをご覧ください。ユーザー レポートのパラメータの詳細については、ユーザー使用状況パラメータのリファレンス ガイドをご覧ください。

HTTP リクエスト

GET https://admin.googleapis.com/admin/reports/v1/usage/users/{userKey or all}/dates/{date}

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

パスパラメータ

パラメータ
userKey

string

データをフィルタするプロフィール ID またはユーザーのメールアドレスを表します。すべての情報の場合は all、ユーザーの一意の Google Workspace プロフィール ID またはメインのメールアドレスの場合は userKey です。削除されたユーザーは使用できません。削除済みのユーザーの場合は、 showDeleted=true を使用して Directory API で users.list を呼び出し、返された ID を userKey として使用します。
date

string

UTC-8:00（太平洋標準時）に基づいて、使用が発生した日付を表します。タイムスタンプは ISO 8601 形式（yyyy-mm-dd）です。

クエリ パラメータ

パラメータ
customerId

string

データを取得する顧客の一意の ID。
filters

string

filters クエリ文字列は、アプリケーションのイベント パラメータのコンマ区切りリストです。パラメータの値は関係演算子によって操作されます。filters クエリ文字列には、レポートで使用状況が返されるアプリの名前が含まれます。ユーザー使用状況レポートのアプリケーション値には、accounts、docs、gmail があります。

フィルタの形式は [application name]:[parameter name][relational operator][parameter value],... です。

この例では、<>「不等」演算子は、リクエストのクエリ文字列で URL エンコードされています（%3C%3E）。

GET
https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z

関係演算子には次のようなものがあります。

  • == - 「等しい」
  • <> - 「等しくない」。URL エンコード（%3C%3E）されている。
  • < - 「より小さい」URL エンコードされています（%3C）。
  • <= - 「以下」。URL エンコードされています（%3C=）。
  • > - 「次より大きい」。URL エンコードされています（%3E）。
  • >= - 「以上」。URL エンコード（%3E=）されている。
maxResults

integer (uint32 format)

各レスポンス ページに表示するアクティビティ レコードの数を決定します。たとえば、リクエストで maxResults=1 が設定され、レポートに 2 つのアクティビティがある場合、レポートには 2 つのページが表示されます。レスポンスの nextPageToken プロパティには、2 ページ目へのトークンが含まれています。
maxResults クエリ文字列は省略可能です。
orgUnitID

string

レポートする組織部門の ID。ユーザー アクティビティは、指定した組織部門に所属するユーザーに対してのみ表示されます。
pageToken

string

次のページを指定するトークン。複数ページのレポートの場合、レスポンスには nextPageToken プロパティが含まれます。レポートの次のページを取得するフォローアップ リクエストで、pageToken クエリ文字列に nextPageToken 値を入力します。
parameters

string

parameters クエリ文字列は、レポートの結果を絞り込むイベント パラメータのカンマ区切りリストです。このパラメータは特定のアプリケーションに関連付けられています。顧客使用状況レポートのアプリケーション値には、accounts、app_maker、apps_scripts、calendar、classroom、cros、docs、gmail、gplus、device_management、meet、sites があります。
parameters クエリ文字列は、app_name1:param_name1, app_name2:param_name2 の CSV 形式です。
groupIdFilter

string

ユーザー アクティビティがフィルタされるグループ ID（難読化済み）。つまり、レスポンスには、ここで指定されたグループ ID の少なくとも 1 つに属するユーザーのアクティビティのみが含まれます。形式: "id:abc123,id:xyz456"

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には UsageReports のインスタンスが含まれます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

詳しくは、認可ガイドをご覧ください。