REST Resource: properties.calculatedMetrics

משאב: ComputedMetric

הגדרה של מדד מחושב.

ייצוג 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'.

המערכת משתמשת ב-aggregateMetricId ומתייחסים למדד המחושב הזה מממשקי API חיצוניים. לדוגמה, "calcMetric:{calculatedMetricId}".
metricUnit

enum (MetricUnit)

חובה. הסוג של הערך של המדד המחושב.
restrictedMetricType[]

enum (RestrictedMetricType)

פלט בלבד. סוגי הנתונים המוגבלים שהמדד הזה כולל.
formula

string

חובה. ההגדרה של המדד המחושב. המספר המקסימלי של מדדים מותאמים אישית ייחודיים שניתן להפנות אליהם הוא 5. נוסחאות תומכות בפעולות הבאות: + (חיבור), - (חיסור), - (שלילי), * (כפל), / (חילוק), () (סוגריים). מספרים ממשיים חוקיים יכולים להיכלל במספר ארוך (מספר שלם 64 ביט) או ב-Double (מספר נקודה צפה של 64 ביט). נוסחה לדוגמה: "( customEvent:parameterName +cartPurchaseQuantity ) / 2.0"
invalidMetricReference

boolean

פלט בלבד. אם הערך הוא True, למדד המחושב יש הפניה לא חוקית למדד. כל דבר שנעשה בו שימוש במדד מחושב שבו השדה invalidMetricReference מוגדר כ-True עלול להיכשל, לספק אזהרות או להניב תוצאות לא צפויות.

MetricUnit

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

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

RestrictedMetricType

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

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

שיטות

create

 יצירת מדד מחושב.

delete

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

get

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

list

 בתיבת הדו-שיח הזו מפורטים מדדים מחושבים בנכס.

patch

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