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

リクエスト本文

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

レスポンスの本文

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

認可スコープ

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

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

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

EntityType

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