Ad revenue partner integration API

Premium

For:

Last update: May 21, 2024 08:00

At a glance: Configure ad revenue partner integrations for your AppsFlyer account or individual apps via API.

The ad revenue partner integration API is used to:

Set app-level ad revenue partner configurations for your entire account.
Get a list of current ad revenue partner configurations for your entire account.

To set (configure) ad revenue partner integrations via API:

Get your API V2 token from the AppsFlyer dashboard. Required for API authorization. Note: This must be done by the account admin.
Prepare the parameters to include in the API request, as described in the table that follows.
Give the parameter values your developer and tell them to follow the Set integrations API instructions in the dev hub.
Integration takes effect at 00:00 UTC the following day.

Request parameters
Parameter	Description
integrations	Top-level object that must include app_id, network, and products (listed below). Other fields could include credentials, event_name, and source_event.
app_id	The app ID for the app you want to integrate.
network	The partner you want to integrate. For a list of supported networks, see the network column of the Ad revenue partner API parameter table.
credentials	1 or more credentials required for the network integration. For the list of credentials, see the cred columns of the Ad revenue partner API parameter table.
event_name	Default value: af_ad_revenue Can also be a custom event name [beta] event_name isn't required if enabled is set to false.
products	List of all enabled products under an integration, including the parameters name, enabled, and if relevant, source_event (listed below). For a list of supported products per network, see the bulk API products column of the Ad revenue partner API parameter table.
name	The name of the integration type. For a list of integration type names, see the bulk API products column of the Ad revenue partner API parameter table.
enabled	Possible values: true false For app-level integration types, a source-event is required. If value is false, neither source_event nor event_name is required.
source_event	Relevant only for aggregate-level S2S API partner integrations. For app-level integration types, if enabled is set to true, a source_event is required.

To get a list of your ad revenue partner integrations via API:

Get your API V2 token from the AppsFlyer dashboard. Required for API authorization.
Tell your developer to follow the List integrations API instructions in the dev hub.

Spec	Remarks
Call limit	Up to 1,000 integrations within a single call.
OAuth	Partners that are integrated via OAuth (like Google and Facebook) aren't supported.