Advertising module

Purpose

From JSDoc on AffiseAdvertising (src/module/advertising/AffiseAdvertising.ts:7):

iOS only / Start Advertising module

iOS only. Advertising Module starting Manually.

The Android side of the module reads Google Advertising ID automatically via the corresponding native artifact.

Module constant

• AffiseModules.ADVERTISING = "Advertising" (src/module/AffiseModules.ts:1-16)

TypeScript API

AffiseAdvertising (src/module/advertising/AffiseAdvertising.ts:7) implements AffiseModuleAdvertisingApi (src/module/advertising/AffiseModuleAdvertisingApi.ts:3):

Affise.module.advertising.startModule(): void
// AffiseModuleAdvertisingApi.ts:3-9
Affise.module.advertising.hasModule(): Promise<boolean>

Installation

Since 1.7.16 the module ships as its own npm package, affise-attribution-module-advertising (Android and iOS). Install it next to the core library:

npm install affise-attribution-lib
npm install affise-attribution-module-advertising

The package only pulls in the native dependency (com.affise:module-advertising / AffiseModule/Advertising at 1.7.16); its JS entry point is empty, so keep importing everything from affise-attribution-lib. Rebuild the native app (and run pod install on iOS) after installing.

Platform notes

Manual native alternative

The pod / implementation snippets below are the README’s “Modules → Manual Native” alternative to the npm package above.

iOS

Advertising module starts manually on iOS

On iOS the Advertising module is not started by Affise.start() — call Affise.module.advertising.startModule() after the user has granted AppTrackingTransparency consent. Without that call IDFA access stays blocked.

Affise.module.advertising.startModule()

NSUserTrackingUsageDescription is mandatory

The app will crash if the Advertising module is present and NSUserTrackingUsageDescription is missing from Info.plist.

<key>NSUserTrackingUsageDescription</key>
<string>Your permission text</string>

Add the iOS subspec to your Podfile:

pod 'AffiseModule/Advertising', '1.7.16'

The Affise Advertising module uses the AppTrackingTransparency framework to read advertisingIdentifier.

Android

Install the Maven artifact:

implementation "com.affise:module-advertising:$affise_version"

Automatic per README: “Advertising Identifier (google) tracking is supported automatically, no actions needed”.

Providers contributed

From src/parameters/ProviderType.ts:96-106:

• GAID_ADID
• GAID_ADID_MD5
• OAID
• OAID_MD5
• ADID
• ALTSTR_ADID
• FIREOS_ADID
• COLOROS_ADID
• AD_PERSONALIZATION (since 1.7.9)
• ADVERTISER_TRACKING_ENABLED (since 1.7.9)
• APPLICATION_TRACKING_ENABLED (since 1.7.9)