Method: properties.getMetadata

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

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

בקשת HTTP

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

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

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

פרמטרים
name

string

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

דוגמה: properties/1234/metadata

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

גוף הבקשה

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

גוף התשובה

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

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

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

string

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

object (DimensionMetadata)

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

object (MetricMetadata)

תיאורי המדדים.
comparisons[]

object (ComparisonMetadata)

תיאורי ההשוואות.

היקפי ההרשאות

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

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

ComparisonMetadata

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

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

string

שם המשאב של ההשוואה הזו. אפשר להשתמש בו בשדה comparison של השוואה. לדוגמה, 'comparisons/1234'.
uiName

string

שם ההשוואה בממשק המשתמש של Google Analytics.
description

string

התיאור של ההשוואה הזו.