REST Resource: properties.customMetrics

ทรัพยากร: CustomMetrics

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

การแสดง 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

 สร้าง CustomMetrics

get

 ค้นหา CustomMetrics เดียว

list

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

patch

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