Method: properties.getMetadata

החזרת מטא-נתונים של מאפיינים ומדדים שזמינים בשיטות הדיווח. לבדיקת המאפיינים והמדדים. בשיטה הזו מצוין מזהה נכס GA4 של Google Analytics בבקשה, והתגובה של המטא-נתונים כוללת מאפיינים ומדדים מותאמים אישית וגם מטא-נתונים של Universal.

לדוגמה אם מדד מותאם אישית עם שם הפרמטר levels_unlocked רשום בנכס, התגובה של המטא-נתונים תכיל את הערך customEvent:levels_unlocked. מטא-נתונים אוניברסליים הם מאפיינים ומדדים שרלוונטיים לכל נכס, כמו country ו-totalUsers.

בקשת HTTP

GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/metadata}

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
name

string

חובה. שם המשאב של המטא-נתונים לאחזור. שדה השם הזה מצוין בנתיב כתובת ה-URL ולא בפרמטרים של כתובת האתר. הנכס הוא מזהה מספרי של נכס GA4 ב-Google Analytics. איפה מוצאים את מזהה הנכס?

דוגמה: properties/1234/metadata

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

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

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

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

string

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

object (DimensionMetadata)

תיאורי המאפיינים.
metrics[]

object (MetricMetadata)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

DimensionMetadata

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

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

string

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

string

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

string

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

string

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

boolean

הערך הוא True אם המאפיין הוא מאפיין מותאם אישית של הנכס.

MetricMetadata

הסבר על מדד.

ייצוג JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
שדות
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 בדוחות מקבילים. רוב המדדים הם לא ביטויים, והשדה הזה ריק.
customDefinition

boolean

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