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 นี้ รูปแบบ: properties/{property}/customMetrics/{customMetric}
parameterName

string

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

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

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

string

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

string

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

enum (MeasurementUnit)

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

enum (MetricScope)

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

enum (RestrictedMetricType)

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

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

 สร้าง CustomMetric

get

 ค้นหา CustomMetric รายการเดียว

list

 แสดง CustomMetrics ในพร็อพเพอร์ตี้

patch

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