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 ולא בפרמטרים של כתובת ה-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