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

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

patch

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