Method: entityUsageReports.get

enum (EntityType)

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

string

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

string

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

string

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

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/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=）。

integer (uint32 format)

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

string

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

string

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