All the In-App implementation requires consultation with your Account Manager and QA process before going live.
|Attribute Name||Requirement||Description||Example value|
||Required||The store URL of the App||“https://play.google.com/store/apps/details?id=com.king.candycrushsaga”|
||Required for bundleUrl||The 2-letter ISO 639-1 language code||“en”|
||Required When App has Web content||The permalink of placement to identify the currently displayed content. Must be used together with
||Required for contentUrl||The App’s unique identifier iOS: Bundle ID, Android: Application ID/Package Name||“com.king.candycrushsaga”|
||Required||The widget id that you received from your Account Manager||“AR_1”|
||Required||The Advertising ID(IDFA/AAID) assigned by the device or operating environment||“EA7583CD-A667-48BC-B806-42ECB2B48606”|
||Required||The partner key that you received from your Account Manager||“DEMOP1MN24J3E1MGLQ92067LH”|
||Limited usage||String value for additional section-level reporting breakdowns. Allowed characters: alphanumeric and underscore ‘_’. Requires permission from your Sales Engineer or Partner Manager.||“minus1”|
||Optional||A version number of the App||“1.0.0”|
||Optional||A unique key for report breakdowns. See Engage External Id Report API for details||“123abcXYZ”|
||Optional||A secondary key for Engage External Id Report breakdowns as same as
||Optional:Only if TCF API is not available||Base64-encoded consent string, as defined by the IAB for TCF v2.0||“CO4SiGQO4SiGQAGABBENAzCgAP…(omitted)…YAAAAAAAAAAA”|
||Optional||Version of consent string||“2”|
||Optional||An image pixel URL for tracking clicks on paid recommendations||“https://yourdomain.com/click?123”|
Parameters in detail
The store URL of the App in App distribution platform. Currently Google play store, Apple App store, Facebook App, Huawei App Gallery formats are supported.
|Store Name||URL format||Example Value|
|Google Play Store||https://play.google.com/store/apps/details?id=
|Apple App Store||http://apps.apple.com/
|Microsoft App Store||https://www.microsoft.com/store/apps/
|Huawei App Gallery||https://appgallery.cloud.huawei.com/ag/n/app/
It is mandatory to pass the Advertising ID for Outbrain installations in mobile apps, according to Google and Apple guidelines and developer agreements.
In compliance with Google and Apple guidelines, if the user is opted out of ad tracking, please pass the value
null (case sensitive) as a value
Our JS Widget is fully compliant to TCF v2.0 and it will automatically fetch consent string from CMPs, so there’s no need to pass consent string manually. However, if the WebView does not support TCF API, it’s possible to pass consent string directly to widgets by using the
Navigate to Paid Recommendations
Chrome browsers for all paid recommendations.
Please make sure to open the Outbrain redirect URL (paid.outbrain.com) directly without any URL manipulation.
Smartfeed is not supported in-App WebView JS Widget installation.
Widget Callback Events
Custom callback scripts can be supported by Widget External Event Handler
For example, the Ad fill status of the widget can be checked by scanning the value of
widgetDataReturned event. *Widgets must be shown to users even the Ad slots are not fully filled.
Mandatory setup for Android App: Charles Proxy Support
In order to verify that your app is working according to our guidelines, we use a software called Charles Proxy to monitor the networking coming in and out of the app.
For Android 7.0 or newer, you need to add configuration to your app in order to have it trust the SSL certificates generated by Charles SSL Proxying. In order to configure your app to trust Charles, you need to add a Network Security Configuration File to your app.
This file can override the system default, enabling your app to trust user installed CA certificates (e.g. the Charles Root Certificate). You can specify that this only applies in debug builds of your application, so that production builds use the default trust profile.
Add a file
res/xml/network_security_config.xml to your app:
<network-security-config> <debug-overrides> <trust-anchors> <!-- Trust user added CAs while debuggable only --> <certificates src="user" /> </trust-anchors> </debug-overrides> </network-security-config>
Then add a reference to this file in your app’s manifest, as follows:
<?xml version="1.0" encoding="utf-8"?> <manifest ... > <application android:networkSecurityConfig="@xml/network_security_config" ... > ... </application> </manifest>