/
API References

API References

YieldloveBannerAd

Prop

Mandatory

Description

Prop

Mandatory

Description

callString

true

Valid call string.

options

false

See AdOptions API below

onAdLoaded

false

Event handler function for "onAdLoaded"event. nativeEvent contains width: number and height: number of the loaded ad.

onAdFailedToLoad

false

Event handler function for "onAdFailedToLoad" event.

onAdOpened

false

Event handler function for "onAdOpened"event. Not supported on iOS.

onAdClosed

false

Event handler function for "onAdClosed"event. Not supported on iOS.

onAdClicked

false

Callback function for "onAdClicked" event.

onAdImpression

false

Callback function for "onAdImpression"event.

style

false

Style attributes for the view, as expected in a standard View.

Yieldlove

setApplicationName: (applicationName: string) => void

Set this at the start of your app to initialize Yieldlove SDK.

setDebug: (isDebugModeEnabled: boolean) => void

Enable debug logs from native libraries.

setCustomTargeting: (customTargeting: { [key: string]: string }) => void

Set global (default) custom targeting.

setContentUrl: (contentUrl: string) => void

Set global (default) content URL for targeting purposes.

clearConfigurationCache: () => void

For each application name, extended configuration is downloaded and cached on the user's device for a period of time. This function clears the cache. As a result, the next call to setApplicationName will always download a new copy of the configuration.

loadInterstitial: (options: LoadInterstitialParams, ) => void

Load interstitial ad. Available options:

Prop

Mandatory

Description

Prop

Mandatory

Description

callString

true

Valid call string.

options

false

See AdOptions below

onAdLoaded

false

Callback function for "onAdLoaded" event.

onAdFailedToLoad

false

Callback function for "onAdFailedToLoad"event. Expects single argument object which contains code: string and message: string describing the error.

showInterstitial: () => Promise<void>

Present loaded interstitial ad. Can reject with an error if the ad could not be presented (e.g. when trying to call showInterstitial before ad was actually loaded).

AdOptions

Prop

Mandatory

Type

Description

Prop

Mandatory

Type

Description

contentUrl

false

string

Content URL for targeting purposes. Will override the global content URL.

customTargeting

false

{ [key: string]: string }

An object containing key-value pairs used for custom targeting. Will merge with global custom targeting. A key redefined here take precedence over the globally defined one.

Error Events

The nativeEvent for the onAdFailedToLoad event handler contains code: number and message: string describing the error. Any error means no ad was delivered and rendered.

See ErrorCode enum to see the current list of supported codes. More may be added in future releases.

ErrorEvent

The nativeEvent implements the following interface:

Name

Type

Description

Name

Type

Description

code

ErrorCode (number)

Platform independent code that classifies the error

message

string

Message describing the error

ErrorCode enum

Name

Value (number)

Description

Name

Value (number)

Description

UNKNOWN

1

The error is unknown or unclassified

AD_SERVER_INTERNAL_REQUEST

2

Something happened internally; for instance, an invalid response was received from the ad server.

AD_SERVER_INVALID_REQUEST

3

The ad request was invalid; for instance, the ad unit ID was incorrect.

AD_SERVER_NETWORK_ERROR

4

The ad request was unsuccessful due to network connectivity.

AD_SERVER_NO_FILL

5

The ad request was successful, but no ad was returned due to lack of ad inventory.

Datenschutz
Impressum