Ad

Ad endpoints are used to present ads to users, and grant rewards to them for doing so.

The system uses an external ad provider to present opportunities to the user. Currently, the only supported provider is Unity Ads. Please contact your RallyHere representative for more information.

Note that each endpoint can return a x-hz-ad-api-token header, which should be reused whenever possible for future requests. This is an optimization that should improve future request times, as they won't require a secondary authentication with the external ad provider.

📄️ Begin New Session

Start a new session for the user. This will generate a new ad api token that is returned in the response header.

📄️ Find Opportunities

Find ad opportunities for the user given optional screen sizes. This will generate a new ad api token that is returned in the response header.

📄️ Update Opportunity By Id

Update the opportunity with the given id. This will generate a new ad api token that is returned in the response header.

📄️ Unity Ad Watched

Callback URL for the Unity Ad API. Docs here https://docs.unity.com/ads/ImplementingS2SRedeemCallbacks.html

📄️ Unity Mediation Ad Watched

Callback URL for the Unity Ad API. Docs here https://docs.unity.com/mediation/S2SRedeemCallbacks.html