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

string

データをフィルタするオブジェクトのキーを表します。これは文字列です。値 all を取得して、すべてのユーザーのアクティビティ イベントを取得したり、アプリ固有のエンティティのその他の値を取得したりできます。特定の entityTypeentityKey を取得する方法については、エンティティの使用状況パラメータのリファレンス ガイドをご覧ください。

date

string

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

クエリ パラメータ

パラメータ
customerId

string

データを取得するお客様の一意の ID。

filters

string

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

フィルタの形式は [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+ コミュニティに関するレポートを返します。