REST Resource: customerUsageReports

資源:UsageReporting

JSON 表示法
{
  "kind": string,
  "etag": string,
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "usageReports": [
    {
      object (UsageReport)
    }
  ],
  "nextPageToken": string
}
欄位
kind

string

API 資源的類型。如果是用量報表,值為 admin#reports#usageReports

etag

string

資源的 ETag。

warnings[]

object

警告 (如果有的話)。

warnings[].code

string

機器可讀取的程式碼或警告類型。警告碼值為 200

warnings[].message

string

使用者可理解的警告訊息如下:

  • 目前無法提供資料警告 - 很抱歉,「application name」應用程式的日期為 yyyy-mm-dd無法使用。
  • 提供部分資料警告 - yyyy-mm-dd 應用程式「application name」的資料有部分資料目前無法使用,請於幾小時後再試一次。

warnings[].data[]

object

鍵/值組合提供警告的詳細資訊。

warnings[].data[].key

string

與鍵/值組合相關聯的鍵,可提供警告的詳細資訊。

warnings[].data[].value

string

與鍵/值組合相關聯的值,提供警告的詳細資訊。

usageReports[]

object (UsageReport)

各種應用程式參數記錄。

nextPageToken

string

用於指定下一頁的權杖。如果報表包含多個網頁,在回應中會包含 nextPageToken 屬性。如果您想後續要求取得報表的所有頁面,請在 pageToken 查詢字串中輸入 nextPageToken 值。

UsageReport

用量報表的 JSON 範本。

JSON 表示法
{
  "kind": string,
  "date": string,
  "parameters": [
    {
      "intValue": string,
      "name": string,
      "stringValue": string,
      "datetimeValue": string,
      "boolValue": boolean,
      "msgValue": [
        {
          object
        }
      ]
    }
  ],
  "etag": string,
  "entity": {
    "customerId": string,
    "userEmail": string,
    "profileId": string,
    "entityId": string,
    "type": string
  }
}
欄位
kind

string

API 資源的類型。如果是用量報表,值為 admin#reports#usageReport

date

string

僅供輸出。報表要求的日期。

parameters[]

object

僅供輸出。各種應用程式的參數值配對。如要瞭解實體用量報表的參數和值,請參閱實體用量參數參考資料

parameters[].intValue

string (int64 format)

僅供輸出。參數的整數值。

parameters[].name

string

參數的名稱。若想瞭解使用者使用情況報表參數名稱,請參閱「使用者使用情形參數參考資料」一文。

parameters[].stringValue

string

僅供輸出。參數的字串值。

parameters[].datetimeValue

string

參數的 RFC 3339 格式值,例如 2010-10-28T10:26:35.000Z

parameters[].boolValue

boolean

僅供輸出。參數的布林值。

parameters[].msgValue[]

object (Struct format)

僅供輸出。參數的巢狀訊息值。

etag

string

資源的 ETag。

entity

object

僅供輸出。項目類型的相關資訊。

entity.customerId

string

僅供輸出。客戶帳戶的專屬 ID。

entity.userEmail

string

僅供輸出。使用者的電子郵件地址。只有在 entity.type =「USER」時才相關

entity.profileId

string

僅供輸出。使用者的 Google Workspace 個人資料 ID (不可變更)。

entity.entityId

string

僅供輸出。物件金鑰。只有在 entity.type =「OBJECT」時才適用注意:對外報表的名稱為「實體」而非「物件」

entity.type

string

僅供輸出。項目類型。值為 user

方法

get

擷取報表,當中包含特定客戶帳戶的資源和統計資料。