Wtyczka Google Analytics dla Unity – dokumentacja API

W tym dokumencie opisujemy sposób wysyłania danych i listę wszystkich metod wtyczki Google Analytics dla Unity.

Wprowadzenie

Gdy przesyłasz dane do Google Analytics za pomocą wtyczki GA dla Unity, możesz użyć metody podstawowej lub konstruktora. Metody Kreatora są wymagane, jeśli chcesz dołączyć do działań parametry kampanii oraz wymiary i dane niestandardowe. Działania można wysyłać wymiennie.

Aby skonfigurować wtyczkę Google Analytics do środowiska Unity w swoim projekcie, postępuj zgodnie z przewodnikiem dla programistów.

Ogólne

Działania dyspozycyjne

Wysyła działania (wyświetlenia, zdarzenia itp.) do Google Analytics, jeśli jest dostępne połączenie sieciowe.

public void DispatchHits();

Przydatne materiały:

• Unikanie – pakiet Android SDK
• Unikanie – pakiet SDK do iOS

Kontrola sesji

Sesja to pojedynczy okres interakcji użytkownika z grą. Sesje są przydatnymi kontenerami mierzonej aktywności, która obejmuje wyświetlenia ekranu, zdarzenia i transakcje e-commerce.

Aby wymusić rozpoczęcie lub zakończenie sesji, możesz skorzystać z tych metod.

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

Przydatne materiały:

• Sesje – Android SDK
• Sesje – pakiet SDK do iOS

Ekrany

Ekrany w Google Analytics odzwierciedlają treść oglądaną przez użytkowników w Twojej grze. Widok ekranu składa się z pojedynczego ciągu znaków, który będzie używany jako nazwa ekranu w raportach Google Analytics.

Podstawowa

public void LogScreen(string title);

Monter

public void LogScreen(AppViewHitBuilder builder);

Przykład

googleAnalytics.LogScreen("Main Menu");

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

Przydatne materiały:

• Ekrany – Android SDK
• Ekrany – pakiet SDK na iOS

Zdarzenia

Zdarzenia to skuteczny sposób zbierania danych o interakcjach użytkownika z interaktywnymi komponentami gry, np. korzystaniem z konkretnego elementu. Zdarzenie składa się z 4 pól, których możesz użyć do opisania interakcji użytkownika z grą.

Podstawowa

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

Monter

public void LogEvent(EventHitBuilder builder);

Przykład

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

Przydatne materiały:

• Zdarzenia – pakiet Android SDK
• Zdarzenia – pakiet SDK na iOS

Błędy i wyjątki

Pomiary awarii i wyjątków umożliwiają pomiar liczby i typów wyłapywanych awarii oraz wyjątków, które występują w grze.

Podstawowa

public void LogException(string exceptionDescription, bool isFatal);

Monter

public void LogException(ExceptionHitBuilder builder);

Przykład

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

Przydatne materiały:

• Awarie && Wyjątki – Android SDK
• Awarie && Wyjątki – SDK dla iOS

Czas działań użytkownika

Pomiar czasu działań umożliwia natywny pomiar okresu w Google Analytics. Może to być przydatne przy pomiarach czasu wczytywania zasobów.

Podstawowa

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

Monter

public void LogTiming(TimingHitBuilder builder);

Przykład

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

Przydatne materiały:

• Czas działań użytkownika – Android SDK
• Czas działań użytkownika – pakiet SDK do iOS

Interakcje społecznościowe

Pomiar interakcji społecznościowych pozwala mierzyć interakcje użytkowników z różnymi widżetami udostępniania w sieciach społecznościowych i rekomendacjami umieszczonymi w treści.

Podstawowa

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

Monter

public void LogSocial(SocialHitBuilder builder);

Przykład

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

Przydatne materiały:

• Interakcje społecznościowe – pakiet Android SDK
• Interakcje społecznościowe – pakiet SDK do iOS

Handel elektroniczny

Pomiar e-commerce umożliwia wysyłanie do Google Analytics informacji o zakupach i sprzedaży w grze. Dane e-commerce w Google Analytics obejmują działania związane z transakcjami i produktami, które są powiązane ze wspólnym identyfikatorem transakcji.

Uwaga: poniższe metody wymagają włączenia e-commerce w raportach.

Transakcje

Podstawowa

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

Monter

public void LogTransaction(TransactionHitBuilder builder);

Przykład

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

Produkty

Podstawowa

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

Monter

public void LogItem(ItemHitBuilder builder);

Przykład

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

Przydatne materiały:

• Śledzenie e-commerce – Android SDK
• Śledzenie e-commerce – pakiet SDK do iOS

Niestandardowe wymiary i dane

Wymiary niestandardowe umożliwiają powiązanie metadanych z działaniami, użytkownikami i sesjami w Google Analytics, natomiast wskaźniki niestandardowe umożliwiają tworzenie i gromadzenie własnych danych w Google Analytics.

Przed ich użyciem musisz utworzyć i skonfigurować wymiary i dane niestandardowe. Po skonfigurowaniu danych możesz je wysyłać w ramach dowolnego działania za pomocą metody Builder.

Monter

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

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

Przykład

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

Przydatne materiały:

• Wymiary i dane niestandardowe – pakiet Android SDK
• Wymiary i dane niestandardowe – pakiet SDK na iOS

Kampanie

Pomiar kampanii w Google Analytics umożliwia przypisywanie kampanii i źródeł wizyt do aktywności użytkowników w grze.

Parametry kampanii można wysyłać w ramach dowolnych działań za pomocą metody Builder.

Monter

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

Przykład

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

Przydatne materiały:

• Pomiar kampanii – Android SDK
• Pomiar kampanii – pakiet SDK do iOS

Zaawansowane

Metody te są zalecane tylko dla doświadczonych użytkowników Google Analytics, którzy znają pojęcia śledzenia.

TrackerOnOn

Ustaw wartości w trackerze, aby przesyłać je z innymi działaniami.

Dla parametru fieldName (np. Fields.SCREEN_NAME) użyj zmiennych ze strony Assets/Plugins/Fields.cs.

public void SetOnTracker(Field fieldName, object value);

Uwaga: jeśli ustawisz wartość taką jak Fields.SCREEN_NAME, a następnie wywołasz metodę, która ustawia tę samą wartość, np. LogScreen(...), wartość ustawiona w module śledzenia zostanie zastąpiona wartością z metody.

Przykład

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

Utylizacja

Zwolnij zasoby zarządzane i zresetuj tracker.

Jeśli usuwanie jest nazywane kolejnym trafieniem śledzenia, będzie trzeba utworzyć nowy tracker, więc zalecamy wywoływanie tej metody tylko po zakończeniu śledzenia. Na przykład w metodzie onDispose(), która jest uruchamiana, gdy użytkownik opuszcza grę.

public void Dispose();

Przykład

googleAnalytics.Dispose();