תרחישים לדוגמה לשימוש מתקדם

במסמך הזה מתוארות כמה תכונות מתקדמות של Google Analytics Data API גרסה 1. הפניה מפורטת של ה-API זמינה בחומר העזר בנושא API.

הצגת רשימה של הגדרות מותאמות אישית ויצירת דוחות

ה-Data API יכול ליצור דוחות בחשבונות בהתאמה אישית מאפיינים ובהתאמה אישית מדדים. Metadata API אפשר להשתמש ב-method כדי להציג את רשימת ה-API שמות ההגדרות המותאמות אישית הרשומים של הנכס. שמות ה-API האלה יכולים להיות ששימשו בבקשות דיווח אל לדוגמה, runReport.

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

מאפיינים מותאמים אישית ברמת האירוע

שלב 1: שולחים שאילתה לשיטת ה-Metadata API במזהה הנכס שלכם.

GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata

שלב 2: מוצאים את המאפיין המותאם אישית עם היקף ברמת האירוע הרצוי יצירת דוחות מהתגובה. אם המאפיין לא קיים, יש צורך כדי לרשום את המאפיין.

"dimensions": [
...
    {
      "apiName": "customEvent:achievement_id",
      "uiName": "Achievement ID",
      "description": "An event scoped custom dimension for your Analytics property."
    },
...
],

שלב 3: הכללת המאפיין המותאם אישית בבקשה לדוח. הבאים הוא בקשה לדוגמה ל-method runReport.

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [{ "startDate": "2020-09-01", "endDate": "2020-09-15" }],
  "dimensions": [{ "name": "customEvent:achievement_id" }],
  "metrics": [{ "name": "eventCount" }]
}

מאפיינים מותאמים אישית ברמת המשתמש

שלב 1: שולחים שאילתה לשיטת ה-Metadata API במזהה הנכס שלכם.

GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata

שלב 2: מוצאים את המאפיין המותאם אישית עם היקף ברמת המשתמש הרצוי יצירת דוחות מהתגובה. אם המאפיין לא קיים, יש צורך כדי לרשום את המאפיין.

"dimensions": [
...
    {
      "apiName": "customUser:last_level",
      "uiName": "Last level",
      "description": "A user property for your Analytics property."
    },
...
],

שלב 3: הכללת המאפיין המותאם אישית בבקשה לדוח. הבאים הוא בקשה לדוגמה ל-method runReport.

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "entity": { "propertyId": "GA_PROPERTY_ID" },
  "dateRanges": [{ "startDate": "7daysAgo", "endDate": "yesterday" }],
  "dimensions": [{ "name": "customUser:last_level" }],
  "metrics": [{ "name": "activeUsers" }]
}

מדדים מותאמים אישית ברמת האירוע

שלב 1: שולחים שאילתה לשיטת ה-Metadata API במזהה הנכס שלכם.

GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata

שלב 2: מוצאים את המדד המותאם אישית עם היקף ברמת האירוע הרצוי יצירת דוחות מהתגובה. אם המדד לא קיים, עליך לרישום המדד.

"metrics": [
...
    {
      "apiName": "customEvent:credits_spent",
      "uiName": "Credits Spent",
      "description": "An event scoped custom metric for your Analytics property.",
      "type": "TYPE_STANDARD"
    },
...
],

שלב 3: הכללת המדד המותאם אישית בבקשה לדוח. הבאים הוא בקשה לדוגמה ל-method runReport.

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [{ "startDate": "30daysAgo", "endDate": "yesterday" }],
  "dimensions": [{ "name": "eventName" }],
  "metrics": [{ "name": "customEvent:credits_spent" }]
}

מדדים של שיעור האירועים המרכזיים באירוע מרכזי אחד

שלב 1: שולחים שאילתה ל-Metadata API שיטה עם מזהה הנכס שלכם.

GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata

שלב 2: מוצאים את המדד 'שיעור האירועים המרכזיים' לאירוע המרכזי הרצוי ביצירת דוחות על סמך התגובה. אם האירוע המרכזי לא מופיע, צריך להגדיר את המפתח אירוע.

"metrics": [
...
    {
      "apiName": "sessionKeyEventRate:add_to_cart",
      "uiName": "Session key event rate for add_to_cart",
      "description": "The percentage of sessions in which a specific key event was triggered",
    },
...
],

שלב 3: כוללים את המדד 'שיעור האירועים המרכזיים' בבקשה לדוח. הבאים היא בקשה לדוגמה ל-runReport. .

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [{ "startDate": "30daysAgo", "endDate": "yesterday" }],
  "dimensions": [{ "name": "eventName" }],
  "metrics": [{ "name": "sessionKeyEventRate:add_to_cart" }]
}

ממוצעים של מדדים מותאמים אישית ברמת האירוע

שלב 1: שולחים שאילתה לשיטת ה-Metadata API במזהה הנכס שלכם.

GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata

שלב 2: מוצאים את הממוצע של המדד המותאם אישית עם היקף ברמת האירוע הרצוי יצירת דוחות מהתגובה. אם המדד לא קיים, עליך לרישום המדד.

"metrics": [
...
    {
      "apiName": "averageCustomEvent:credits_spent",
      "uiName": "Average Credits Spent",
      "description": "The average of an event scoped custom metric for your Analytics property.",
      "type": "TYPE_STANDARD"
    },
...
],

שלב 3: הכללת המדד המותאם אישית הממוצע בבקשת הדוח. הבאים הוא בקשה לדוגמה ל-method runReport.

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [{ "startDate": "2020-11-01", "endDate": "2020-11-10" }],
  "dimensions": [{ "name": "eventName" }],
  "metrics": [{ "name": "averageCustomEvent:credits_spent" }]
}

דוגמאות לדוח על קבוצה בעלת מאפיינים משותפים

דוחות על קבוצה בעלת מאפיינים משותפים יוצרים סדרת זמנים של שימור משתמשים בקבוצה בעלת המאפיינים המשותפים. עבור למידע מפורט על כל שדה API, אפשר לעיין בחומר העזר בנושא REST הגדרות בעלות מאפיינים משותפים.

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

לפניכם דוח על קבוצה בעלת מאפיינים משותפים לדוגמה:

• הקבוצה בעלת המאפיינים המשותפים היא משתמשים עם firstSessionDate של 2020-12-01; זה שהוגדר על ידי האובייקט cohorts. המאפיינים והמדדים בדוח התשובה תתבסס רק על המשתמשים בקבוצה בעלת המאפיינים המשותפים.
• בדוח 'קבוצה בעלת מאפיינים משותפים' יוצגו שלוש עמודות: מוגדר על ידי אובייקטים של מאפיינים ומדדים.
  • המאפיין cohort הוא השם של הקבוצה בעלת המאפיינים המשותפים.
  • המאפיין cohortNthDay מייצג את מספר הימים מאז 2020-12-01.
  • המדד cohortActiveUsers מייצג את מספר המשתמשים שעדיין פעילים.
• האובייקט cohortsRange מציין שהדוח צריך להכיל נתוני אירועים החל מ-2020-12-01 ומסתיים ב-2020-12-06 עבור הקבוצה בעלת המאפיינים המשותפים הזו.
  • כשמשתמשים ברמת פירוט של DAILY, המאפיין cohortNthDay הוא מומלץ לשמור על עקביות.

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

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dimensions": [{ "name": "cohort" }, { "name": "cohortNthDay" }],
  "metrics": [{ "name": "cohortActiveUsers" }],
  "cohortSpec": {
    "cohorts": [
      {
        "dimension": "firstSessionDate",
        "dateRange": { "startDate": "2020-12-01", "endDate": "2020-12-01" }
      }
    ],
    "cohortsRange": {
      "endOffset": 5,
      "granularity": "DAILY"
    }
  },
}

עבור הבקשה הזו, תגובת הדוח לדוגמה היא:

{
  "dimensionHeaders": [
    { "name": "cohort" }, { "name": "cohortNthDay" }
  ],
  "metricHeaders": [
    { "name": "cohortActiveUsers", "type": "TYPE_INTEGER" }
  ],
  "rows": [
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0000" }],
      "metricValues": [{ "value": "293" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0001" }],
      "metricValues": [{ "value": "143" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0002" }],
      "metricValues": [{ "value": "123" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0003" }],
      "metricValues": [{ "value": "92" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0005" }],
      "metricValues": [{ "value": "86" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0004" }],
      "metricValues": [{ "value": "83" }]
    }
  ],
  "metadata": {},
  "rowCount": 6
}

מהתשובה הזו לדוח יופיע תרשים של הדוח 'קבוצה בעלת מאפיינים משותפים'. תובנה מדוח זה הוא שהירידה הגדולה ביותר במספר המשתמשים הפעילים בקבוצה בעלת המאפיינים המשותפים הזו היא בין היום הראשון ליום השני.

מספר קבוצות בעלות מאפיינים משותפים (cohort) והחלק במדד שימור המשתמשים

צירוף משתמשים ושימור משתמשים הם דרכים לשיפור האתר או האפליקציה. קבוצה בעלת מאפיינים משותפים הדוחות מתמקדים בשימור משתמשים. בדוגמה הזו, הנכס הזה מוצג בדוח שיפר את שימור המשתמשים במשך 4 ימים ב-10% לאורך שבועיים.

כדי ליצור את הדוח הזה, צריך לציין שלוש קבוצות בעלות מאפיינים משותפים: הראשונה עם firstSessionDate מתוך 2020-11-02, הזמן השני עם firstSessionDate של 2020-11-09, והשלישי עם firstSessionDate של 2020-11-16. כי מספר המשתמשים בנכס שלכם יהיה שונה בשלושת הימים האלה, להשוות בין מדד שימור המשתמשים של הקבוצה בעלת המאפיינים המשותפים הוא cohortActiveUsers/cohortTotalUsers במקום להשתמש ישירות מדד cohortActiveUsers.

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

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dimensions": [{ "name": "cohort" },{ "name": "cohortNthDay" }],
  "metrics": [
    {
      "name": "cohortRetentionFraction",
      "expression": "cohortActiveUsers/cohortTotalUsers"
    }
  ],
  "cohortSpec": {
    "cohorts": [
      {
        "dimension": "firstSessionDate",
        "dateRange": { "startDate": "2020-11-02", "endDate": "2020-11-02" }
      },
      {
        "dimension": "firstSessionDate",
        "dateRange": { "startDate": "2020-11-09", "endDate": "2020-11-09" }
      },
      {
        "dimension": "firstSessionDate",
        "dateRange": { "startDate": "2020-11-16", "endDate": "2020-11-16" }
      }
    ],
    "cohortsRange": {
      "endOffset": 4,
      "granularity": "DAILY"
    }
  },
}

עבור הבקשה הזו, תגובת הדוח לדוגמה היא:

{
  "dimensionHeaders": [{ "name": "cohort" },{ "name": "cohortNthDay" }],
  "metricHeaders": [{
      "name": "cohortRetentionFraction",
      "type": "TYPE_FLOAT"
    }
  ],
  "rows": [
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0000" }],
      "metricValues": [{ "value": "1" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_1" },{ "value": "0000" }],
      "metricValues": [{ "value": "1" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_2" },{ "value": "0000" }],
      "metricValues": [{ "value": "1" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_2" },{ "value": "0001" }],
      "metricValues": [{ "value": "0.308" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_1" },{ "value": "0001" }],
      "metricValues": [{ "value": "0.272" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_2" },{ "value": "0002" }],
      "metricValues": [{ "value": "0.257" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0001" }],
      "metricValues": [{ "value": "0.248" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_2" },{ "value": "0003" }],
      "metricValues": [{ "value": "0.235" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_2" },{ "value": "0004" }],
      "metricValues": [{ "value": "0.211" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_1" },{ "value": "0002" }],
      "metricValues": [{ "value": "0.198" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0002" }],
      "metricValues": [{ "value": "0.172" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_1" },{ "value": "0003" }],
      "metricValues": [{ "value": "0.167" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_1" },{ "value": "0004" }],
      "metricValues": [{ "value": "0.155" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0003" }],
      "metricValues": [{ "value": "0.141" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0004" }],
      "metricValues": [{ "value": "0.118" }]
    }
  ],
  "metadata": {},
  "rowCount": 15
}

מהתשובה הזו לדוח יופיע תרשים של הדוח 'קבוצה בעלת מאפיינים משותפים'. תובנה מדוח זה הוא ששימור המשתמשים במשך 4 ימים עלה ב-10% לאורך שבועיים. הקבוצה המאוחרת יותר עם firstSessionDate מתוך 2020-11-16 חורג מהשימור של הקבוצה הקודמת בעלת המאפיינים המשותפים firstSessionDate מתוך 2020-11-02.

קבוצות שבועיות בעלות מאפיינים משותפים ושימוש בקבוצות בעלות מאפיינים משותפים עם תכונות אחרות של API

כדי להסיר את השונות היומיומית בהתנהגות המשתמשים, תוכלו להשתמש בקבוצות שבועיות בעלות מאפיינים משותפים. מדי שבוע דוחות על קבוצות בעלות מאפיינים משותפים, כל המשתמשים שיש להם firstSessionDate באותו שבוע יוצרים בעלת מאפיינים משותפים. שבועות מתחילים ביום ראשון ומסתיימים ביום שבת. גם בדוח הזה אנחנו ביצוע פילוח של הקבוצה בעלת המאפיינים המשותפים כדי להשוות בין המשתמשים בפעילות ברוסיה לבין המשתמשים עם פעילות במקסיקו. הפילוח הזה משתמש במאפיין country ובמאפיין dimensionFilter כדי לקחת בחשבון רק את שתי המדינות.

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

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dimensions": [
    { "name": "cohort" },
    { "name": "cohortNthWeek" },
    { "name": "country" }
  ],
  "metrics": [{ "name": "cohortActiveUsers" }],
  "dimensionFilter": {
    "filter": {
      "fieldName": "country",
      "inListFilter": {
        "values": [ "Russia", "Mexico" ]
      }
    }
  },
  "cohortSpec": {
    "cohorts": [
      {
        "dimension": "firstSessionDate",
        "dateRange": {
          "startDate": "2020-10-04",
          "endDate": "2020-10-10"
        }
      }
    ],
    "cohortsRange": {
      "endOffset": 5,
      "granularity": "WEEKLY"
    }
  },
}

עבור הבקשה הזו, תגובת הדוח לדוגמה היא:

{
  "dimensionHeaders": [
    { "name": "cohort" },
    { "name": "cohortNthWeek" },
    { "name": "country" }
  ],
  "metricHeaders": [
    { "name": "cohortActiveUsers", "type": "TYPE_INTEGER" }
  ],
  "rows": [
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0000" },{ "value": "Russia" }
      ],
      "metricValues": [{ "value": "105" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0000" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "98" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0001" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "35" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0002" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "24" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0001" },{ "value": "Russia" }
      ],
      "metricValues": [{ "value": "23" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0004" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "17" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0003" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "15" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0005" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "15" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0002" },{ "value": "Russia" }
      ],
      "metricValues": [{ "value": "3" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0003" },{ "value": "Russia" }
      ],
      "metricValues": [{ "value": "1" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0004" },{ "value": "Russia" }
      ],
      "metricValues": [{ "value": "1" }]
    }
  ],
  "metadata": {},
  "rowCount": 11
}

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

השוואות

השוואות מאפשרות לכם לבחון קבוצות משנה של נתונים זו לצד זו. אפשר להגדיר השוואות באמצעות ציון comparisons בהגדרת דוח. התכונה 'השוואות' ב-Data API דומה השוואות בממשק המשתמש של Google Analytics.

לקבלת הסבר מפורט על כל שדה API, אפשר לעיין בחומר העזר בנושא REST השוואה.

יצירת השוואה

אפשר ליצור השוואה נפרדת לכל מערך נתונים שרוצים להשוות. לדוגמה, כדי להשוות בין נתוני אפליקציות לנתוני אתרים, אפשר ליצור השוואה אחת נתוני Android ו-iOS והשוואה נוספת בין נתוני אתרים.

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

ההשוואה הראשונה שנקראת 'תנועה לאפליקציה' משתמש/ת ב-inListFilter כדי התאמה למאפיין platform לערכים 'iOS' ו-Android. השנייה השוואה בשם "תנועה באינטרנט" משתמש ב-stringFilter כדי להתאים ל-platform במאפיין web.

  POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
  {
    "comparisons": [
      {
        "name": "App traffic",
        "dimensionFilter": {
          "filter": {
            "fieldName": "platform",
            "inListFilter": {
              "values": [
                "iOS",
                "Android"
              ]
            }
          }
        }
      },
      {
        "name": "Web traffic",
        "dimensionFilter": {
          "filter": {
            "fieldName": "platform",
            "stringFilter": {
              "matchType": "EXACT",
              "value": "web"
            }
          }
        }
      }
    ],
    "dateRanges": [
      {
        "startDate": "2024-05-01",
        "endDate": "2024-05-15"
      }
    ],
    "dimensions": [
      {
        "name": "country"
      }
    ],
    "metrics": [
      {
        "name": "activeUsers"
      }
    ]
  }

בכל הבקשות שמשתמשות בתכונת ההשוואות, השדה comparison הוא יתווספו באופן אוטומטי לדוח שנוצר. השדה הזה מכיל את השם להשוואה שצוינה בבקשה.

לפניכם קטע טקסט לדוגמה של תשובה שמכילה השוואות:

{
  "dimensionHeaders": [
    {
      "name": "comparison"
    },
    {
      "name": "country"
    }
  ],
  "metricHeaders": [
    {
      "name": "activeUsers",
      "type": "TYPE_INTEGER"
    }
  ],
  "rows": [
    {
      "dimensionValues": [
        {
          "value": "Web traffic"
        },
        {
          "value": "United States"
        }
      ],
      "metricValues": [
        {
          "value": "638572"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "Web traffic"
        },
        {
          "value": "Japan"
        }
      ],
      "metricValues": [
        {
          "value": "376578"
        }
      ]
    },
  {
      "dimensionValues": [
        {
          "value": "App traffic"
        },
        {
          "value": "United States"
        }
      ],
      "metricValues": [
        {
          "value": "79527"
        }
      ]
    },

    ...

  ],

...

}