エンティティの使用状況レポートには、アカウントのユーザーが使用するエンティティに関連する Google Workspace サービス アクティビティが返されます。これらのレポートは、特定の使用状況情報に合わせてカスタマイズしたり、フィルタしたりできます。過去 30 日間のデータを利用できます。
エンティティ使用状況レポートは、顧客契約に準拠した合法的な目的でのみ使用できます。これらのレポートは、Google Workspace と Education にも適用されます。
すべてのエンティティの使用状況アクティビティを取得する
この API でサポートされているエンティティ タイプは Google+ コミュニティのみです。アカウント内のアプリ エンティティに関連するすべてのアクティビティのレポートを取得するには、次の GET HTTP リクエストを使用し、その際には認証に関するドキュメントで説明した認証トークンを含めます。読みやすくするために、次の例では改行を使用しています。
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
date 値は使用量が発生した日付で、タイムスタンプは ISO 8601 形式（yyyy-mm-dd）です。この場合は、アカウントのタイムゾーンを使用することをおすすめします。クエリ文字列パラメータとレスポンス プロパティの詳細については、API リファレンスをご覧ください。エンティティ使用状況レポートのパラメータについては、エンティティ使用状況パラメータのリファレンスをご覧ください。
applicationParameters は、取得するパラメータのカンマ区切りのリストです。各パラメータは application:parameter_name 形式で指定します（例: gplus:community_name）。使用可能なパラメータについては、エンティティ使用状況パラメータのリファレンスをご覧ください。パラメータが指定されていない場合は、すべてが返されます。
parameterFilters は、結果に適用するフィルタのカンマ区切りのリストです。各フィルタは application:parameter_name[relational_operator]parameter_value の形式で指定します。たとえば、フィルタ gplus:num_total_members>100 は、gplus:num_total_members パラメータの値が 100 より大きい結果のみを含むように結果をフィルタします。
maxResults は、1 回のフェッチで返される結果の最大数です。結果の合計数がこれより大きい場合、レスポンスは切り捨てられ、nextPageToken が含まれます（下記の JSON レスポンスの例を参照）。
例
次の例では、すべての gplus_communities エンティティのすべてのパラメータを含むレポートを取得します。
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11
次の例では、すべての gplus_communities エンティティの community_name パラメータを含むレポートを取得します。
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11?parameters=gplus:community_name
次の例では、メンバーが 100 人を超えるコミュニティでフィルタされた、各 gplus_communities エンティティの community_name と num_total_members のレポートを取得します。API レスポンスの例については、JSON レスポンスの例をご覧ください。
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-11 ?parameters=gplus:community_name,gplus:num_total_members&filters=gplus:num_total_members>100
特定のエンティティのレポートを取得する
特定のエンティティのレポートを取得するには、次の GET HTTP リクエストを使用し、その際には認証に関するドキュメントで説明した認証トークンを含めます。読みやすくするために、次の例では改行を使用しています。
GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
entityKey は、エンティティが存在するアプリケーションに固有のエンティティ識別子です。目的のエンティティの entityKey を取得する方法について詳しくは、API リファレンスをご覧ください。その他のパラメータについては、前のセクションの すべてのエンティティの使用状況アクティビティを取得するで説明しています。
クエリ文字列パラメータとレスポンス プロパティの詳細については、API リファレンスをご覧ください。エンティティ使用状況レポートのパラメータについては、エンティティ使用状況パラメータのリファレンスをご覧ください。
例
次の例では、entityKey が「1234」の gplus_community エンティティのエンティティ レポートを取得します。
https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11
使用状況レポートの JSON レスポンスの例
成功すると、レスポンスとして HTTP 200 のステータス コードが返されます。レスポンスでは、ステータス コードとともにレポートが返されます。読みやすくするために、レスポンスの一部のパラメータは省略されています。
エンティティ レポートの JSON レスポンスの例
{ "kind": "reports#usageReports", "nextPageToken": "NjQ1OTgwODk0MzkxNDAwNjQ0OA", "usageReports": [ { "kind": "admin#reports#usageReport", "date": "2017-12-11", "entity": { "type": "OBJECT", "customerId": "C03az79cb", "objectType": "GPLUS_COMMUNITY", "objectId": "1234", }, "parameters": [ { "name": "gplus:community_name", "stringValue": "My Community" }, { "name": "gplus:num_total_members", "intValue": 37 }, { "name": "gplus:num_7day_active_members", "intValue": 12 }, { "name": "gplus:num_30day_active_members", "intValue": 17 }, ] } ] }
警告を含むエンティティ レポートの JSON レスポンスの例
リクエストを完了できない場合、レスポンスで 1 つ以上の警告が返されることがあります。この例では、リクエストが行われた時点でレポートは利用できません。{
"kind": "reports#usageReports",
"warnings": [
{
"code": "PARTIAL_DATA_AVAILABLE"
"message": "Data for date 2017-12-11 for application gplus is not available right now, please try again after a few hours."
"data": [
{
"key": "date"
"value": "2017-12-11"
}
]
}
],
"usageReports": [],
}warnings 配列の各エントリには、次のパラメータがあります。
code: 機械で読み取り可能な警告コードmessage: 人が読める形式の警告メッセージdata: 詳細な警告情報を提供する Key-Value ペアのリスト