エンティティ使用状況レポートでは、エンティティに関連する 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
次の例では、community_name パラメータを含むレポートを取得しています
（すべての gplus_communities エンティティに対して適用）
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11?parameters=gplus:community_name
次の例では、community_name と
gplus_communities エンティティごとに 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 は、アプリケーションに固有のエンティティ ID です。 存続します。API 取得するエンティティの entityKey を取得する方法については、リファレンスをご覧ください。 フィルタできます。その他のパラメータについては、前述の「 すべてのエンティティ使用状況アクティビティを取得します。
クエリ文字列パラメータとレスポンス プロパティの詳細については、API リファレンスをご覧ください。詳細情報 エンティティ使用状況レポートのパラメータの詳細については、 エンティティ使用パラメータ 参照をご覧ください。
例
次の例では、次のフィールドを含む gplus_community エンティティのエンティティ レポートを取得しています。
entityKey 「1234」。
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 配列の各エントリには次のパラメータがあります。
<ph type="x-smartling-placeholder">- </ph>
code: 機械判読可能な警告コードmessage: 人が読める形式の警告メッセージdata: 詳細な警告情報を提供する Key-Value ペアのリスト