Class: APSAds
Constructors
constructor
• new APSAds()
Methods
addCustomAttribute
▸ Static addCustomAttribute(key, value): void
Adds a custom attribute to the APSAds SDK.
Parameters
| Name | Type | Description |
|---|---|---|
key | string | The key of the custom attribute |
value | string | The value of the custom attribute |
Returns
void
Defined in
initialize
▸ Static initialize(appKey): Promise<void>
Initializes the APSAds SDK.
Parameters
| Name | Type | Description |
|---|---|---|
appKey | string | Generated APS app key from the APS portal |
Returns
Promise<void>
Defined in
removeCustomAttribute
▸ Static removeCustomAttribute(key): void
Removes a custom attribute from the APSAds SDK.
Parameters
| Name | Type | Description |
|---|---|---|
key | string | The key of the custom attribute |
Returns
void
Defined in
setAdNetworkInfo
▸ Static setAdNetworkInfo(adNetworkInfo): void
Sets the primary ad server or mediator.
Parameters
| Name | Type | Description |
|---|---|---|
adNetworkInfo | AdNetworkInfo | AdNetworkInfo object containing the primary ad network and its properties |
Returns
void
Defined in
setMRAIDPolicy
▸ Static setMRAIDPolicy(policy): void
Sets the MRAID policy.
Parameters
| Name | Type | Description |
|---|---|---|
policy | MRAIDPolicy | MRAIDPolicy value. MRAIDPolicy.DFP for Google Ad Manager and MRAIDPolicy.CUSTOM for other ad server / mediation. |
Returns
void
Defined in
setMRAIDSupportedVersions
▸ Static setMRAIDSupportedVersions(versions): void
Sets the MRAID versions supported by user ad server.
Parameters
| Name | Type | Description |
|---|---|---|
versions | string[] | Array of supported versions |
Returns
void
Defined in
setTestMode
▸ Static setTestMode(enabled): void
Enable / disable the test mode for APSAds.
Parameters
| Name | Type | Description |
|---|---|---|
enabled | boolean | Whether to enable or disable the test mode. |
Returns
void
Defined in
setUseGeoLocation
▸ Static setUseGeoLocation(enabled): void
Enable / disable the geo location tracking for APSAds.
Parameters
| Name | Type | Description |
|---|---|---|
enabled | boolean | Whether to enable or disable the geo location tracking. |
Returns
void