Skip to content

Commit

Permalink
Merge pull request #745 from IABTechLab/ccm-UID2-4063-update-uid2-doc…
Browse files Browse the repository at this point in the history
…-after-euid-work

Update uid2 doc after euid work
  • Loading branch information
caroline-ttd authored Oct 24, 2024
2 parents 6f5a2c2 + 0c53bda commit f0d7abc
Show file tree
Hide file tree
Showing 18 changed files with 100 additions and 89 deletions.
6 changes: 3 additions & 3 deletions docs/guides/integration-mobile-client-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@ You'll need to complete the following steps:

## Mobile SDK Version

This guide provides instructions for using version 1.2.0 or higher of either of these UID2 mobile SDKs:
This guide provides instructions for using either of these UID2 mobile SDKs:

- SDK for Android
- SDK for iOS
- 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](#add-the-uid2-mobile-sdk-to-your-mobile-app).

Expand Down
19 changes: 14 additions & 5 deletions docs/guides/integration-mobile-client-side.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ To integrate with UID2 client-side, you'll need to complete the following steps:

## Mobile SDK Version

This guide provides instructions for using version 1.2.0 or higher of either of these UID2 mobile SDKs:
This guide provides instructions for using either of these UID2 mobile SDKs:

- SDK for Android
- SDK for iOS
- 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](#add-the-uid2-mobile-sdk-to-your-mobile-app).

Expand All @@ -67,7 +67,8 @@ Follow the applicable instructions, for Android or iOS:

1. Check out the main branch of the [SDK for Android source code repository on GitHub](https://github.com/IABTechLab/uid2-android-sdk/tree/main).
1. In Android Studio (check the version required in the [Minimum Requirements](../sdks/sdk-ref-android.md#minimum-requirements) section in the SDK for Android Reference Guide), open the directory that you checked out.
1. Run the **dev-app** app.
1. set `uid2_environment_euid` to `false` in [AndroidManifest.xml](https://github.com/IABTechLab/uid2-android-sdk/blob/main/dev-app/src/main/AndroidManifest.xml).
2. Run the **dev-app** app.
1. When you've started the app, make sure that the **Client Side** checkbox is checked.
1. Enter an email or phone number, and then click the arrow to the right.

Expand All @@ -80,6 +81,14 @@ Follow the applicable instructions, for Android or iOS:
```js
Development/UID2SDKDevelopmentApp/UID2SDKDevelopmentApp.xcodeproj
```
1. Set the `UID2EnvironmentEUID` key to `NO` in `Development/UID2SDKDevelopmentApp/UID2SDKDevelopmentApp/Info.plist` in Xcode's editor. Alternatively you can use `plutil` from the command line:
```console
plutil -replace UID2EnvironmentEUID -bool NO Development/UID2SDKDevelopmentApp/UID2SDKDevelopmentApp/Info.plist
```
To use a EUID environment,
```console
plutil -replace UID2EnvironmentEUID -bool YES Development/UID2SDKDevelopmentApp/UID2SDKDevelopmentApp/Info.plist
```
1. Run the **UID2SDKDevelopmentApp** app scheme.
1. When you've started the app, make sure that the **Client Side** checkbox is checked.
1. Enter an email or phone number, and then click the arrow to the right.
Expand Down Expand Up @@ -710,7 +719,7 @@ If the response status indicates that the DII has been opted out of UID2, you mi
## Optional: UID2 Prebid Mobile SDK Integration
:::important
The UID2 Prebid Mobile SDK integration requires version 1.4.0 of the UID2 SDK for Android, or version 1.5.0 of the UID2 SDK for iOS.
The UID2 Prebid Mobile SDK integration requires version 1.6.0 of the UID2 SDK for Android, or version 1.7.0 of the UID2 SDK for iOS.
:::
<PrebidMobileSDK />
Expand Down
14 changes: 7 additions & 7 deletions docs/guides/mobile-plugin-gma-android.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ This plugin simplifies integration with Google Mobile Ads (GMA) for any publishe

## Version

<!-- As of 2023-07-15 -->
<!-- As of 2024-10-23 -->

This documentation is for the UID2 GMA Plugin for Android version 0.5.0 and later.
This documentation is for the UID2 GMA Plugin for Android version 1.6.0 and later.

## GitHub Repository

Expand All @@ -34,17 +34,17 @@ To run this plugin, install the following:
1. Google Mobile Ads SDK v22.0.0 or later:
- [SDK](https://developers.google.com/admob/android/sdk)
- [Release notes](https://developers.google.com/admob/android/rel-notes)
1. SDK for Android v0.5.0 or later:
1. SDK for Android v1.6.0 or later:
- [SDK](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk)
- [SDK for Android Reference Guide](../sdks/sdk-ref-android.md)
1. [UID2 Android GMA Plugin v0.5.0](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk-gma/)
1. [UID2 Android GMA Plugin v1.6.0](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk-gma/)
1. If you are using R8 or Proguard, add the applicable option specified in [Notes for Using R8 or ProGuard](#notes-for-using-r8-or-proguard)

## Installation

Prerequisite: Install the Google Mobile Ads SDK and the SDK for Android.

Install the UID2 Android GMA Plugin v0.5.0 to an existing app with the SDK for Android and Google GMA SDK installed. There are two installation options:
Install the UID2 Android GMA Plugin v1.6.0 to an existing app with the SDK for Android and Google GMA SDK installed. There are two installation options:

- [Gradle](#gradle)
- [Maven](#maven)
Expand All @@ -54,7 +54,7 @@ Install the UID2 Android GMA Plugin v0.5.0 to an existing app with the SDK for A
To install with Gradle, add the SDK as a dependency in the `build.gradle` file:

```js
implementation 'com.uid2:uid2-android-sdk-gma:0.5.0'
implementation 'com.uid2:uid2-android-sdk-gma:1.6.0'
```

### Maven
Expand All @@ -65,7 +65,7 @@ To install with Maven, add the SDK as a dependency in the `pom.xml` file:
<dependency>
<groupId>com.uid2</groupId>
<artifactId>uid2-android-sdk-gma</artifactId>
<version>0.5.0</version>
<version>1.6.0</version>
</dependency>
```

Expand Down
18 changes: 9 additions & 9 deletions docs/guides/mobile-plugin-gma-ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ This plugin simplifies integration with Google Mobile Ads (GMA) for any publishe

## Version

<!-- As of 2024-04-17 -->
<!-- As of 2024-10-22 -->

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

## GitHub Repository

Expand All @@ -34,10 +34,10 @@ To run this plugin, install the following:
1. Google Mobile Ads SDK v10.7.0 or later:
- [SDK](https://developers.google.com/admob/ios)
- [Release Notes](https://developers.google.com/admob/ios/rel-notes)
1. SDK for iOS v0.3.2 or later:
1. SDK for iOS v1.7.0 or later:
- [SDK](https://github.com/IABTechLab/uid2-ios-sdk)
- [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md)
1. [UID2 GMA Plugin for iOS v0.3.2](https://github.com/IABTechLab/uid2-ios-plugin-google-gma)
1. [UID2 GMA Plugin for iOS v1.0.0](https://github.com/IABTechLab/uid2-ios-plugin-google-gma)

## Installation

Expand All @@ -57,22 +57,22 @@ Add the following dependency to Package.swift:

```js
dependencies: [
.package(url: "https://github.com/IABTechLab/uid2-ios-plugin-google-gma.git", exact: "0.3.2")
.package(url: "https://github.com/IABTechLab/uid2-ios-plugin-google-gma.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-gma | `[email protected]:IABTechLab/uid2-ios-plugin-google-gma.git` | Exact Version: 0.3.2 |
| Name | Location | Dependency Rule |
| :--- | :--- |:---------------------|
| uid2-ios-plugin-google-gma | `[email protected]:IABTechLab/uid2-ios-plugin-google-gma.git` | Exact Version: 1.0.0 |

### Installing with CocoaPods

Add the following entry in your `Podfile`:

```
pod 'UID2GMAPlugin', '0.3.2'
pod 'UID2GMAPlugin', '1.0.0'
```
12 changes: 6 additions & 6 deletions docs/guides/mobile-plugin-ima-android.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ This plugin simplifies integration with Google Interactive Media Ads (IMA) for a

## Version

<!-- As of 2023-07-15 -->
<!-- As of 2024-10-23 -->

This documentation is for the UID2 IMA Plugin for Android version 0.5.0 and later.
This documentation is for the UID2 IMA Plugin for Android version 1.6.0 and later.

## GitHub Repository

Expand All @@ -34,10 +34,10 @@ To run this plugin, install the following:
1. Google IMA SDK v3.30.3 or later:
- [SDK](https://developers.google.com/interactive-media-ads/docs/sdks/android/client-side)
- [Release history](https://developers.google.com/interactive-media-ads/docs/sdks/android/client-side/history)
1. SDK for Android v0.5.0 or later:
1. SDK for Android v1.6.0 or later:
- [SDK](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk)
- [SDK for Android Reference Guide](../sdks/sdk-ref-android.md)
1. [UID2 IMA Plugin for Android v0.5.0](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk-ima)
1. [UID2 IMA Plugin for Android v1.6.0](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk-ima)
1. If you are using R8 or Proguard, add the applicable option specified in [Notes for Using R8 or ProGuard](#notes-for-using-r8-or-proguard)

## Installation
Expand All @@ -54,7 +54,7 @@ Install the UID2 Android IMA Plugin to an existing app with the SDK for Android
To install with Gradle, add the SDK as a dependency in the `build.gradle` file:

```js
implementation 'com.uid2:uid2-android-sdk-ima:0.5.0'
implementation 'com.uid2:uid2-android-sdk-ima:1.6.0'
```

### Maven
Expand All @@ -65,7 +65,7 @@ To install with Maven, add the SDK as a dependency in the `pom.xml` file:
<dependency>
<groupId>com.uid2</groupId>
<artifactId>uid2-android-sdk-ima</artifactId>
<version>0.5.0</version>
<version>1.6.0</version>
</dependency>
```

Expand Down
18 changes: 9 additions & 9 deletions docs/guides/mobile-plugin-ima-ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ This plugin simplifies integration with Google Interactive Media Ads (IMA) for a

## Version

<!-- As of 2024-04-17 -->
<!-- As of 2024-10-22 -->

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

## GitHub Repository

Expand All @@ -34,10 +34,10 @@ To run this plugin, install the following:
1. Google IMA SDK v3.19.1 or later:
- [SDK](https://developers.google.com/interactive-media-ads/docs/sdks/ios/client-side)
- [Release history](https://developers.google.com/interactive-media-ads/docs/sdks/ios/client-side/history)
1. SDK for iOS v0.3.2 or later:
1. SDK for iOS v1.7.0 or later:
- [SDK](https://github.com/IABTechLab/uid2-ios-sdk)
- [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md)
1. [UID2 IMA Plugin for iOS v0.3.2](https://github.com/IABTechLab/uid2-ios-plugin-google-ima)
1. [UID2 IMA Plugin for iOS v1.0.0](https://github.com/IABTechLab/uid2-ios-plugin-google-ima)

## Installation

Expand All @@ -57,22 +57,22 @@ Add the following dependency to Package.swift:

```js
dependencies: [
.package(url: "https://github.com/IABTechLab/uid2-ios-plugin-google-ima.git", exact: "0.3.2")
.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 | `[email protected]:IABTechLab/uid2-ios-plugin-google-ima.git` | Exact Version: 0.3.2 |
| Name | Location | Dependency Rule |
| :--- | :--- |:---------------------|
| uid2-ios-plugin-google-ima | `[email protected]:IABTechLab/uid2-ios-plugin-google-ima.git` | Exact Version: 1.0.0 |

### Installing with CocoaPods

Add the following entry in your `Podfile`:

```
pod 'UID2IMAPlugin', '0.3.2'
pod 'UID2IMAPlugin', '1.0.0'
```
8 changes: 4 additions & 4 deletions docs/sdks/sdk-ref-android.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ You'll be granted permission to use specific functions offered by the SDK, and g

## SDK Version

<!-- As of 7 May 2024 -->
<!-- As of 23 Oct 2024 -->

This documentation is for the SDK for Android version 1.2.0 and later.
This documentation is for the SDK for Android version 1.6.0 and later.

For current and past release notes information, see [https://github.com/IABTechLab/uid2-android-sdk/releases](https://github.com/IABTechLab/uid2-android-sdk/releases).

Expand Down Expand Up @@ -87,7 +87,7 @@ To install with Gradle, add the SDK as a dependency in the build.gradle
file:

```js
implementation 'com.uid2:uid2-android-sdk:1.2.0'
implementation 'com.uid2:uid2-android-sdk:1.6.0'
```

### Installing with Maven
Expand All @@ -98,7 +98,7 @@ To install with Maven, add the SDK as a dependency in the `pom.xml` file:
<dependency>
<groupId>com.uid2</groupId>
<artifactId>uid2-android-sdk</artifactId>
<version>1.2.0</version>
<version>1.6.0</version>
</dependency>
```

Expand Down
14 changes: 8 additions & 6 deletions docs/sdks/sdk-ref-ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ You'll be granted permission to use specific functions offered by the SDK, and g

## SDK Version

<!-- As of 7 May 2024 -->
<!-- As of 22 Oct 2024 -->

This documentation is for the SDK for iOS version 1.2.0 and later.
This documentation is for the SDK for iOS version 1.7.0 or later.

For current and past release notes information, see [https://github.com/IABTechLab/uid2-ios-sdk/releases](https://github.com/IABTechLab/uid2-ios-sdk/releases).

Expand All @@ -57,7 +57,9 @@ This SDK is in the following open-source GitHub repository:
Minimum requirements for this SDK are as follows:

- Xcode version: 15.0+
- iOS minimum target version: 13.0+
- iOS minimum target version:
- For full functionality: 13.0+ƒ
- For partial functionality: 12.0+. The app with the SDK integrated can be installed with all devices, but generating or retrieving UID2 tokens on the client side will not work with devices running iOS versions below 13.0.
- tvOS minimum target version: 13.0+
- Swift version: 5.0+

Expand All @@ -77,7 +79,7 @@ Add the following dependency to Package.swift:

```js
dependencies: [
.package(url: "https://github.com/IABTechLab/uid2-ios-sdk.git", from: "1.2.0"),
.package(url: "https://github.com/IABTechLab/uid2-ios-sdk.git", from: "1.7.0"),
]
```

Expand All @@ -87,14 +89,14 @@ In the XCode user interface, under Package Dependencies, add the following entry

| Name | Location | Dependency Rule |
| :--- | :--- |:----------------------------------------|
| uid2-ios-sdk | `[email protected]:IABTechLab/uid2-ios-sdk.git` | Up to next major version: 1.2.0 < 2.0.0 |
| uid2-ios-sdk | `[email protected]:IABTechLab/uid2-ios-sdk.git` | Up to next major version: 1.7.0 < 2.0.0 |

### Installing with CocoaPods

Add the following entry in your `Podfile`:

```
pod 'UID2', '~> 1.2'
pod 'UID2', '~> 1.7'
```

## Usage Guidelines
Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/_mobile_docs_prebid-mobile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To configure your UID2 Prebid for Mobile integration, follow these steps:
<TabItem value='gradle' label='Gradle (Android)'>
Include the following in your Gradle configuration:
```js
implementation("com.uid2:uid2-android-sdk-prebid:1.5.0")
implementation("com.uid2:uid2-android-sdk-prebid:1.6.0")
```
</TabItem>
<TabItem value='maven' label='Maven (Android)'>
Expand All @@ -32,7 +32,7 @@ To configure your UID2 Prebid for Mobile integration, follow these steps:
<dependency>
<groupId>com.uid2</groupId>
<artifactId>uid2-android-sdk-prebid</artifactId>
<version>1.5.0</version>
<version>1.6.0</version>
</dependency>
```
</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ UID2Settings.shared.uid2Environment = .custom(
```js
UID2Manager.init(
context = this,
serverUrl = "https://global.prod.uidapi.com"
UID2Manager.Environment.Signapore
)
// or
UID2Manager.init(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -711,7 +711,7 @@ If the response status indicates that the DII has been opted out of UID2, you mi
## Optional: UID2 Prebid Mobile SDK Integration

:::important
UID2 Prebid Mobile SDK インテグレーションは、UID2 SDK for Android version 1.4.0 または UID2 SDK for iOS version 1.5.0 が必要です。
UID2 Prebid Mobile SDK インテグレーションは、UID2 SDK for Android version 1.6.0 または UID2 SDK for iOS version 1.7.0 が必要です。
:::

<PrebidMobileSDK />
Loading

0 comments on commit f0d7abc

Please sign in to comment.