| title | UID2 Client-Server Integration Guide for Mobile |
|---|---|
| sidebar_label | Client-Server Integration for Mobile |
| pagination_label | UID2 Client-Server Integration Guide for Mobile |
| description | Setting up a mobile integration with token generate on server and refresh on client. |
| hide_table_of_contents | false |
| sidebar_position | 4 |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import Link from '@docusaurus/Link'; import ExampleAdvertisingToken from '/docs/snippets/_example-advertising-token.mdx'; import EnableLogging from '/docs/snippets/_mobile-docs-enable-logging.mdx'; import GMAIMA_Plugins from '/docs/snippets/_mobile_docs_gmaima-plugin-gss.mdx'; import PrebidMobileSDK from '/docs/snippets/_mobile_docs_prebid-mobile.mdx'; import ErrorResponseStates from '/docs/snippets/_mobile-docs-error-response-states.mdx';
This guide is for mobile app publishers who want to integrate with UID2 by generating UID2 tokens server-side via a Public Operator or Private Operator and then passing the tokens and user identities into their mobile apps, which will in turn pass the tokens for bidstream use.
This is called client-server integration because some integration steps are client-side and some are server-side.
If you want to integrate with UID2 via client-side only changes (that is, all integration changes required are within the mobile apps), refer to the UID2 Client-Side Integration Guide for Mobile instead.
This page provides a high-level overview of integration steps and links to additional documentation.
UID2 provides mobile SDKs for Android and iOS. Each SDK has the following features:
- Takes in a UID2 identity (a UID2 token and associated values) and persists it in local file storage.
- Automatically refreshes UID2 tokens.
:::note This guide uses the group term UID2 mobile SDKs to include both the SDK for Android and the SDK for iOS. :::
For FAQs relating to mobile publisher integrations, see FAQs for Mobile Integrations.
You'll need to complete the following steps:
- Complete the UID2 account setup.
- Implement server-side token generation.
- Add the UID2 mobile SDK to your mobile app.
- Configure the UID2 mobile SDK.
- Check that the token was successfully generated and then pass it for bidstream use.
- Optionally, integrate the UID2 GMA/IMA Plugin for GAM Secure Signals integration.
This guide provides instructions for using either of these UID2 mobile SDKs:
- SDK for Android (version 1.6.0 or later)
- SDK for iOS (version 1.7.0 or later)
For instructions for installing the correct SDK/version into your mobile app, see Add the UID2 Mobile SDK to Your Mobile App.
To set up your account, follow the steps described in Account Setup.
When account setup is complete, you'll receive your unique API key and client secret. These values are unique to you, and it's important to keep them secure. For details, see API Key and Client Secret.
The following diagram shows the data flow that the publisher must implement for UID2 client-server mobile integration.
This example uses the SDK for Android in the client-side mobile app and the SDK for Java on the server side.
For a client-server UID2 integration for mobile, the first step is to be able to generate the UID2 token on your server. Then, you can pass the token into your mobile apps for sending to the RTB bidstream.
For details, including instructions and examples, see Server-Side Token Generation.
You will need to pass the Identity response into the mobile app: see Configure the UID2 Mobile SDK.
:::warning For security reasons, the API key and secret used in token generation must be called server-side. Do not store these values inside a mobile app. :::
Token refresh is automatically enabled inside the UID2 mobile SDKs; you don't need to manage it explicitly on the server side.
You might decide to do server-side token refresh if you want to keep your changes in the mobile apps as simple as possible.
If you want to manage token refresh on the server side and not the client/mobile side, you can do so using one of the following:
-
Call the POST /token/refresh endpoint.
-
Use one of the Publisher Client classes, in one of the UID2 server-side SDKs. These classes simplify the request into a single method call.
For instructions, see SDK for Java, Usage for Publishers, Basic Usage Server-Side Integration section or SDK for Python, Usage for Publishers, Server-Side Integration section.
Then, pass the newly refreshed Identity value to the mobile app by following the rest of this guide.
For installation instructions, refer to one of the following:
At this point, you are ready to use the UID2 Identity generated server-side in the mobile SDK.
By default, the SDK is configured to work with the UID2 production environment: https://prod.uidapi.com. If you want to use the UID2 integration environment instead, provide the following URL in your call to UID2Manager initialization:
UID2Manager.init(
context = this,
UID2Manager.Environment.Custom("https://operator-integ.uidapi.com")
)// Must be set before UID2Manager.shared is accessed
UID2Settings.shared.uid2Environment = .custom(
url: URL(string: "https://operator-integ.uidapi.com")!
):::note Bear in mind the following differences between environments:
- Tokens from the UID2 integration environment are not valid for passing to the bidstream.
- You'll have a different set of API key and client secret values for each environment (integration and production). Be sure to use the correct values for each environment. :::
By default, this SDK makes calls to a UID2 production environment server in the USA.
For information about how to choose the best URL for your use case, and a full list of valid base URLs, see Environments.
To specify a UID2 server that is not the default, you can change it in the init call:
UID2Manager.init(
context = this,
UID2Manager.Environment.Signapore
)
// or
UID2Manager.init(
context = this,
UID2Manager.Environment.Custom("https://global.prod.uidapi.com")
)UID2Settings.shared.uid2Environment = .singapore
// or
UID2Settings.shared.uid2Environment = .custom(
url: URL(string: "https://global.prod.uidapi.com")!
)After you've instantiated UID2Manager correctly in your mobile app, you'll need to pass a UID2 identity generated server-side (see Implement server-side token generation), and then pass it into the mobile app using the setIdentity method, as shown in the following:
UID2Manager.getInstance().setIdentity()UID2Manager.shared.setIdentity()After you call the setIdentity method, the UID2 identity is persisted in local file storage.
:::warning The format of the file stored in the local file storage, or the filename itself, could change without notice. We recommend that you do not read or update the file directly. :::
To retrieve the token, in your mobile app, call the following:
UID2Manager.getInstance().getAdvertisingToken()UID2Manager.shared.getAdvertisingToken()If a successful identity was added into the UID2Manager, this method returns a string such as the following:
You can use this identity to pass downstream for sending in the RTB bidstream.
If the getAdvertisingToken() method call returns null, there was no identity or valid token generated. Some possible reasons for this, and some things you could do to troubleshoot, are as follows:
- The identity is invalid. In this scenario there are a couple of options:
- Check to see whether there are any errors from the previous
setIdentity()call. - Check the status of the identity, using one of the following:
- Android Java:
UID2Manager.getInstance().getCurrentIdentityStatus() - Android Kotlin:
UID2Manager.getInstance().currentIdentityStatus() - iOS:
UID2Manager.shared.identityStatus
- Android Java:
- Check to see whether there are any errors from the previous
- You could enable logging to get more information: see Enable Logging.
- The advertising token inside the UID2 identity has expired, and the refresh token has also expired, so the SDK cannot refresh the token.
If there is no identity, follow the instructions in Implement Server-Side Token Generation again, generate a new identity, and pass the result into your mobile app's UID2Manager again.
The best way to determine whether a new UID2 identity is required by the UID2 SDK again is to call the getAdvertisingToken() method in all cases:
UID2Manager.getInstance().getAdvertisingToken()UID2Manager.shared.getAdvertisingToken()On startup/resumption of the app, if getAdvertisingToken() returns null, it is time to generate new identity on the server by following the instructions in Implement Server-Side Token Generation. Then, pass the result into the mobile app’s UID2Manager again: see Configure the UID2 mobile SDK.
By default, after a valid UID2 identity has been passed into the UID2Manager, it performs automatic token refresh. If for any reason token refresh was disabled, you can enable it with the following method call:
Android Java:
UID2Manager.getInstance().setAutomaticRefreshEnabled(false)Android Kotlin:
UID2Manager.getInstance().automaticRefreshEnabled = falseUID2Manager.shared.automaticRefreshEnabled = false<GMAIMA_Plugins />