In-App JS-Widget Parameters
Navigate to Paid Recommendations

Please Note

1.In-App JS-Widget technology is deprecated. Please consult with your Account Manager regarding upgrading your app to use SDK technology.

2. Following the developer guide instructions is mandatory to ensure app compliance.

3. Please make sure to follow the entire guide before submitting your app to Outbrain QA.

Mobile apps specific JS-Widget parameters

It is mandatory to pass the following mobile apps specific parameters when using Outbrain JS-Widget in mobile applications:

data-ob-installation-type, data-ob-user-id, data-ob-app-ver, data-ob-installation-key

Example:

<div class="OUTBRAIN" data-src="http://DROP_PERMALINK_HERE"
data-widget-id="DROP_WIDGET_ID_HERE" 
data-ob-template="DROP_TEMPLATE_NAME_HERE" 
data-ob-installation-type="app_js_widget"
data-ob-user-id="GOOGLE_APPLE_ADVERTISING_ID"
data-ob-app-ver="DROP_APPLICATION_VERSION_HERE"
data-ob-installation-key="DROP_PARTNER_KEY_HERE"></div>

 

Installation Type

Add the following attribute to the div code:

data-ob-installation-type ="app_js_widget"

Application version

Add the application version to the div code

data-ob-app-ver="DROP_APPLICATION_VERSION_HERE"

Partner Key

Add the partner key that you received from your account manager

data-ob-installation-key="DROP_PARTNER_KEY_HERE"

Google/Apple Advertising ID

It is mandatory to pass the Google or Apple 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) – see examples below.
This should be tested before submitting your app to Outbrain QA.

The data-ob-user-id attribute should be added to the Outbrain div.

data-ob-user-id="GOOGLE_APPLE_ADVERTISING_ID"

In case the user is opted-out:

data-ob-user-id="null"

 


Navigate to Paid Recommendations

There are two options for opening Outbrain paid recommendations

Option 1: Use SFSafariViewController(iOS)/ChromeCustomTab(Android) or Safari/Chrome browsers for all paid recommendations.

For this option, please make sure to open the paid recommendation via Outbrain redirect URL (paid.outbrain.com) without any URL manipulation.

OR

Option 2: Integrate Outbrain SDK and use Outbrain OBWebView/OBWKWebview classes and SFSafariViewController/ChromeCustomTab, based on the SDK response for each paid recommendation.

If you are using option 2, please refer to the following guides:

iOS
Android

Optional parameter for HTTPS support

In case your app needs to support HTTPS calls to Outbrain’s back end, please add to the div code:

data-is-secured="true"