REST Resource: properties.calculatedMetrics

ทรัพยากร: ที่คำนวณเมตริก

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

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

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรสำหรับเมตริกที่คำนวณแล้วนี้ รูปแบบ: "properties/{property_id}/collectdMetrics/{datadMetricId}"

description

string

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

displayName

string

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

calculatedMetricId

string

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

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

metricUnit

enum (MetricUnit)

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

restrictedMetricType[]

enum (RestrictedMetricType)

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

formula

string

ต้องระบุ คำจำกัดความของเมตริกที่คำนวณแล้ว จำนวนเมตริกที่กำหนดเองแบบอ้างอิงที่ไม่ซ้ำได้สูงสุด 5 รายการ สูตรรองรับการดำเนินการต่อไปนี้ + (การเพิ่ม), - (การลบ), - (ลบ), * (การคูณ), / (การหาร), () (วงเล็บ) สามารถใส่จำนวนจริงที่ถูกต้องได้ ซึ่งใช้ได้กับจำนวนเต็มแบบยาว (จำนวนเต็ม 64 บิต) หรือเลขคู่ (เลขทศนิยม 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

สร้างเมตริกที่คำนวณแล้ว

delete

ลบเมตริกที่คำนวณแล้วในพร็อพเพอร์ตี้

get

ค้นหาเมตริกที่คำนวณแล้วรายการเดียว

list

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

patch

อัปเดตเมตริกที่คำนวณแล้วในพร็อพเพอร์ตี้