API Reference

Detailed reference for the Web Offerwall JavaScript API.

Read time 3 minutes

Last updated 6 months ago

init

Init call must be called before showing offerwall content. By default, offerwall content is being preloaded.


Tapjoy('init', options);

Option	Type	Default value	Description
`sdkKey</TableCell> <TableCell>ID</TableCell> <TableCell>` -`	Application SDK key.
`publisherUserId`	string	`-`	Publisher User ID used to reward users.
`ageRestrictedUser`	boolean	`false`	Refer to User Privacy for value descriptions.
`gdprConsentGiven`	boolean	`false`	Refer to User Privacy for value descriptions.
`userSubjectToGdpr`	boolean	`false`	Refer to User Privacy for value descriptions.
`usPrivacy`	string	`1---`	Refer to User Privacy for value descriptions.
`eventName`	string	`#WebOfferwall`	Placement name.
`preload`	boolean	`false`	Whether to preload offerwall content.
`callback`	function	`() => {}`	Callback when initialization has completed.
`userTags`	array	`[]`	User Tags. For example: `TAG1` , `TAG2`

Update call updates initial data and acts as a reset for the SDK.


Tapjoy('preload', options);

Option	Type	Default Value	Description
callback	function	`(err, status) => {}`	Callback when content is loaded

Init call must be called before showing offerwall content. By default, offerwall content is being preloaded.


Tapjoy('showOfferwall', options);

Option	Type	Default Value	Description
node	HTMLElement	`document.body`	N/A
callback	Function	`noop`	Function that is being called with current offerwall status

Closes any active offerwall windows.


Tapjoy('closeOfferwall');