EUID Mobile Integration Overview for Android and iOS

This guide is an overview of integration options for mobile app publishers who want to integrate with EUID using the SDK for Android or the SDK for iOS.

note

This guide uses the group term EUID mobile SDKs to include both the SDK for Android and the SDK for iOS.

Introduction

EUID provides SDKs for Android/iOS that support the following:

• Generating the EUID token
• Refreshing the EUID token
• Storing the EUID token

For additional flexibility, EUID also provides alternative methods for some of the features and complementary products, such as EUID Google GMA/IMA Plugins. Available options are described in the individual guides: see Integration Overview: High-Level Steps.

Integrating with Single Sign-On (SSO)

If you integrate with one or more SSO providers to offer SSO login, you might be able to retrieve the logged-in user's email address from the SSO provider to generate EUID tokens.

For details, see Publisher Integration with SSO Providers.

Integration Overview: High-Level Steps

At a high level, to integrate your mobile app with EUID using the EUID mobile SDKs, you'll need to complete the following steps:

1. Complete the EUID account setup.

2. Client-Server Integration Only: Integrate server-side token generation.

3. Add the SDK for Android or iOS into your mobile app.

4. Configure the SDK.

5. Check that the token was successfully generated and then pass it for bidstream use.

6. Optionally, configure the EUID GMA/IMA plugins for integration with the Google GMA SDK and the Google IMA SDK.

For details, refer to one of the following guides:

• Client-Side Integration Guide for Mobile
• Client-Server Integration Guide for Mobile
• Client-Side Integration Guide for Mobile

Mobile Integration Paths

To determine the best integration path for your mobile scenario, consider these points:

1. Do you want to retrieve the EUID token on the client side or on the server side? See Client-Side, Client-Server, or Server-Side Integration?.

2. What do you want to use to retrieve and refresh the EUID token? See Generating, Storing, and Refreshing the EUID Token.

3. How do you want to use the EUID tokens? See Sending the Token to the Bidstream.

Client-Side, Client-Server, or Server-Side Integration?

The options for integrating with EUID using the EUID mobile SDKs are summarized in the following table. Choose the integration approach that's best for you.

For details, see Integration Approaches.

Scenario	Option	Integration Guide
You have access to personal data (email address or phone number) on the client side/within the mobile app, and want to keep changes within your app only.	Client-side integration	EUID Client-Side Integration Guide for Mobile
You have access to personal data on the server side only and can do the necessary development to generate EUID tokens server-side, but you want to refresh tokens on the client side—or you are using a Private Operator.	Client-Server Integration	EUID Client-Server Integration Guide for Mobile
You have access to personal data on the server side only and can do the necessary development to generate EUID tokens server-side, or you are using a Private Operator.	Server-Side Integration	EUID Server-Side Integration Guide for Mobile

Generating, Storing, and Refreshing the EUID Token

The following table summarizes the mobile integration options for managing the EUID token, including generating, storing, and refreshing the token, with links to the documentation for each option.

EUID Mobile Implementation Option	SDK Doc	Implementation Guide
EUID Android SDK	SDK for Android Reference Guide	One of the following: EUID Client-Side Integration Guide for Mobile EUID Client-Server Integration Guide for Mobile
EUID iOS SDK	SDK for iOS Reference Guide	One of the following: EUID Client-Side Integration Guide for Mobile EUID Client-Server Integration Guide for Mobile

Sending the Token to the Bidstream

There are many options for sending your EUID tokens to the bidstream.

The following table summarizes the options supported by EUID.

Scenario	Integration Guide
You want to use Google GMA to integrate video, banner, interstitial, or native ads into your Android app	Both of the following, in this sequence: EUID GMA Plugin for Android Integration Guide One of the following: Client-side: Optional: EUID GMA/IMA Plugin for GAM Secure Signals integration Client-server: Optional: EUID GMA/IMA Plugin for GAM Secure Signals integration
You want to use Google GMA to integrate video, banner, interstitial, or native ads into your iOS app	Both of the following, in this sequence: EUID GMA Plugin for iOS Integration Guide One of the following: Client-side: Optional: EUID GMA/IMA Plugin for GAM Secure Signals integration Client-server: Optional: EUID GMA/IMA Plugin for GAM Secure Signals integration
You want to use Google IMA to integrate multimedia ads into your Android app	Both of the following, in this sequence: EUID IMA Plugin for Android Integration Guide One of the following: Client-side: Optional: EUID GMA/IMA Plugin for GAM Secure Signals integration Client-server: Optional: EUID GMA/IMA Plugin for GAM Secure Signals integration
You want to use Google IMA to integrate multimedia ads into your iOS app	Both of the following, in this sequence: EUID IMA Plugin for iOS Integration Guide One of the following: Client-side: Optional: EUID GMA/IMA Plugin for GAM Secure Signals integration Client-server: Optional: EUID GMA/IMA Plugin for GAM Secure Signals integration
You want to use the Prebid Mobile SDK and Prebid Server to send out ad requests from your Android or iOS app	One of the following: Client-side: Optional: EUID Integration with Prebid Mobile SDK Client-server: Optional: EUID Integration with Prebid Mobile SDK

Functionality Summary

The following table summarizes the functionality available with the various integration options.

All options support either client-side or server-side integration.

Implementation Option	Generate Token from Personal Data	Refresh Token	Android/iOS?	Send Token to Bidstream
EUID SDK for Android	✅	✅	Android	*
EUID SDK for iOS	✅	✅	iOS	*
GMA Plugin for Android (Requires EUID SDK for Android)	—	—	Android	✅**
GMA Plugin for iOS (Requires EUID SDK for iOS)	—	—	iOS	✅**
IMA Plugin for Android (Requires EUID SDK for Android)	—	—	Android	✅**
IMA Plugin for iOS (Requires EUID SDK for iOS)	—	—	iOS	✅**
EUID Integration with Prebid Mobile SDK	—	—	Either	✅***

*You can combine the SDK with the IMA/GMA Plugin or the EUID Integration with Prebid Mobile SDK to send the token to the bidstream via Google or Prebid Server, or you can retrieve the token manually from the SDK and pass it to the bidstream in another way, according to your preference.

**After setup, Google GMA/IMA collects the token automatically and sends it to the bidstream.

***After setup, the EUID Integration with Prebid Mobile SDK adds the token into the ad request to Prebid Server.

FAQs for Mobile Integrations

Here is some FAQ information relating to EUID mobile integrations:

• iOS: Can I use Swift Package Manager and CocoaPods/Podspec together?

iOS: Can I use Swift Package Manager and CocoaPods/Podspec together?

For your EUID Mobile integration, you can install the EUID Mobile SDK, the EUID GMA Plugin, and the EUID IMA Plugin by either Swift Package Manager or CocoaPods.

Our recommendation:

• If you already use CocoaPods, particularly if you use it to integrate the Google Ad Frameworks yourself, it's best to use CocoaPods to integrate the EUID SDKs.
• If you're new to integrating dependencies, or you already have dependencies with Swift Package Manager, we recommend that you use Swift Package Manager for your EUID mobile integration.

caution

If you already use CocoaPods, this does not prevent your app from using Swift Package Manager (SPM) to integrate the EUID SDK and plugins. However, there is a potential conflict. If you already have GMA installed with CocoaPods, and you then install the EUID Mobile SDK, which itself includes GMA, with Swift Package Manager, you end up with two copies of GMA in your implementation, which does not work.

Therefore, if you already have GMA installed and want to install EUID, be sure that you first remove GMA from CocoaPods.

tip

Podspec is the name of the file in CocoaPods that defines the libraries to be integrated with the app.

Troubleshooting Tips for Mobile Integrations

Here's some additional information to help you troubleshoot your EUID mobile integrations:

• Android SDK Cannot Connect in Production Environment

Android SDK Cannot Connect in Production Environment

A good first step in troubleshooting is to look at the health check endpoint.

From your mobile device or Android emulator, see if you can reach this endpoint:

https://prod.euid.eu/ops/healthcheck

The response should be OK.

Some error responses indicate a networking problem resulting in your app not being able to reach the EUID endpoint. For example:

• Caused by java.net.UnknownHostException: Unable to resolve host "prod.euid.eu": No address associated with hostname

  The SDK tries to refresh the EUID token in the background. If an error such as an IOException occurs, the SDK retries multiple times. If retry is not successful, this exception is displayed.

Another good troubleshooting step is to enable logging. For details, see Enable Logging.