Method: entityUsageReports.get

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
entityType

enum (EntityType)

レポートのエンティティのタイプを表します。
entityKey or all

string

データをフィルタ処理するオブジェクトのキーを表します。これは文字列で、all という値を取ると、すべてのユーザーのアクティビティ イベントを取得できます。また、アプリ固有のエンティティのその他の値を取得することもできます。特定の entityType の entityKey を取得する方法の詳細については、エンティティの使用状況パラメータのリファレンス ガイドをご覧ください。
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/gplus_communities/all/dates/2017-12-01
?parameters=gplus:community_name,gplus:num_total_members
&filters=gplus:num_total_members%3C%3E0

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

  • == - 「次と等しい」。
  • <> - 「等しくない」。URL エンコードされています（%3C%3E）。
  • < - 「より小さい」。URL エンコードされている（%3C）。
  • <= - 「次の値以下」。URL エンコードされています（%3C=）。
  • > - 「次の値より大きい」。URL エンコードされています（%3E）。
  • >= - 「次の値以上」。URL エンコードされています（%3E=）。
フィルタは数値パラメータにのみ適用できます。
maxResults

integer (uint32 format)

各応答ページに表示するアクティビティ レコードの数を指定します。たとえば、リクエストで <span>maxResults=1</span> が設定され、レポートに 2 つのアクティビティがある場合、レポートには 2 つのページが含まれます。レスポンスの <span>nextPageToken</span> プロパティに 2 ページ目へのトークンが含まれている。
pageToken

string

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

string

parameters クエリ文字列は、レポートの結果を絞り込むイベント パラメータのカンマ区切りのリストです。パラメータは特定のアプリケーションに関連付けられています。エンティティ使用状況レポートのアプリケーションの値は、gplus のみです。
parameter クエリ文字列は [app_name1:param_name1], [app_name2:param_name2]... の CSV 形式です。

リクエスト本文

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

レスポンスの本文

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

認可スコープ

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

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

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

EntityType

列挙型
gplus_communities Google+ コミュニティに関するレポートを返します。