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

人が読める形式の警告メッセージには次のようなものがあります。

  • データは利用できません。警告: 日付 yyyy-mm-dd のデータは、アプリケーション "application name" では利用できません。
  • データの一部が利用できます。警告 - 日付が yyyy-mm-dd で、アプリケーションの申し込みができません。application name現在、利用できません。数時間後にもう一度お試しください。

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 値を入力します。

使用状況レポート

使用状況レポートの 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" の場合にのみ有効です。注: レポートの外部向けの名前は、"Objects ではなく "Entities" です。

entity.type

string

出力のみ。商品アイテムのタイプ。値は user です。

Methods

get

特定のユーザー アカウントのプロパティと統計情報を集めたレポートを取得します。