本頁面由 Cloud Translation API 翻譯而成。

Reports API：實體使用情形報表

實體使用情形報告會傳回與實體相關的 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 是單次擷取中要傳回的結果數量上限。如果總計結果數量大於這個上限，回應將遭到截斷，將納入 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，篩選條件為會員人數超過 100 人的社群。如需 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 回應範例

如果無法執行要求，回應可能會傳回一或多則警告。在本就無法在提出要求時取得該報表。

{
 "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：提供詳細警告資訊的鍵/值組合清單