REST Resource: properties.customMetrics

משאב: CustomMetric

הגדרה של מדד מותאם אישית.

ייצוג ב-JSON 
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "measurementUnit": enum (MeasurementUnit),
  "scope": enum (MetricScope),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ]
}
שדות
name

string

פלט בלבד. שם המשאב של משאב CustomMetric הזה. פורמט: properties/{property}/customMetrics/{customMetric}
parameterName

string

חובה. לא ניתן לשינוי. שם התיוג של המדד המותאם אישית הזה.

אם מדובר במדד ברמת האירוע, זהו שם פרמטר האירוע.

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

string

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

string

אופציונלי. תיאור למאפיין המותאם אישית הזה. האורך המקסימלי הוא 150 תווים.
measurementUnit

enum (MeasurementUnit)

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

enum (MetricScope)

חובה. לא ניתן לשינוי. ההיקף של המדד המותאם אישית הזה.
restrictedMetricType[]

enum (RestrictedMetricType)

אופציונלי. סוגי הנתונים המוגבלים שהמדד הזה עשוי להכיל. חובה לציין את השדה הזה במדדים עם יחידת המידה CURRENCY. צריך להשאיר את השדה ריק עבור מדדים עם יחידת מידה שאינה CURRENCY.

MeasurementUnit

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

ייתכן שהאופן שבו המטבעות מיוצגים ישתנה בעתיד, ויהיה צורך לבצע שינוי משמעותי ב-API.

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

MetricScope

ההיקף של המדד הזה.

טיפוסים בני מנייה (enum)
METRIC_SCOPE_UNSPECIFIED ההיקף לא ידוע או לא צוין.
EVENT מדד ברמת האירוע.

RestrictedMetricType

תוויות שמסמנות את הנתונים במדד המותאם אישית הזה כנתונים שצריך להגביל למשתמשים ספציפיים.

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

Methods

archive

 העברת מדד מותאם אישית לארכיון בנכס.

create

 יצירת CustomMetric.

get

 חיפוש של מדד מותאם אישית יחיד.

list

 הצגת CustomMetrics בנכס.

patch

 עדכון של מדד מותאם אישית בנכס.