REST Resource: properties.calculatedMetrics

ทรัพยากร: CalculatedMetric

คําจํากัดความของเมตริกที่คำนวณแล้ว

การแสดง JSON
{
  "name": string,
  "description": string,
  "displayName": string,
  "calculatedMetricId": string,
  "metricUnit": enum (MetricUnit),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ],
  "formula": string,
  "invalidMetricReference": boolean
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรสําหรับ CalculatedMetric นี้ Format: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'

description

string

ไม่บังคับ คําอธิบายสําหรับเมตริกที่คำนวณแล้วนี้ ความยาวสูงสุด 4,096 อักขระ

displayName

string

ต้องระบุ ชื่อที่แสดงสําหรับเมตริกที่คำนวณแล้วนี้ตามที่แสดงใน UI ของ Google Analytics ความยาวสูงสุด 82 อักขระ

calculatedMetricId

string

เอาต์พุตเท่านั้น รหัสที่จะใช้กับเมตริกที่คำนวณแล้ว ใน UI ข้อมูลนี้จะเรียกว่า "ชื่อ API"

ระบบจะใช้ calculatedMetricId เมื่ออ้างอิงเมตริกที่คำนวณแล้วนี้จาก API ภายนอก เช่น "calcMetric:{calculatedMetricId}"

metricUnit

enum (MetricUnit)

ต้องระบุ ประเภทของค่าเมตริกที่คำนวณ

restrictedMetricType[]

enum (RestrictedMetricType)

เอาต์พุตเท่านั้น ประเภทข้อมูลที่จํากัดซึ่งเมตริกนี้มี

formula

string

ต้องระบุ คําจํากัดความของเมตริกที่คำนวณแล้ว จำนวนเมตริกที่กําหนดเองซึ่งอ้างอิงและไม่ซ้ำกันสูงสุดคือ 5 รายการ สูตรรองรับการดำเนินการต่อไปนี้ + (การบวก) - (การลบ) - (ลบ) * (การคูณ) / (การหาร) () (วงเล็บ) ระบบยอมรับจำนวนจริงที่ถูกต้องซึ่งพอดีกับ Long (จำนวนเต็ม 64 บิต) หรือ Double (จำนวนทศนิยมอย่างละเอียด 64 บิต) ตัวอย่างสูตร: "( customEvent:parameterName + cartPurchaseQuantity ) / 2.0"

invalidMetricReference

boolean

เอาต์พุตเท่านั้น หากเป็น "จริง" แสดงว่าเมตริกที่คำนวณแล้วนี้มีการอ้างอิงเมตริกที่ไม่ถูกต้อง ทุกอย่างที่ใช้เมตริกที่คำนวณแล้วซึ่งตั้งค่า invalidMetricReference เป็น "จริง" อาจไม่สําเร็จ แสดงคําเตือน หรือให้ผลลัพธ์ที่ไม่คาดคิด

MetricUnit

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

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

RestrictedMetricType

ป้ายกํากับที่ทําเครื่องหมายข้อมูลในเมตริกที่คำนวณแล้วซึ่งใช้ร่วมกับบทบาทของผู้ใช้ที่จํากัดการเข้าถึงเมตริกต้นทุนและ/หรือรายได้

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

เมธอด

create

สร้าง CalculatedMetric

delete

ลบ CalculatedMetric ในพร็อพเพอร์ตี้

get

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

list

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

patch

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