Method: userUsageReport.get

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
userKey or all

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],... です。

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

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 クエリ文字列は、CSV 形式の app_name1:param_name1, app_name2:param_name2 です。
groupIdFilter

string

ユーザー アクティビティをフィルタするためのカンマ区切りのグループ ID（難読化）。つまり、レスポンスには、ここに記載されているグループ ID の少なくとも 1 つに属するユーザーのアクティビティのみが含まれます。形式: 「id:abc123,id:xyz456」

リクエスト本文

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

レスポンスの本文

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

認可スコープ

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

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

詳細については、承認ガイドをご覧ください。