Create, update, get, and delete ad revenue partner integrations for many apps at once, using the Ad Revenue Integrations API.
Requires ROI360.
About the API
Use the Ad Revenue Integrations API to manage ad revenue integrations in bulk instead of one by one in the platform. With one API call you can:
- Create or update integrations for one or more apps and partners
- Get the integrations of specific apps, or of all apps in your account
- Delete integrations of specific apps, for all partners or only some of them
For each app and partner, you can set one integration type:
| Integration type (as in the platform) | API value | Partner credentials | Source event |
|---|---|---|---|
| Aggregate level via S2S API | aggregate_s2s |
Required | Required |
| Device-level via S2S API | device_s2s |
Required | - |
| Impression-level via SDK | impression_sdk |
- | - |
| Impression-level (via SDK) with device-level (via S2S API) | impression_sdk_and_device_s2s |
Required | - |
To learn more about each integration type, see Integration types for ad revenue attribution.
Before you begin
- Get the API V2 token. Only the account admin can retrieve it. Learn more
- For each app, decide which partners and integration types you need. Not all partners support all integration types. See List of ad revenue integrated partners.
- Get the API credentials from each partner. You don't need credentials for Impression-level via SDK.
- For Aggregate level via S2S API, choose the source event (for example,
af_app_opened). Ad revenue is recorded as<source_event>_monetized.
Set up integrations via API
- Prepare the list of integrations: app ID, partner, integration type, credentials, and source event (where required).
- Give your developer the API V2 token and this list.
- Ask your developer to follow the Ad Revenue Integrations API instructions in the DevHub. The credentials each partner needs are listed in Partner credentials.
- Check the integrations in AppsFlyer: Settings > Revenue Settings > Ad revenue, or with the Get integrations API.
The same rules apply as in the platform. For example, if you use a mediation platform, don't keep separate integrations for the networks it mediates, to avoid duplicate data.
When changes take effect
| Action | Takes effect |
|---|---|
| Create a new integration | Immediately |
| Update an existing integration (including a change of integration type) | At 00:00 UTC the following day |
| Delete an integration | Immediately |
Specs and limitations
| Spec | Remarks |
|---|---|
| Call limit | Up to 1,000 integrations in one create or update call. |
| All or nothing | If one integration in a call fails, none of the integrations in that call are applied. |
| Update | An update fully replaces the existing integration of that app and partner (integration type, credentials, and source event). |
| Enable / disable | Not supported. To stop an integration, delete it. |
| Credentials | Not returned by the Get integrations API. |
| Status and Test connection | Available only in the platform. |
| OAuth partners | Aggregate level via S2S API integrations for Meta ads, Google AdMob, and Google Ad Manager use OAuth, so you can set them up only in the platform. Google AdMob Impression-level via SDK integrations can be set up via the API. |
| API v1.0 | No longer available. If you used it, see Migrating from API v1.0. |