REST Resource: properties.customMetrics

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

คำจำกัดความของเมตริกที่กำหนดเอง

การแสดง JSON 
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "measurementUnit": enum (MeasurementUnit),
  "scope": enum (MetricScope),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ]
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรสำหรับทรัพยากร CustomMetric นี้ รูปแบบ: พร็อพเพอร์ตี้/{property}/customMetrics/{customMetric}
parameterName

string

ต้องระบุ เปลี่ยนแปลงไม่ได้ ชื่อการติดแท็กสำหรับเมตริกที่กำหนดเองนี้

หากเป็นเมตริกที่กําหนดขอบเขตระดับเหตุการณ์ พารามิเตอร์นี้จะเป็นชื่อพารามิเตอร์เหตุการณ์

ใช้ได้เฉพาะอักขระที่เป็นตัวอักษรและตัวเลขคละกันและขีดล่างโดยขึ้นต้นด้วยตัวอักษร ความยาวสูงสุด 40 อักขระสําหรับเมตริกที่กําหนดขอบเขตระดับเหตุการณ์
displayName

string

ต้องระบุ ชื่อที่แสดงของเมตริกที่กำหนดเองนี้ตามที่แสดงใน UI ของ Analytics ความยาวสูงสุด 82 อักขระ ได้แก่ ตัวอักษรและตัวเลขคละกัน รวมถึงช่องว่าง และขีดล่างเริ่มต้นด้วยตัวอักษร ชื่อที่แสดงซึ่งระบบสร้างขึ้นแบบเดิมอาจมีวงเล็บเหลี่ยม แต่การอัปเดตฟิลด์นี้จะไม่อนุญาตให้ใช้เครื่องหมายวงเล็บเหลี่ยม
description

string

ไม่บังคับ คำอธิบายสำหรับมิติข้อมูลที่กำหนดเองนี้ ความยาวสูงสุด 150 อักขระ
measurementUnit

enum (MeasurementUnit)

ต้องระบุ ประเภทสำหรับค่าของเมตริกที่กำหนดเอง
scope

enum (MetricScope)

ต้องระบุ เปลี่ยนแปลงไม่ได้ ขอบเขตของเมตริกที่กำหนดเองนี้
restrictedMetricType[]

enum (RestrictedMetricType)

ไม่บังคับ ประเภทข้อมูลที่ถูกจำกัดซึ่งมีเมตริกนี้อยู่ ต้องระบุสำหรับเมตริกที่มีหน่วยวัด CURRENCY ต้องเว้นว่างไว้สำหรับเมตริกที่มีหน่วยวัดที่ไม่ใช่ CURRENCY

MeasurementUnit

ประเภทที่เป็นไปได้ของการแสดงค่าของเมตริกที่กำหนดเอง

การแสดงสกุลเงินอาจเปลี่ยนแปลงในอนาคต ทำให้ต้องมีการเปลี่ยนแปลง API ที่ส่งผลกับส่วนอื่นในระบบ

Enum
MEASUREMENT_UNIT_UNSPECIFIED ไม่ได้ระบุหรือไม่ได้ระบุ MeasurementUnit
STANDARD เมตริกนี้ใช้หน่วยเริ่มต้น
CURRENCY เมตริกนี้จะวัดสกุลเงิน
FEET เมตริกนี้วัดฟุต
METERS เมตริกนี้วัดเมตร
KILOMETERS เมตริกนี้วัดกิโลเมตร
MILES เมตริกนี้วัดไมล์
MILLISECONDS เมตริกนี้จะวัดมิลลิวินาที
SECONDS เมตริกนี้จะวัดจำนวนวินาที
MINUTES เมตริกนี้จะวัดนาที
HOURS เมตริกนี้วัดชั่วโมง

MetricScope

ขอบเขตของเมตริกนี้

Enum
METRIC_SCOPE_UNSPECIFIED ไม่รู้จักหรือไม่ได้ระบุขอบเขต
EVENT เมตริกที่กําหนดขอบเขตเฉพาะเหตุการณ์

RestrictedMetricType

ป้ายกำกับที่ทำเครื่องหมายข้อมูลในเมตริกที่กำหนดเองนี้เป็นข้อมูลที่ควรจำกัดไว้เฉพาะผู้ใช้บางราย

Enum
RESTRICTED_METRIC_TYPE_UNSPECIFIED ประเภทที่ไม่รู้จักหรือไม่ได้ระบุ
COST_DATA เมตริกจะรายงานข้อมูลค่าใช้จ่าย
REVENUE_DATA เมตริกจะรายงานข้อมูลรายได้

เมธอด

archive

 เก็บ CustomMetric ในพร็อพเพอร์ตี้

create

 สร้างเมตริกที่กำหนดเอง

get

 ค้นหา CustomMetric เดียว

list

 แสดงรายการเมตริกที่กำหนดเองในพร็อพเพอร์ตี้

patch

 อัปเดต CustomMetric ในพร็อพเพอร์ตี้