REST Resource: customerUsageReports

リソース: UsageReports

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 のデータは使用できません。
  • 一部のデータが利用可能であるという警告 - アプリケーション「application name」の yyyy-mm-dd の日付のデータは現在利用できません。数時間後にもう一度お試しください。
warnings[].data[]

object

警告に関する詳細情報を提供する Key-Value ペア。
warnings[].data[].key

string

警告の詳細情報を提供する Key-Value ペアに関連付けられたキー。
warnings[].data[].value

string

警告に関する詳細情報を提供する Key-Value ペアに関連付けられた値。
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

出力専用。お客様のアカウントの一意の識別子。
entity.userEmail

string

出力専用。ユーザーのメールアドレスです。entity.type = "USER" の場合にのみ関連します。
entity.profileId

string

出力専用。ユーザーの不変の Google Workspace プロファイル ID。
entity.entityId

string

出力専用。オブジェクト キー。entity.type が「OBJECT」の場合のみ関連します。注: レポートの外部向けの名前は「オブジェクト」ではなく「エンティティ」です。
entity.type

string

出力専用。項目のタイプ。値は user です。

メソッド

get

 特定の顧客のアカウントに関するプロパティと統計情報のコレクションであるレポートを取得します。