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 นี้ รูปแบบ: '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 ตั้งค่าเป็น true อาจทำให้เกิดข้อผิดพลาด แสดงคำเตือน หรือให้ผลลัพธ์ที่ไม่คาดคิด

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

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

patch

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