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

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

MetricUnit

סוגי הייצוג האפשריים של הערך של המדד המחושב.

טיפוסים בני מנייה (enum)
METRIC_UNIT_UNSPECIFIED היחידה המטרית לא צוינה או חסרה.
STANDARD המדד הזה משתמש ביחידות ברירת המחדל.
CURRENCY המדד הזה מודד מטבע.
FEET המדד הזה מודד רגליים.
MILES המדד הזה מודד קילומטרים.
METERS המדד הזה מודד מטרים.
KILOMETERS המדד הזה מודד קילומטרים.
MILLISECONDS המדד הזה מודד אלפיות שנייה.
SECONDS המדד הזה מודד שניות.
MINUTES המדד הזה מודד דקות.
HOURS המדד הזה מודד שעות.

RestrictedMetricType

תוויות שמסמנות את הנתונים במדד מחושב, המשמשות בשילוב עם תפקידי משתמשים שמגבילים את הגישה למדדי עלות או הכנסה.

טיפוסים בני מנייה (enum)
RESTRICTED_METRIC_TYPE_UNSPECIFIED סוג לא ידוע או לא צוין.
COST_DATA המדד מדווחת על נתוני עלות.
REVENUE_DATA המדד מדווח על נתוני ההכנסות.

Methods

create

 יצירת CalculatedMetric.

delete

 מחיקה של מדד מחושב בנכס.

get

 חיפוש של מדד מחושב יחיד.

list

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

patch

 עדכון של מדד מחושב בנכס.