User ID

Foreword

AT Internet’s SDK allows you to choose from three types of user ID in order to track your visitors. You can also choose to use a custom ID. You’ll be able to find this ID in the idclient variable present in hits.

Available identifications

The choice of type of ID to use is first made in the Tag Composer setup interface. It is also possible to modify this parameter directly in your application’s code. The different types are:

We recommend you to read the official Android best practices regarding the use of identifiers

Custom ID

With our SDK, you can force the use of a custom type of customer ID.

Limited AdTracking

The use of an advertising identifier (advertisingId, googleAdId or huaweiOAId) is subject to the user’s willingness to disable advertising tracking in which case the user cannot be identified.

By default, if the user activates limited ad tracking, it will be considered as opt-out, and will therefore be excluded from the analyses.

Since version 2.11.2, the AT Internet SDK allows you to modify this behavior using the ignoreLimitedAdTracking configuration key. When this configuration is active and the user has enabled limited ad tracking, the identification mode automatically switches to the UUID type.

Decision tree

Here is a diagram showing the decision tree of the user ID used by the SDK, depending on the configuration.

Tagging examples

For versions prior to 2.12.1, the SDK automatically switches to the Advertising ID if the format of predefined types is not respected: “androidId”, “advertisingId”, “UUID” (case sensitive).

Since version 2.12.1, the SDK automatically switches to the unique identifier (UUID) if the format of the predefined types is not respected: “androidId”, “advertisingId”, “UUID” (not case sensitive).

1. Selecting Android ID as ID type
   • Using the method setConfig()

     ATInternet.getInstance().getDefaultTracker().setConfig("identifier", "androidId", new SetConfigCallback() {
                             @Override
                             public void setConfigEnd() {
                                 Log.d(null, "SDK is now using Android ID as visitor identifier");
                             }
                         });

   • Using the method setIdentifierType()

     ATInternet.getInstance().getDefaultTracker().setIdentifierType(Tracker.IdentifierType.androidId, new SetConfigCallback() {
                             @Override
                             public void setConfigEnd() {
                                 Log.d(null, "SDK is now using Android ID as visitor identifier");
                             }
                         });

2. Selecting Advertising ID as ID type
   • Using the method setConfig()

     ATInternet.getInstance().getDefaultTracker().setConfig("identifier", "advertisingId", new SetConfigCallback() {
                             @Override
                             public void setConfigEnd() {
                                 Log.d(null, "SDK is now using Advertising ID as visitor identifier");
                             }
                         });

   • Using the method setIdentifierType()

     ATInternet.getInstance().getDefaultTracker().setIdentifierType(Tracker.IdentifierType.advertisingId, new SetConfigCallback() {
                             @Override
                             public void setConfigEnd() {
                                 Log.d(null, "SDK is now using Advertising ID as visitor identifier");
                             }
                         });

   • Activation of the configuration related to limited advertising tracking

     ATInternet.getInstance().getDefaultTracker().setIgnoreLimitedAdTrackingEnabled(true, null, true);

3. Selecting UUID as ID type
   • Using the method setConfig()

     ATInternet.getInstance().getDefaultTracker().setConfig("identifier", "UUID", new SetConfigCallback() {
                             @Override
                             public void setConfigEnd() {
                                 Log.d(null, "SDK is now using UUID as visitor identifier");
                             }
                         });

   • Using the method setIdentifierType()

     ATInternet.getInstance().getDefaultTracker().setIdentifierType(Tracker.IdentifierType.UUID, new SetConfigCallback() {
                             @Override
                             public void setConfigEnd() {
                                 Log.d(null, "SDK is now using UUID as visitor identifier");
                             }
                         });

4. Selecting a custom ID

   ATInternet.getInstance().getDefaultTracker().setParam("idclient", "123ABC");

Examples of ID generated by default according to configuration (version 2.12.1 and higher):

ATInternet.getInstance().getDefaultTracker().setConfig("identifier", "", null, true); // &idclient=xxxxxxxxxxxxxxxx (androidId)
ATInternet.getInstance().getDefaultTracker().setConfig("identifier", "error", null, true); // &idclient=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (UUID)
ATInternet.getInstance().getDefaultTracker().setConfig("identifier", "androidId", null, true); // &idclient=xxxxxxxxxxxxxxxx (androidId)
ATInternet.getInstance().getDefaultTracker().setConfig("identifier", "advertisingId", null, true); // &idclient=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (advertisingId)
ATInternet.getInstance().getDefaultTracker().setConfig("identifier", "uuid", null, true); // &idclient=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (UUID)