Analytics Kit Manual Conversion Guide

Precautions

• For details about how to migrate the Google Analytics SDK to the HMS Core Analytics SDK, please refer to sections HMS Core Analytics SDK Overview–Migration Procedure.
• Other sections describe how to manually convert APIs.

HMS Core Analytics SDK Overview

Analytics Kit brings you a range of preset analytics models so you can understand your users' behavior and gain a greater understanding of your users, products, and content. With this insight, you can take a data-driven approach to marketing your apps and optimizing your products.

Analytics Kit implements the following functions using data collected from apps:

• Track and report on custom events.
• Set up to 25 user attributes.
• Automate event collection and session calculation; preset event IDs and parameters.

Data Model Comparison

The Google Analytics SDK encapsulates various event matching types, such as screen views, events, social networking, and e-commerce, for you to use. After you set the operation type of an event, track() is used to report the event.

The HMS Core Analytics SDK uses an event analysis data model, which classifies all events by event name and event parameter. The Event-Param-User model is used to record data, describes events using parameters, and describes the characteristics of users.

Event Mapping Reference

Event Property Mapping Reference

If an event name (property) is not in the preceding mapping table, you can customize the event name and have it reported through onEvent(). For details about the property parameters for the preset event model, please refer to Predefined Events.

API Comparison

For details about the API usage of the Google Analytics SDK and HMS Core Analytics SDK, please refer to the API reference.

Migration Procedure

SDK Integration

For details about SDK integration, please refer to Integrating the HMS Core SDK.

Initialization

After configurations are imported successfully, initialize Analytics Kit in the onCreate method of the first Activity to obtain a HiAnalyticsInstance instance. If the agconnect-services.json file is incorrect, data cannot be collected at specified tracing points.

After obtaining the HiAnalyticsInstance instance, onEvent can be called to collect data at specified tracing points.

@Override 
protected void onCreate(Bundle savedInstanceState) { 
    super.onCreate(savedInstanceState); 
    setContentView(R.layout.activity_main); 
    HiAnalyticsTools.enableLog(); 
    HiAnalyticsInstance instance = HiAnalytics.getInstance(this); 
    Bundle bundle = new Bundle();
    bundle.putString(CATEGORY, "screen");
    bundle.putString(PRODUCTNAME, "screen name");
    instance.onEvent(VIEWPRODUCT, bundle);
}

Data Model Migration

Convert the events defined by the Google Analytics SDK to the preset models in the HMS Core Analytics SDK based on the event model mapping references in Event Mapping Reference and Event Property Mapping Reference. For details about the event model parameters, please refer to Predefined Events.

The following is the sample code of migrating purchase event recording from the Google Analytics SDK to the HMS Core Analytics SDK.

Context context = this;
// Purchase event recording by the Google Analytics SDK.
HitBuilders.ScreenViewBuilder builder = new HitBuilders.ScreenViewBuilder();
builder.setProductAction(
    new ProductAction(ProductAction.ACTION_PURCHASE)
        .setTransactionId("TT-1234")
        .setTransactionRevenue(3.14)
        .setTransactionCouponCode("EXTRA100"))
    .addProduct(new Product().setId("PID-4321").setName("Water Monkeys!"));
Tracker tracker = new Tracker(); // Obtain a tracker.
tracker.send(builder.build());
// Purchase event recording by the HMS Core Analytics SDK.
Bundle purchaseBundle = new Bundle();
purchaseBundle.putString(TRANSACTIONID, "TT-1234");
purchaseBundle.putDouble(REVENUE, 3.14);
purchaseBundle.putString(VOUCHER, "EXTRA100");
HiAnalyticsInstance instance = HiAnalytics.getInstance(context);
instance.onEvent(COMPLETEPURCHASE, purchaseBundle );

Precautions

• By default, the HMS Core Analytics SDK automatically collects activity screen events. Therefore, you do not need to manually set tracing points after migration from the Google Analytics SDK to the HMS Core Analytics SDK. To collect non-activity screen events, use the pageStart(String pageName, String pageClassOverride) and pageEnd(String pageName) APIs.
• The HMS Core Analytics SDK cannot automatically report uncaught exceptions. For function details, please refer to the Crash SDK.

AppMeasurementReceiver

For details about how to modify the AppMeasurementReceiver() and onReceive(Context context, Intent intent) methods, please refer to the following:

Before modification, ensure that Convertor has been used for conversion.

Before modification:

import org.xms.g.measurement.AppMeasurementReceiver;
...
@Override
public void onReceive(Context context, Intent intent) {
    ...
    AppMeasurementReceiver receiver = new AppMeasurementReceiver();
    receiver.onReceive(context, intent);
    ...
}

After modification:

import com.google.android.gms.measurement.AppMeasurementReceiver;
...
@Override
public void onReceive(Context context, Intent intent) {
    ...
    AppMeasurementReceiver receiver;
    if (!org.xms.g.utils.GlobalEnvSetting.isHms()) {
        receiver = new AppMeasurementReceiver ();
        receiver.onReceive(context, intent);
    }
    ...
}

AppMeasurementInstallReferrerReceiver

For details about how to modify the AppMeasurementInstallReferrerReceiver() and onReceive(Context context, Intent intent) methods, please refer to the following:

Before modification, ensure that Convertor has been used for conversion.

Before modification:

import org.xms.g.measurement.AppMeasurementInstallReferrerReceiver;
...
@Override
public void onReceive(Context context, Intent intent) {
    ...
    AppMeasurementInstallReferrerReceiver receiver = new AppMeasurementInstallReferrerReceiver();
    receiver.onReceive(context, intent);
    ...
}

After modification:

import com.google.android.gms.measurement.AppMeasurementInstallReferrerReceiver;
...
@Override
public void onReceive(Context context, Intent intent) {
    ...
    AppMeasurementInstallReferrerReceiver receiver;
    if (!org.xms.g.utils.GlobalEnvSetting.isHms()) {
        receiver = new AppMeasurementInstallReferrerReceiver();
        receiver.onReceive(context, intent);
    }
    ...
}

setCurrentScreen(Activity, String, String)

By default, the HMS Core Analytics SDK automatically collects activity screen events. Therefore, you do not need to manually set tracing points. To collect non-activity screen events, you are advised to use the pageStart(String pageName, String pageClassOverride) and pageEnd(String pageName) APIs.

Add HMS API

• The following provides a code modification example for the scenario where the setCurrentScreen(Activity, String, String) API is used on the activity screen:
  Collapse

  Word wrap

  Dark theme

  Copy code

  // todo
  import com.google.firebase.analytics.FirebaseAnalytics;
  ...
  @Override
  protected void onResume() {
      super.onResume();
      ...
      // todo
      if (!org.xms.g.utils.GlobalEnvSetting.isHms()) {
          FirebaseAnalytics instanceFA = FirebaseAnalytics.getInstance(this);
          instanceFA.setCurrentScreen(this, "ScreenName", null);
      }
      ...
  }

• The following provides a code modification example for the scenario where the setCurrentScreen(Activity, String, String) API is used on the non-activity screen:

  Before modification, ensure that Convertor has been used for conversion.

  Collapse

  Word wrap

  Dark theme

  Copy code

  import org.xms.f.analytics.ExtensionAnalytics;
  ...
  @Override
  public void onResume() {
      super.onResume();
      ...
      ExtensionAnalytics instanceFA = ExtensionAnalytics.getInstance(this.getActivity());
      instanceFA.setCurrentScreen(this.getActivity(), "ScreenName", "com.test.Fragment");
      ...
  }

  After modification:

  Collapse

  Word wrap

  Dark theme

  Copy code

  // todo
  import com.google.firebase.analytics.FirebaseAnalytics;
  import com.huawei.hms.analytics.HiAnalytics;
  import com.huawei.hms.analytics.HiAnalyticsInstance;
  ...
  @Override
  public void onResume() {
      super.onResume();
      ...
      // todo
      if (org.xms.g.utils.GlobalEnvSetting.isHms()) {
          HiAnalyticsInstance instanceHA = HiAnalytics.getInstance(this.getActivity());
          instanceHA.pageStart("ScreenName", "com.test.Fragment");
      } else {
          FirebaseAnalytics instanceFA = FirebaseAnalytics.getInstance(this.getActivity());
          instanceFA.setCurrentScreen(this.getActivity(), "ScreenName", "com.test.Fragment");
      }
      ...
  }
  ...
  @Override
  public void onPause() {
      super.onPause();
      ...
      // todo
      if (org.xms.g.utils.GlobalEnvSetting.isHms()) {
          HiAnalyticsInstance instanceHA = HiAnalytics.getInstance(this.getActivity());
          instanceHA.pageEnd("ScreenName");
      }
      ...
  }

To HMS API

• The following provides a modification suggestion for the scenario where the setCurrentScreen(Activity, String, String) API is used on the activity screen:

  By default, the HMS Core Analytics SDK automatically collects activity screen events. Therefore, you do not need to manually set tracing points. You are advised to delete the code related to the setCurrentScreen(Activity, String, String) API.

• The following provides a code modification example for the scenario where the setCurrentScreen(Activity, String, String) API is used on the non-activity screen:
  Before modification, ensure that Convertor has been used for conversion.

  Collapse

  Word wrap

  Dark theme

  Copy code

  import com.google.firebase.analytics.FirebaseAnalytics;
  ...
  @Override
  public void onResume() {
      super.onResume();
      ...
      FirebaseAnalytics instanceFA = FirebaseAnalytics.getInstance(this.getActivity());
      instanceFA.setCurrentScreen(this.getActivity(), "ScreenName", "com.test.Fragment");
      ...
  }

  After modification:

  Collapse

  Word wrap

  Dark theme

  Copy code

  import com.huawei.hms.analytics.HiAnalytics;
  import com.huawei.hms.analytics.HiAnalyticsInstance;
  ...
  @Override
  public void onResume() {
      super.onResume();
      ...
      // todo
      HiAnalyticsInstance instanceHA = HiAnalytics.getInstance(this.getActivity());
      instanceHA.pageStart("ScreenName", "com.test.Fragment");
      ...
  }
  ...
  @Override
  public void onPause() {
      super.onPause();
      ...
      // todo
      HiAnalyticsInstance instanceHA = HiAnalytics.getInstance(this.getActivity());
      instanceHA.pageEnd("ScreenName");
      ...
  }