Metadata

המאפיינים והמדדים שניתן להשתמש בהם כרגע בשיטות הדיווח.

ייצוג JSON
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ]
}
שדות
name

string

שם המשאב של המטא-נתונים האלה.

dimensions[]

object (DimensionMetadata)

תיאורי המאפיינים.

metrics[]

object (MetricMetadata)

תיאורי המדדים.

DimensionMetadata

מסביר מאפיין.

ייצוג JSON
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ]
}
שדות
apiName

string

שם המאפיין הזה. אפשר להשתמש בו ב-name של מאפיין. לדוגמה, eventName.

uiName

string

שם המאפיין הזה בממשק המשתמש של Google Analytics. לדוגמה, Event name.

description

string

תיאור של אופן השימוש במאפיין הזה והחישוב שלו.

deprecatedApiNames[]

string

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

MetricMetadata

הסבר על מדד.

ייצוג JSON
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string
}
שדות
apiName

string

שם המדד. אפשר להשתמש בו בname של Metric. לדוגמה, eventCount.

uiName

string

שם המדד בממשק המשתמש של Google Analytics. לדוגמה, Event count.

description

string

תיאור של אופן השימוש במדד הזה והחישוב שלו.

deprecatedApiNames[]

string

שמות עדיין ניתנים לשימוש אבל הוצאו משימוש למדד הזה. אם המדד הזה מאוכלס, המדד הזה יהיה זמין על ידי apiName או על ידי deprecatedApiNames בתקופת זמן מסוימת. אחרי תקופת ההוצאה משימוש, המדד יהיה זמין רק עד apiName.

type

enum (MetricType)

סוג המדד הזה.

expression

string

הביטוי המתמטי של המדד הנגזר הזה. אפשר להשתמש בו בשדה expression של Metric בדוחות מקבילים. רוב המדדים הם לא ביטויים, והשדה הזה ריק.