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

מזהה. שם המשאב של המדד המחושב הזה. פורמט: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'
description

string

אופציונלי. תיאור של המדד המחושב הזה. אורך מקסימלי של 4,096 תווים.
displayName

string

חובה. השם המוצג של המדד המחושב הזה, כפי שהוא מופיע בממשק המשתמש של Google Analytics. אורך מקסימלי של 82 תווים.
calculatedMetricId

string

פלט בלבד. המזהה שמשמש למדד המחושב. בממשק המשתמש, השם הזה נקרא 'שם ה-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

פלט בלבד. אם הערך הוא true, למדד המחושב הזה יש הפניה לא תקינה למדד. כל פעולה שמשתמשת במדד מחושב עם הערך true של 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 המדד מדווח על נתוני הכנסות.

Methods

create

 יוצרת CalculatedMetric.

delete

 מחיקת CalculatedMetric בנכס.

get

 חיפוש של CalculatedMetric יחיד.

list

 הצגת רשימה של מדדים מחושבים בנכס.

patch

 עדכון של CalculatedMetric בנכס.