Reports API: エンティティ使用状況レポート

特定のエンティティのレポートを取得する

特定のエンティティのレポートを取得するには、次の 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 レスポンスの例

{
 "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": [],
}

• code: 機械で読み取り可能な警告コード
• message: 人が読める形式の警告メッセージ
• data: 詳細な警告情報を提供する Key-Value ペアのリストです。