פלאגין Google Analytics ל-Unity - הפניית API

מסמך זה מתאר כיצד לשלוח נתונים ומפרט את כל השיטות עבור הפלאגין של Google Analytics עבור Unity.

מבוא

כששולחים נתונים ל-Google Analytics באמצעות הפלאגין של GA ל-Unity, אפשר להשתמש בשיטה Basic או בשיטה Builder. יש להשתמש בשיטות Builder אם רוצים להוסיף להיטים פרמטרים או מאפיינים או מדדים מותאמים אישית. ניתן לשלוח היטים בכל אחת מהשיטות.

פעלו לפי ההוראות במדריך למפתחים כדי להגדיר ולהגדיר את הפלאגין של Google Analytics ל-Unity לפרויקט שלכם.

כללי

להיטים בשליחה

שולח היטים (תצוגה, אירועים וכו') ל-Google Analytics אם יש חיבור לרשת.

public void DispatchHits();

מקורות מידע שקשורים לנושא:

בקרת פעילות באתר

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

אפשר להשתמש בשיטות הבאות כדי לאלץ התחלה או סיום של סשן.

// Start a new session.
public void StartSession();

// There should be no need to end a session explicitly. However, if you do
// need to indicate the end of session you can use the following method.
public void StopSession();

מקורות מידע שקשורים לנושא:

מסכים

המסכים ב-Google Analytics מייצגים תוכן שהמשתמשים צופים בו בתוך המשחק. תצוגת מסך מורכבת משדה מחרוזת יחיד שישמש בתור שם המסך בדוחות Google Analytics.

בסיסית

public void LogScreen(string title);

בנאי/ת

public void LogScreen(AppViewHitBuilder builder);

דוגמה

googleAnalytics.LogScreen("Main Menu");

//Builder Hit with all App View parameters (all parameters required):
googleAnalytics.LogScreen(new AppViewHitBuilder()
    .SetScreenName("Main Menu"));

מקורות מידע שקשורים לנושא:

אירועים

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

בסיסית

public void LogEvent(string eventCategory,
    string eventAction,
    string eventLabel,
    long value);

בנאי/ת

public void LogEvent(EventHitBuilder builder);

דוגמה

googleAnalytics.LogEvent("Achievement", "Unlocked", "Slay 10 dragons", 5);

// Builder Hit with all Event parameters.
googleAnalytics.LogEvent(new EventHitBuilder()
    .SetEventCategory("Achievement")
    .SetEventAction("Unlocked")
    .SetEventLabel("Slay 10 dragons")
    .SetEventValue(5));

// Builder Hit with minimum required Event parameters.
googleAnalytics.LogEvent(new EventHitBuilder()
    .SetEventCategory("Achievement")
    .SetEventAction("Unlocked"));

מקורות מידע שקשורים לנושא:

קריסות וחריגים

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

בסיסית

public void LogException(string exceptionDescription, bool isFatal);

בנאי/ת

public void LogException(ExceptionHitBuilder builder);

דוגמה

googleAnalytics.LogException("Incorrect input exception", true);

// Builder Hit with all Exception parameters.
googleAnalytics.LogException(new ExceptionHitBuilder()
    .SetExceptionDescription("Incorrect input exception")
    .SetFatal(true));

// Builder Hit with minimum required Exception parameters.
googleAnalytics.LogException(new ExceptionHitBuilder());

מקורות מידע שקשורים לנושא:

תזמוני משתמשים

מדידת תזמוני משתמש היא דרך מובנית למדוד תקופת זמן ב-Google Analytics. לדוגמה, אפשר למדוד את זמני הטעינה של המשאבים.

בסיסית

public void LogTiming(string timingCategory,
    long timingInterval,
    string timingName,
    string timingLabel);

בנאי/ת

public void LogTiming(TimingHitBuilder builder);

דוגמה

googleAnalytics.LogTiming("Loading", 50L, "Main Menu", "First Load");

// Builder Hit with all Timing parameters.
googleAnalytics.LogTiming(new TimingHitBuilder()
    .SetTimingCategory("Loading")
    .SetTimingInterval(50L)
    .SetTimingName("Main Menu")
    .SetTimingLabel("First load"));

// Builder Hit with minimum required Timing parameters.
googleAnalytics.LogTiming(new TimingHitBuilder()
    .SetTimingCategory("Loading")
    .SetTimingInterval(50L));

מקורות מידע שקשורים לנושא:

אינטראקציות חברתיות

מדידת אינטראקציות חברתיות מאפשרת לך למדוד את האינטראקציות של משתמש עם ווידג'טים שונים של שיתוף והמלצות ברשתות חברתיות המוטמעות בתוכן שלך.

בסיסית

public void LogSocial(string socialNetwork,
    string socialAction,
    string socialTarget);

בנאי/ת

public void LogSocial(SocialHitBuilder builder);

דוגמה

googleAnalytics.LogSocial("twitter", "retweet", "twitter.com/googleanalytics/status/482210840234295296");

// Builder Hit with all Social parameters.
googleAnalytics.LogSocial(new SocialHitBuilder()
    .SetSocialNetwork("Twitter")
    .SetSocialAction("Retweet")
    .SetSocialTarget("twitter.com/googleanalytics/status/482210840234295296"));

// Builder Hit with minimum required Social parameters.
googleAnalytics.LogSocial(new SocialHitBuilder()
    .SetSocialNetwork("Twitter")
    .SetSocialAction("Retweet"));

מקורות מידע שקשורים לנושא:

מסחר אלקטרוני

מדידת המסחר האלקטרוני מאפשרת לשלוח ל-Google Analytics רכישות ומכירות מתוך המשחק. נתוני מסחר אלקטרוני ב-Google Analytics מורכבים מהיטים של עסקאות ופריטים, שקשורים למזהה עסקה משותף.

טרנזקציות

בסיסית

public void LogTransaction(string transID,
    string affiliation,
    double revenue,
    double tax,
    double shipping);

public void LogTransaction(string transID,
    string affiliation,
    double revenue,
    double tax,
    double shipping,
    string currencyCode);

בנאי/ת

public void LogTransaction(TransactionHitBuilder builder);

דוגמה

googleAnalytics.LogTransaction("TRANS001", "Coin Store", 3.0, 0.0, 0.0);
googleAnalytics.LogTransaction("TRANS001", "Coin Store", 3.0, 0.0, 0.0, "USD");

// Builder Hit with all Transaction parameters.
googleAnalytics.LogTransaction(new TransactionHitBuilder()
    .SetTransactionID("TRANS001")
    .SetAffiliation("Coin Store")
    .SetRevenue(3.0)
    .SetTax(0)
    .SetShipping(0.0)
    .SetCurrencyCode("USD"));

// Builder Hit with minimum required Transaction parameters.
googleAnalytics.LogTransaction(new TransactionHitBuilder()
    .SetTransactionID("TRANS001")
    .SetAffiliation("Coin Store")
    .SetRevenue(3.0)
    .SetTax(0)
    .SetShipping(0.0));

פריטים

בסיסית

public void LogItem(string transID,
    string name,
    string SKU,
    string category,
    double price,
    long quantity);

public void LogItem(string transID,
    string name,
    string SKU,
    string category,
    double price,
    long quantity,
    string currencyCode);

בנאי/ת

public void LogItem(ItemHitBuilder builder);

דוגמה

googleAnalytics.LogItem("TRANS001", "Sword", "SWORD1223", "Weapon", 3.0, 2);
googleAnalytics.LogItem("TRANS001", "Sword", "SWORD1223", "Weapon", 3.0, 2, "USD");

// Builder Hit with all Item parameters.
googleAnalytics.LogItem(new ItemHitBuilder()
    .SetTransactionID("TRANS001")
    .SetName("Sword")
    .SetSKU("SWORD1223")
    .SetCategory("Weapon")
    .SetPrice(3.0)
    .SetQuantity(2)
    .SetCurrencyCode("USD"));

// Builder Hit with minimum required Item parameters.
googleAnalytics.LogItem(new ItemHitBuilder()
    .SetTransactionID("TRANS001")
    .SetName("Sword")
    .SetSKU("SWORD1223")
    .SetPrice(3.0)
    .SetQuantity(2));

מקורות מידע שקשורים לנושא:

מאפיינים וערכים מותאמים אישית

מאפיינים מותאמים אישית מאפשרים שיוך של מטא נתונים להתאמות, למשתמשים ולפעילויות באתר ב-Google Analytics, ואילו ערכים מותאמים אישית מאפשרים לך ליצור ולשפר מדדים משלך ב-Google Analytics.

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

בנאי/ת

// Custom Dimension.
public T SetCustomDimension(int dimensionNumber, string value);

// Custom Metric.
public T SetCustomMetric(int metricNumber, float value);

דוגמה

// Custom Dimension.
// An AppView hit example, but custom dimensions can be sent with all hit types.
googleAnalytics.LogScreen(new AppViewHitBuilder()
    .SetScreenName("Another screen")
    .SetCustomDimension(1, "200"));

// Custom Metric.
// An Event hit example, but custom metrics can be sent with all hit types.
googleAnalytics.LogEvent(new EventHitBuilder()
    .SetEventCategory("Achievement")
    .SetEventAction("Unlocked")
    .SetEventLabel("Slay 10 dragons")
    .SetEventValue(5)
    .SetCustomMetric(3, 81.5));

מקורות מידע שקשורים לנושא:

קמפיינים

מדידת קמפיינים ב-Google Analytics מאפשרת לשייך קמפיינים ומקורות תנועה לפעילות המשתמשים במשחק.

ניתן לשלוח פרמטרים של קמפיין כחלק מכל היט באמצעות השיטה Builder.

בנאי/ת

public T SetCampaignName(string campaignName);
public T SetCampaignSource(string campaignSource);
public T SetCampaignMedium(string campaignMedium);
public T SetCampaignKeyword(string campaignKeyword);
public T SetCampaignContent(string campaignContent);
public T SetCampaignID(string campaignID);

דוגמה

googleAnalytics.LogTiming(new TimingHitBuilder()
    .SetTimingCategory("Loading")
    .SetTimingInterval(50L)
    .SetTimingName("Main Menu")
    .SetTimingLabel("First load")
    .SetCampaignName("Summer Campaign")
    .SetCampaignSource("google")
    .SetCampaignMedium("cpc")
    .SetCampaignKeyword("games")
    .SetCampaignContent("Free power ups")
    .SetCampaignId("Summer1"));

// Send campaign parameters with timing hit.
// Builder Hit with minimum required Campaign parameters.
googleAnalytics.LogTiming(new TimingHitBuilder()
    .SetTimingCategory("Loading")
    .SetTimingInterval(50L)
    .SetTimingName("Main Menu")
    .SetTimingLabel("First load")
    .SetCampaignSource("google");

מקורות מידע שקשורים לנושא:

מתקדמת

השיטות האלה מומלצות רק למשתמשים מתקדמים ב-Google Analytics שמכירים את המושגים של מעקב המרות.

SetOnTracker

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

השתמשו במשתנים מ-Assets/Plugins/Fields.cs לפרמטר fieldName (למשל, Fields.SCREEN_NAME).

public void SetOnTracker(Field fieldName, object value);

דוגמה

googleAnalytics.SetOnTracker(Fields.SCREEN_NAME, "Main Menu");

מחיקה

פינוי משאבים מנוהלים ואיפוס מכשיר המעקב.

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

public void Dispose();

דוגמה

googleAnalytics.Dispose();