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 תווים, אלפאנומריים בתוספת רווח וקו תחתון, שמתחילים באות. יכול להיות שהשמות לתצוגה שנוצרו על ידי המערכת בגרסה הקודמת של Google Workspace יכללו סוגריים מרובעים, אבל עדכונים בשדה הזה לא יאפשרו שימוש בסוגריים מרובעים.
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

 העברה לארכיון של CustomMetric בנכס.

create

 יוצרת CustomMetric.

get

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

list

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

patch

 מעדכן CustomMetric בנכס.