המסמך הזה מספק סקירה כללית כללית של Google Analytics Metadata API. לקבלת מידע מפורט על ה-API, אפשר לעיין בחומר העזר בנושא API.
מבוא
ה-Metadata API מחזיר את הרשימה ואת המאפיינים של העמודות (כלומר המאפיינים והמדדים) שנחשפו ב-API של הדוחות ב-Google Analytics. המאפיינים שהוחזרו כוללים שם ממשק משתמש, תיאור, תמיכה בפלחים ועוד.
אפשר להשתמש ב-Metadata API כדי:
- חיפוש אוטומטי של עמודות חדשות
- גישה לכל המאפיינים והמדדים של ממשקי ה-API של Google Analytics לדיווח
כדאי לעיין ב תגובה פעילה של Metadata API כדי ללמוד איך להשתמש בה, כדאי לעיין במדריך למפתחים.
סקירת קונספט
העקרונות הבסיסיים שעליהם מבוסס ה-Metadata API הם:
עמודות
משאב עמודה ב-Metadata API מייצג מאפיין או מדד יחיד, והוא מכיל מידע כמו Id ומאפיינים אחרים לעמודה זו. אוסף של Column משאבים
מייצג את כל המאפיינים והמדדים שזמינים ל-API לדיווח.
עבודה עם ה-API
בעת שליחת שאילתות ב-API, יש לציין את סוג הדוח שלגביו ברצונך לאחזר את המטא-נתונים. התגובה מ-API תכלול אוסף של כל העמודות (כלומר מאפיינים ומדדים) הזמינות לסוג הדוח הזה. פרטים נוספים על התגובה ל-API ועל דוגמאות קוד זמינים ב מדריך המטא-נתונים של API, וכן המדריך ל-Metadata API Dev לקבלת פרטים על עבודה עם ה-API.
גישה ל-API
ל-Metadata API אין צורך באימות ובהרשאה. במקום זאת, הדרישה היחידה היא שהאפליקציה תזהה את עצמה בכל פעם שהיא תשלח בקשה ל-Analytics API. אפשר למצוא הוראות איך לעשות זאת בקטע גישה לממשק API במדריך למפתחים.
מדיניות בנושא מכסה והוצאה משימוש
ה-Metadata API מטפל במיליוני פעולות. כדי להגן על המערכת כך שלא תקבל יותר פעולות מכפי שהיא, וכדי לוודא שחלוקת המשאבים שווה על ידי המערכת, יש להשתמש במערכת מכסה. במדריך מגבלות ומכסה מופיעים פרטים נוספים.
לפרטים על אופן הטיפול בשינויים בעמודות של ממשק ה-API לדיווח (כלומר מאפיינים ומדדים), יש לקרוא את המדיניות בנושא הוצאה משימוש של נתונים. כדי להבין איך אפשר להשתמש ב-Metadata API כדי לבדוק אם העמודות הוצאו משימוש, אפשר לעיין ב-Metadata API Dev Dev Guide.