UID2 IMA Plugin for iOS Integration Guide

The UID2 Interactive Media Ads (IMA) Plugin for iOS enables publishers that use the Google IMA SDK for iOS to send UID2 tokens as secure signals in ad requests from iOS apps. This is done automatically, with no direct coding needed from the app developer.

Functionality

This plugin simplifies integration with Google Interactive Media Ads (IMA) for any publishers who want to support UID2 for apps running on iOS devices.

Version

This documentation is for the UID2 IMA Plugin for iOS version 1.0.0 or later.

GitHub Repository

This plugin is in the following open-source GitHub repository:

• https://github.com/IABTechLab/uid2-ios-plugin-google-ima

Complete UID2 Account Setup and Configure Account

To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the Account Setup page.

When initial account setup is complete, you'll receive instructions and a link to access the UID2 Portal, where you can create your credentials for the production environment and configure additional values, if needed. For details, see Getting Started with the UID2 Portal.

The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. Specific instructions are in each implementation guide. For a summary, see Client-Side or Client-Server Integration?.

Requirements

To run this plugin, install the following:

1. Google IMA SDK v3.19.1 or later:
   • SDK
   • Release history
2. SDK for iOS v1.7.0 or later:
   • SDK
   • SDK for iOS Reference Guide
3. UID2 IMA Plugin for iOS v1.0.0

Installation

Prerequisite: Install the Google Interactive Ads SDK and the SDK for iOS.

Install the UID2 iOS IMA Plugin via Swift Package Manager or CocoaPods to an existing app with the SDK for iOS and the Google Interactive Ads SDK installed.

There are three installation options:

• Package.swift
• Xcode
• CocoaPods

Installing with Package.swift

Add the following dependency to Package.swift:

dependencies: [
  .package(url: "https://github.com/IABTechLab/uid2-ios-plugin-google-ima.git", exact: "1.0.0")
]

Installing with Xcode

In the XCode user interface, under Package Dependencies, add the following entry for your apps:

Name	Location	Dependency Rule
uid2-ios-plugin-google-ima	git@github.com:IABTechLab/uid2-ios-plugin-google-ima.git	Exact Version: 1.0.0

Installing with CocoaPods

Add the following entry in your Podfile:

pod 'UID2IMAPlugin', '1.0.0'