Skip to content
Affise SDK

Advertising module

Purpose

Section titled “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

Section titled “Module constant”
  • AffiseModules.ADVERTISING = "Advertising" (src/module/AffiseModules.ts:1-16)

TypeScript API

Section titled “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>

Platform notes

Section titled “Platform notes”

iOS

Section titled “iOS”
Affise.module.advertising.startModule()

Add the iOS subspec to your Podfile:

pod 'AffiseModule/Advertising', '1.7.8'

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

Android

Section titled “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

Section titled “Providers contributed”

From src/parameters/ProviderType.ts:86-93:

  • GAID_ADID
  • GAID_ADID_MD5
  • OAID
  • OAID_MD5
  • ADID
  • ALTSTR_ADID
  • FIREOS_ADID
  • COLOROS_ADID