Integrate PlaytimeWeb
Get Started
To seamlessly integrate PlaytimeWeb into your iOS app, you only need to offer users the option to open the PlaytimeWeb URL. We suggest placing this option prominently in your app, such as in a native banner or button on the homepage. The basic structure of the Redirect URL is:
The user_id
and idfa
parameters in the URL help accurately identify the user for rewarding purposes, ensuring any currency earned via PlaytimeWeb is promptly paid out.
Additionally, you can include extra parameters in the URL, and these values will be sent back to you through the Server-to-Server payout URL
Supported URL Parameters
user_id*
A custom identifier you can assign to each user. If you haven't set one, adjoe generates it automatically. This ID is necessary for S2S Payouts, thus required. Ensure this value is url-safe
.
required
idfa*
The Identifier for Advertisers (IDFA) is a random device identifier assigned by Apple to a user’s device and is used by advertisers to track user's advertising data.
recommended
placement
The placement of the PlaytimeWeb button inside your app, e.g., "Main Screen"
, "Shop"
, "Interstitial"
, "More Diamonds Screen"
, etc.
optional
ua_channel
User Acquisition Channel. The channel within the network from which the user was acquired, e.g. incentivized
or video campaigns
.
optional
ua_network
User Acquisition Network. The network through which the user was acquired, e.g., Adwords
, Facebook
, or Organic
.
optional
ua_subpublisher_encrypted
The encrypted package name or app id of the sub-publisher app within the network from which the user was acquired.
optional
gender
There are three available options you can pass in: "female", "male", "unknown".
optional
age
The current age of the user, e.g., 32.
optional
pub_sub_id_1
These are optional identifiers used in your backend. They will be provided back in the S2S payout.
optional
pub_sub_id_2
See pub_sub_id_1
optional
pub_sub_id_3
See pub_sub_id_1
optional
pub_sub_id_4
See pub_sub_id_1
optional
pub_sub_id_5
See pub_sub_id_1
optional
Accept Tracking
While the IDFA parameter is not required, we recommend including it. This means you should trigger the App Tracking Transparency popup so the user can "Allow" tracking. When a user selects "Play Now" in the Playtime Offerwall, we use a pop-up to remind them to allow tracking.
Use a WebView
A WebView or SFSafariViewController or iFrame can be used to show the PlaytimeWeb URL. You may need to configure the navigation actions to open the app-store URL, as the webView may have it's own protocols for intercepting the URL requests. If you do not allow these url-schemes, certain functionality - like our support chatbot - will not work.
Allow the following url-schemes
https
itms-appss
itms-apps
about:srcdoc
Test the Integration
Open PlaytimeWeb from your app.
Download a game.
Return to PlaytimeWeb. You should see the game under the "My Games" section.
If you do not see the game in "My Games" try resetting your IDFA.
Reset the IDFA
Delete the game if it was already installed.
Go to
Settings > Privacy > Tracking
, toggleAllow Apps to Request to Track
off.Return to PlaytimeWeb and select
Ask Apps to Stop Tracking
(if prompted), then toggleAllow Apps to Request to Track
back on.Install the game again from PlaytimeWeb.
User Experience
Users need to accept adjoe's Terms of Service (TOS) to use Playtime and access games/apps. Agreeing to the TOS is mandatory before installing any partner apps.
For iOS users Apple provides an opportunity to use the iCloud Private Relay service, which can be enabled in the device settings. If the user has it enabled, then we cannot track the user’s real IP, since all the requests would be proxied via Apple servers. This can have an impact on our ability to reward users for playing games or using apps. In cases where iCloud Private Relay enabled, users would see the following messages asking them to disable it. We will not permit users to user Playtime without disabling this feature.
Last updated