Trình bổ trợ Google Analytics dành cho Unity – Tài liệu tham khảo API

Tài liệu này mô tả cách gửi dữ liệu và liệt kê tất cả các phương thức cho Trình bổ trợ Google Analytics dành cho Unity.

Giới thiệu

Khi gửi dữ liệu đến Google Analytics bằng Trình bổ trợ GA dành cho Unity, bạn có thể sử dụng phương thức Cơ bản hoặc phương thức Trình tạo. Bạn bắt buộc phải sử dụng phương thức trình tạo nếu muốn thêm thông số chiến dịch hoặc thứ nguyên hoặc chỉ số tùy chỉnh vào lượt truy cập. Bạn có thể gửi lượt truy cập bằng một trong hai phương thức thay thế cho nhau.

Làm theo Hướng dẫn dành cho nhà phát triển để thiết lập và định cấu hình Trình bổ trợ Google Analytics cho Unity cho dự án của bạn.

Giải pháp chung

Số lần truy cập điều phối

Điều phối các lượt truy cập (lượt xem, sự kiện, v.v.) đến Google Analytics nếu có kết nối mạng.

public void DispatchHits();

Thông tin có liên quan:

Kiểm soát phiên

Một phiên hoạt động đại diện cho một khoảng thời gian người dùng tương tác với trò chơi của bạn. Phiên hoạt động đóng vai trò là vùng chứa hữu ích của các hoạt động được đo lường, bao gồm lượt xem màn hình, sự kiện và giao dịch thương mại điện tử.

Bạn có thể dùng các phương thức sau để buộc một phiên bắt đầu hoặc kết thúc.

// 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();

Thông tin có liên quan:

Màn hình

Các màn hình trong Google Analytics thể hiện nội dung mà người dùng đang xem trong trò chơi của bạn. Lượt xem màn hình bao gồm một trường chuỗi đơn sẽ được dùng làm tên màn hình trong báo cáo Google Analytics.

Cơ bản

public void LogScreen(string title);

Trình tạo

public void LogScreen(AppViewHitBuilder builder);

Ví dụ:

googleAnalytics.LogScreen("Main Menu");

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

Thông tin có liên quan:

Sự kiện

Sự kiện là một cách hữu ích để thu thập dữ liệu về hoạt động tương tác của người dùng với các thành phần tương tác trong trò chơi, chẳng hạn như việc sử dụng một mặt hàng cụ thể. Một sự kiện bao gồm 4 trường mà bạn có thể dùng để mô tả hoạt động tương tác của người dùng với trò chơi.

Cơ bản

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

Trình tạo

public void LogEvent(EventHitBuilder builder);

Ví dụ:

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"));

Thông tin có liên quan:

Trục trặc và ngoại lệ

Tính năng đo lường sự cố và ngoại lệ cho phép bạn đo lường số lượng cũng như loại sự cố và ngoại lệ xảy ra trong trò chơi đã phát hiện được và chưa phát hiện.

Cơ bản

public void LogException(string exceptionDescription, bool isFatal);

Trình tạo

public void LogException(ExceptionHitBuilder builder);

Ví dụ:

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());

Thông tin có liên quan:

Thời gian người dùng

Việc đo lường thời gian người dùng cung cấp một cách thức riêng để đo lường một khoảng thời gian trong Google Analytics. Ví dụ: thuộc tính này có thể hữu ích khi đo lường thời gian tải tài nguyên.

Cơ bản

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

Trình tạo

public void LogTiming(TimingHitBuilder builder);

Ví dụ:

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));

Thông tin có liên quan:

Tương tác trên mạng xã hội

Tính năng đo lường lượt tương tác trên mạng xã hội cho phép bạn đo lường các lượt tương tác của người dùng với các tiện ích đề xuất và chia sẻ khác nhau trên mạng xã hội được nhúng trong nội dung của bạn.

Cơ bản

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

Trình tạo

public void LogSocial(SocialHitBuilder builder);

Ví dụ:

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"));

Thông tin có liên quan:

Thương mại điện tử

Tính năng đo lường thương mại điện tử cho phép bạn gửi các lượt mua hàng và lượt bán hàng trong trò chơi đến Google Analytics. Dữ liệu thương mại điện tử trong Google Analytics bao gồm các lượt truy cập giao dịch và mục, có liên quan đến một mã giao dịch được chia sẻ.

Giao dịch

Cơ bản

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);

Trình tạo

public void LogTransaction(TransactionHitBuilder builder);

Ví dụ:

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));

Mục

Cơ bản

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);

Trình tạo

public void LogItem(ItemHitBuilder builder);

Ví dụ:

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));

Thông tin có liên quan:

Thứ nguyên và chỉ số tùy chỉnh

Thứ nguyên tùy chỉnh cho phép liên kết siêu dữ liệu với lượt truy cập, người dùng và phiên trong Google Analytics, trong khi chỉ số tùy chỉnh cho phép bạn tạo và tăng chỉ số của riêng bạn trong Google Analytics.

Bạn phải tạo và định cấu hình Phương diện tuỳ chỉnh và Chỉ số tuỳ chỉnh trước khi sử dụng. Sau khi định cấu hình, bạn có thể gửi dữ liệu dưới dạng một phần của bất kỳ lượt truy cập nào bằng cách sử dụng phương thức Builder (Trình tạo).

Trình tạo

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

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

Ví dụ:

// 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, "200"));

Thông tin có liên quan:

Chiến dịch

Việc đo lường chiến dịch trong Google Analytics cho phép phân bổ chiến dịch và nguồn lưu lượng truy cập cho hoạt động của người dùng trong trò chơi của bạn.

Bạn có thể gửi các thông số chiến dịch dưới dạng một phần của bất kỳ lượt truy cập nào bằng cách sử dụng phương thức Builder (Trình tạo).

Trình tạo

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);

Ví dụ:

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");

Thông tin có liên quan:

Nâng cao

Các phương thức này chỉ được đề xuất cho những người dùng thành thạo của Google Analytics đã quen thuộc với các khái niệm về trình theo dõi.

SetOnTracker

Đặt giá trị trên trình theo dõi sẽ được gửi cùng với các lượt truy cập khác.

Sử dụng các biến trong Assets/Plugins/Fields.cs cho thông số fieldName (ví dụ: Fields.SCREEN_NAME).

public void SetOnTracker(Field fieldName, object value);

Ví dụ:

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

Loại bỏ

Giải phóng các tài nguyên được quản lý và đặt lại thiết bị theo dõi.

Nếu loại bỏ được gọi, thì lượt truy cập theo dõi tiếp theo sẽ phải tạo một trình theo dõi mới. Vì vậy, bạn chỉ nên gọi phương thức này khi đã hoàn tất quá trình theo dõi. Ví dụ: trong phương thức onDispose() sẽ thực thi khi người dùng thoát khỏi trò chơi.

public void Dispose();

Ví dụ:

googleAnalytics.Dispose();