REST Resource: customerUsageReports

แหล่งข้อมูล: UseReports

การแสดง 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" ไม่พร้อมให้บริการในขณะนี้ โปรดลองอีกครั้งในอีก 2-3 ชั่วโมง

warnings[].data[]

object

คู่คีย์-ค่าเพื่อให้ข้อมูลรายละเอียดเกี่ยวกับคำเตือน

warnings[].data[].key

string

คีย์ที่เชื่อมโยงกับคู่คีย์-ค่าเพื่อให้ข้อมูลโดยละเอียดเกี่ยวกับคำเตือน

warnings[].data[].value

string

ค่าที่เชื่อมโยงกับคู่คีย์-ค่าเพื่อให้ข้อมูลโดยละเอียดเกี่ยวกับคำเตือน

usageReports[]

object (UsageReport)

ระเบียนพารามิเตอร์ของแอปพลิเคชันต่างๆ

nextPageToken

string

โทเค็นเพื่อระบุหน้าถัดไป รายงานที่มีหลายหน้าจะมีพร็อพเพอร์ตี้ nextPageToken ในการตอบกลับ สำหรับคำขอที่ตามมาที่ได้รับทุกหน้าของรายงาน ให้ป้อนค่า nextPageToken ในสตริงคำค้นหา pageToken

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 ที่เปลี่ยนแปลงไม่ได้ของผู้ใช้

entity.entityId

string

เอาต์พุตเท่านั้น คีย์ออบเจ็กต์ ใช้ได้ในกรณีที่entity.type = "OBJECT" เท่านั้น หมายเหตุ: ชื่อรายงานที่แสดงต่อภายนอกคือ "เอนทิตี" แทนที่จะเป็น "ออบเจ็กต์"

entity.type

string

เอาต์พุตเท่านั้น ประเภทของรายการ ค่าคือ user

เมธอด

get

ดึงรายงานซึ่งเป็นคอลเล็กชันของพร็อพเพอร์ตี้และสถิติสำหรับบัญชีของลูกค้าที่เฉพาะเจาะจง