KeplerAdIdRetrieverTurboModule usage guideline for application

AdIdRetriever is a service on device that retrieves advertising ID and advertising tracking state.

Use cases:

• An application can obtain an advertising ID for bidding, reporting impressions, and reporting attributions of ads. (fetchAdvertisingId)
• An application can obtain a user's preference on interest-based advertisements. (isAdvertisingTrackingEnabled)

Setup and Building

Add dependent TurboModule libraries to package.json

"dependencies": {
  "@amazon-devices/kepler-adid-retriever": "^1.0.6",
},

Add Package ID to manifest.toml

schema-version = 1

[package]
title = "UI React Native Application to test Advertising ID"
version = "1.0.0"
id = "com.amazon.kepleradiddemo"

[components]
[[components.interactive]]
id = "com.amazon.kepleradiddemo.main"
runtime-module = "/com.amazon.kepler.keplerscript.runtime.loader_2@IKeplerScript_2_0"
launch-type = "singleton"

[wants]
[[wants.service]]
id = "com.amazon.admanager.service.main"

Build

kepler build

Usage example for applications in src/App.tsx

import {
  AdIdRetriever,
} from '@amazon-devices/kepler-adid-retriever';

function doIsAdvertisingTrackingEnabled() {
  const isAdTrackingEnabled: boolean = AdIdRetriever.isAdvertisingTrackingEnabled();
  console.log(
    'adid-js-demo: isAdTrackingEnabled = ' + isAdTrackingEnabled,
  );
}

function doFetchAdvertisingId() {
  const advertisingId: string = AdIdRetriever.fetchAdvertisingId();
  console.log('adid-js-demo: advertisingId = ' + advertisingId);
}

export const AdIdManagerJsSampleMain = () => {
  const handleIsAdvertisingTrackingEnabled = () => {
    doIsAdvertisingTrackingEnabled();
  };
  const handleFetchAdvertisingId = () => {
    doFetchAdvertisingId();
  };

  // Custom-made "Focusable" is a focusable button
  return (
    <View style={styles.container}>
      <Focusable
        title="isAdvertisingTrackingEnabled"
        onPress={handleIsAdvertisingTrackingEnabled}
        testIdLabel="isAdvertisingTrackingEnabled"
      />
      <Focusable
        title="fetchAdvertisingId"
        onPress={handleFetchAdvertisingId}
        testIdLabel="fetchAdvertisingId"
      />
    </View>
  );