@amazon-devices/kepler-adid-retriever

• Retrieve the advertising ID for bidding, reporting impressions, and reporting attributions of ads. (fetchAdvertisingId)
• Retrieve a user’s preference on interest-based advertisements. (isAdvertisingTrackingEnabled)

​

Behavior

• Verify tracking before you use the advertising ID. Call isAdvertisingTrackingEnabled and check the result before you use the value from fetchAdvertisingId for interest-based advertising. If it returns false, the user has opted out of interest-based advertising, so serve contextual (non-personalized) advertisements rather than interest-based ones.
• Child profiles. On a child profile, isAdvertisingTrackingEnabled returns false regardless of the Interest-based Ads setting. The user has opted out of interest-based advertising, so serve contextual (non-personalized) advertisements rather than interest-based ones.
• Service unavailable. fetchAdvertisingId returns an empty string if it cannot reach the Advertising Manager service. This does not raise an error. An empty string means the Advertising Manager service was unreachable. Do not use an empty string as a valid advertising ID.

​

Get Started

​

Setup

1. Add the following library dependency to the dependencies section of your package.json file.

      "@amazon-devices/kepler-adid-retriever": "~1.0.18",

2. In your manifest.toml, add the following components and wants required to access Ad ID Retriever.
   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"
   

​

Usage

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

​

API Reference

​

Classes

• AdIdRetriever — AdIdRetriever provides APIs for retrieving advertising IDs and advertising tracking state.