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