Skip to content

Latest commit

 

History

History
275 lines (223 loc) · 9.04 KB

README.md

File metadata and controls

275 lines (223 loc) · 9.04 KB
Raw

Axeptio Mobile SDK Samples

Welcome to the Axeptio Mobile SDK Samples project! This repository demonstrates how to implement the Axeptio Android SDK in your mobile applications.

Overview

The project consists of two modules:

  • samplejava: Illustrates the usage of the Axeptio SDK with Java and XML.
  • samplekotlin: Demonstrates the integration of the Axeptio SDK with Kotlin and Compose.

Each module can be build with the variant brands or publishers given your requirements.

Getting Started

To get started with testing the Axeptio SDK sample apps, follow these steps:

  1. Clone this repository to your local machine:

    git clone https://github.com/axeptio/sample-app-android

  2. Provide your Github access token for the Axeptio SDK in the settings.gradle.kts project's file.

maven {  
	url = uri("https://maven.pkg.github.com/axeptio/axeptio-android-sdk")  
	credentials {  
		username = "" // TODO: Username  
		password = "" // TODO: Read package token  
	}  
}

  1. Choose the appropriate sample module (samplejava or samplekotlin) based on your preferred language and UI framework.

  2. Choose the build variant corresponding to your need (publishers or brands).

Axeptio SDK implementation

Axeptio CMP android sdk.

Gradle implementation

The SDK is hosted by Github Packages. It supports Android SDK versions >= 26.

First, add the maven repository to your settings.gradle file. The provided github token must have the scope read:packages enabled.

Kotlin DSL

dependencyResolutionManagement {
    ...
    repositories {
        google()
        mavenCentral()
        maven {
            url = uri("https://maven.pkg.github.com/axeptio/axeptio-android-sdk")
            credentials {
               username = "[GITHUB_USERNAME]"
               password = "[GITHUB_TOKEN]"
            }
        }
    }
}

Groovy

repositories {
    maven {
        url = uri("https://maven.pkg.github.com/axeptio/tcf-android-sdk")
        credentials {
           username = "[GITHUB_USERNAME]"
           password = "[GITHUB_TOKEN]"
        }
   }
}

Then add the package dependency to your build.gradle file.

Kotlin DSL

dependencies {  
	implementation("io.axept.android:android-sdk:[latest_version]")
}

Groovy

dependencies {
    implementation 'io.axept.android:android-sdk:[latest_version]'
}

For more details, you can refer to the Github documentation.

Initialize the SDK

Initialize the SDK inside the onCreate() of your main activity.

Kotlin

override fun onCreate(savedInstanceState: Bundle?) {  
	super.onCreate(savedInstanceState)  
  
	AxeptioSDK.instance().initialize(  
		activity = this@MainActivity,
        targetService = [AxeptioService.PUBLISHERS_TCF || AxeptioService.BRANDS],
		cliendId = [your_client_id],  
		cookiesVersion = [your_cookies_version],
		token = [optional_consent_token]  
	)  
  
}

Java

@Override  
protected void onCreate(@Nullable Bundle savedInstanceState) {  
	super.onCreate(savedInstanceState);
  
	Axeptio axeptio = AxeptioSDK.instance();  
	axeptio.initialize(
		MainActivity.this,
        [AxeptioService.PUBLISHERS_TCF || AxeptioService.BRANDS],
		[your_project_id],  
		[your_configuration_id],
		[optional_consent_token]
	);
  
}

The consent pop up will automatically open if the user's consents are expired or haven't been registered yet.

Publishers You can transfer a user's consents by providing his Axeptio token. The SDK will automatically update the user's SharedPreferences according to the TCFv2 IAB documentation.

Show consent popup on demand

Additionally, you can request the consent popup to open on demand.

Kotlin

AxeptioSDK.instance().showConsentScreen(activity = activity, managePreferencesUseCase = true)

Java

AxeptioSDK.instance().showConsentScreen(activity, true);

Popup events

When closing, the consent popup will trigger an event which you can listen by setting an AxeptioEventListener.

Kotlin

AxeptioSDK.instance().setEventListener(object : AxeptioEventListener {  
	override fun onPopupClosedEvent() {  
		// Do something
	}  
})

Java

AxeptioSDK.instance().setEventListener(new AxeptioEventListener() {
	@Override
	public void onPopupClosedEvent() {
		AxeptioEventListener.super.onPopupClosedEvent();
	}
});

Sharing consents with other web views

This feature is only available for publishers service.

The SDK provides a helper function to append the axeptio_token query param to any URL. You can precise a custom user token or use the one currently stored in the SDK.

Kotlin

AxeptioSDK.instance().appendAxeptioToken(
   uri = Uri.parse("https://myurl.com"),
   token = AxeptioSDK.instance().token ?: ""
)

Will return https://myurl.com?axeptio_token=[token]

Clear user's consent choices

Kotlin

AxeptioSDK.instance().clearConsents()

Google Consent v2

Instructions on how to integrate Google Consent Mode with the Axeptio SDK in your Android application.

If you haven't already, add Firebase Analytics to your Android project.

When user consent is collected through your CMP, the SDK will set the IABTCF_EnableAdvertiserConsentMode key in the Shared Preferences to true.

Register to Google Consent updates

Axeptio SDK provides a callback to listen to Google Consent updates. You'll have to map the consent types and status to the corresponding Firebase models. You can then update Firebase analytics consents by calling Firebase analytics' setConsent().

Kotlin

AxeptioSDK.instance().setEventListener(object : AxeptioEventListener {  
	override fun onGoogleConsentModeUpdate(consentMap:Map<GoogleConsentType,GoogleConsentStatus>) {  
		val firebaseConsentMap = consentMap.entries.associate { (type, status) ->  
			val firebaseConsentType = when (type) {  
				GoogleConsentType.ANALYTICS_STORAGE -> ConsentType.ANALYTICS_STORAGE  
				GoogleConsentType.AD_STORAGE -> ConsentType.AD_STORAGE  
				GoogleConsentType.AD_USER_DATA -> ConsentType.AD_USER_DATA  
				GoogleConsentType.AD_PERSONALIZATION -> ConsentType.AD_PERSONALIZATION  
			}	  
  
			val firebaseConsentStatus = when (status) {  
				GoogleConsentStatus.GRANTED -> ConsentStatus.GRANTED  
				GoogleConsentStatus.DENIED -> ConsentStatus.DENIED  
			}  
			firebaseConsentType to firebaseConsentStatus  
		}  
		Firebase.analytics.setConsent(firebaseConsentMap)  
	}  
})

Java

        AxeptioSDK.instance().setEventListener(new AxeptioEventListener() {
            @Override
            public void onGoogleConsentModeUpdate(@NonNull Map<GoogleConsentType, ? extends GoogleConsentStatus> consentMap) {
                AxeptioEventListener.super.onGoogleConsentModeUpdate(consentMap);

                Map<FirebaseAnalytics.ConsentType, FirebaseAnalytics.ConsentStatus> firebaseConsentMap = new HashMap<>();

                for (Map.Entry<GoogleConsentType, ? extends GoogleConsentStatus> entry : consentMap.entrySet()) {
                    FirebaseAnalytics.ConsentType firebaseConsentType = null;
                    switch (entry.getKey()) {
                        case ANALYTICS_STORAGE:
                            firebaseConsentType = FirebaseAnalytics.ConsentType.ANALYTICS_STORAGE;
                            break;
                        case AD_STORAGE:
                            firebaseConsentType = FirebaseAnalytics.ConsentType.AD_STORAGE;
                            break;
                        case AD_USER_DATA:
                            firebaseConsentType = FirebaseAnalytics.ConsentType.AD_USER_DATA;
                            break;
                        case AD_PERSONALIZATION:
                            firebaseConsentType = FirebaseAnalytics.ConsentType.AD_PERSONALIZATION;
                            break;
                    }

                    FirebaseAnalytics.ConsentStatus firebaseConsentStatus = null;
                    switch ((GoogleConsentStatus) entry.getValue()) {
                        case GRANTED:
                            firebaseConsentStatus = FirebaseAnalytics.ConsentStatus.GRANTED;
                            break;
                        case DENIED:
                            firebaseConsentStatus = FirebaseAnalytics.ConsentStatus.DENIED;
                            break;
                    }

                    if (firebaseConsentType != null && firebaseConsentStatus != null) {
                        firebaseConsentMap.put(firebaseConsentType, firebaseConsentStatus);
                    }

                }

                FirebaseAnalytics.getInstance(MainActivity.this).setConsent(firebaseConsentMap);
            }
        });