Skip to content

Commit 60655ce

Browse files
committed
Merge branch 'main' into gwh-APIDOCS-1474-LiveRamp-doc
2 parents fa9a354 + b710a00 commit 60655ce

28 files changed

+118
-91
lines changed

docs/endpoints/post-token-generate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ You must include only **one** of the following four conditional parameters, plus
5353
### Request Examples
5454

5555
:::important
56-
To ensure that the API key used to access the service remains secret, the `POST /token/generate` endpoint must be called from the server side, unlike the [POST /token/refresh](post-token-refresh.md), which does not require using an API key.
56+
To ensure that the API key used to access the service remains secret, the `POST /token/generate` endpoint must be called from the server side, unlike [POST /token/refresh](post-token-refresh.md) which does not require using an API key. If you want to generate tokens on the client side, see [Client-Side Integration Options](../guides/integration-options-publisher-web.md#client-side-integration-options) (for web-based implementations) or [UID2 Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md).
5757
:::
5858

5959
The following are unencrypted JSON request body examples for each parameter, one of which you should include in your token generation requests:

docs/guides/integration-javascript-client-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ For an example of what a UID2 token might look like in the bidstream, when it's
121121
```
122122

123123
:::info
124-
You need to consider how you pass the returned advertising token to SSPs. With some other approaches to client-side UID2 implementation, such as using `Prebid.js` (see [UID2 Integration Overview for Prebid.js](integration-prebid.md)) or Google Ad Manager Secure Signals (see [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md)), the implementation includes functions that manage passing the returned advertising token. If you're using the SDK for JavaScript you'll need to manage this yourself.
124+
You need to consider how you pass the returned advertising token to SSPs. With some other approaches to client-side UID2 implementation, such as using `Prebid.js` (see [UID2 Integration Overview for Prebid](integration-prebid.md)) or Google Ad Manager Secure Signals (see [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md)), the implementation includes functions that manage passing the returned advertising token. If you're using the SDK for JavaScript you'll need to manage this yourself.
125125
:::
126126

127127
:::tip

docs/guides/integration-mobile-client-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ You'll need to complete the following steps:
5151
This guide provides instructions for using either of these UID2 mobile SDKs:
5252

5353
- SDK for Android (version 1.6.0 or later)
54-
- SDK for iOS(version 1.7.0 or later)
54+
- SDK for iOS (version 1.7.0 or later)
5555

5656
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).
5757

docs/guides/integration-mobile-client-side.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ To integrate with UID2 client-side, you'll need to complete the following steps:
5252
This guide provides instructions for using either of these UID2 mobile SDKs:
5353

5454
- SDK for Android (version 1.6.0 or later)
55-
- SDK for iOS(version 1.7.0 or later)
55+
- SDK for iOS (version 1.7.0 or later)
5656

5757
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).
5858

@@ -67,7 +67,7 @@ Follow the applicable instructions, for Android or iOS:
6767

6868
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).
6969
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.
70-
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).
70+
1. In [AndroidManifest.xml](https://github.com/IABTechLab/uid2-android-sdk/blob/main/dev-app/src/main/AndroidManifest.xml), set `uid2_environment_euid` to `false`.
7171
2. Run the **dev-app** app.
7272
1. When you've started the app, make sure that the **Client Side** checkbox is checked.
7373
1. Enter an email or phone number, and then click the arrow to the right.
@@ -81,11 +81,11 @@ Follow the applicable instructions, for Android or iOS:
8181
```js
8282
Development/UID2SDKDevelopmentApp/UID2SDKDevelopmentApp.xcodeproj
8383
```
84-
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:
84+
1. In `Development/UID2SDKDevelopmentApp/UID2SDKDevelopmentApp/Info.plist` in Xcode's editor, set the `UID2EnvironmentEUID` key to `NO`. Alternatively, you can use `plutil` from the command line:
8585
```console
8686
plutil -replace UID2EnvironmentEUID -bool NO Development/UID2SDKDevelopmentApp/UID2SDKDevelopmentApp/Info.plist
8787
```
88-
To use a EUID environment,
88+
To use an EUID environment:
8989
```console
9090
plutil -replace UID2EnvironmentEUID -bool YES Development/UID2SDKDevelopmentApp/UID2SDKDevelopmentApp/Info.plist
9191
```

docs/guides/integration-mobile-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ The following table summarizes the functionality available with the various inte
9898
All options support either client-side or server-side integration.
9999

100100
| Implementation Option | Generate Token from DII | Refresh Token | Android/iOS? | Send Token to Bidstream |
101-
| :--- | :--- | :--- | :--- | :--- |
101+
| :--- | :--- | :--- | :--- | :--- |
102102
| UID2 SDK for Android | ✅ | ✅ | Android | * |
103103
| UID2 SDK for iOS | ✅| ✅ | iOS | * |
104104
| GMA Plugin for Android<br/>(Requires UID2 SDK for Android) | &#8212; | &#8212; | Android | &#9989;&ast;&ast; |

docs/guides/integration-prebid-mobile-summary.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ UID2 integration with Prebid is also supported for Android and iOS mobile device
1515

1616
For details, see the following sections of the mobile integration guides:
1717

18-
- [UID2 Client-Side Integration Guide for Mobile: Prebid Integration](../guides/integration-mobile-client-side#optional-uid2-prebid-mobile-sdk-integration)
19-
- [UID2 Client-Server Integration Guide for Mobile: Prebid Integration](../guides/integration-mobile-client-server#optional-uid2-prebid-mobile-sdk-integration)
18+
- [UID2 Client-Side Integration Guide for Mobile: Prebid Integration](integration-mobile-client-side#optional-uid2-prebid-mobile-sdk-integration)
19+
- [UID2 Client-Server Integration Guide for Mobile: Prebid Integration](integration-mobile-client-server#optional-uid2-prebid-mobile-sdk-integration)

docs/guides/integration-prebid.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: UID2 Integration Overview for Prebid.js
3-
sidebar_label: UID2 Integration Overview for Prebid.js
4-
pagination_label: UID2 Integration Overview for Prebid.js
5-
description: Overview of options for integrating with Prebid.js as part of your UID2 implementation.
2+
title: UID2 Integration Overview for Prebid
3+
sidebar_label: UID2 Integration Overview for Prebid
4+
pagination_label: UID2 Integration Overview for Prebid
5+
description: Overview of options for integrating with Prebid as part of your UID2 implementation.
66
hide_table_of_contents: false
77
sidebar_position: 04
88
displayed_sidebar: sidebarPublishers
@@ -13,7 +13,7 @@ import StoreUID2TokenInBrowser from '/docs/snippets/_prebid-storing-uid2-token-i
1313

1414
# UID2 Integration Overview for Prebid
1515

16-
This guide is an overview of integration options for publishers who want to integrate with UID2 and generate <Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 tokens</Link> (advertising tokens) to be passed by Prebid.js or Prebid Mobile SDK in the RTB <Link href="../ref-info/glossary-uid#gl-bidstream">bidstream</Link>.
16+
This guide is an overview of integration options for publishers who want to integrate with UID2 and generate <Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 tokens</Link> (advertising tokens) to be passed by Prebid.js or the Prebid Mobile SDK in the RTB <Link href="../ref-info/glossary-uid#gl-bidstream">bidstream</Link>.
1717

1818
## Prebid.js Support for Web
1919

@@ -30,6 +30,8 @@ For additional flexibility, UID2 also provides alternative methods for some of t
3030
UID2 is not designed to be used where GDPR applies. The module checks the consent data that's passed in, and does not operate if the `gdprApplies` flag is set to `true`.
3131
:::
3232

33+
<!-- GDPR statement difference for UID2/EUID | UID2 is not designed to be used where GDPR applies | EUID is designed to be used only where GDPR applies. -->
34+
3335
### Generating the UID2 Token
3436

3537
Depending on access to DII, there are two methods to generate UID2 tokens for use with Prebid.js, as shown in the following table.

docs/guides/mobile-plugin-gma-ios.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ dependencies: [
6565

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

68-
| Name | Location | Dependency Rule |
69-
| :--- | :--- |:---------------------|
68+
| Name | Location | Dependency Rule |
69+
| :--- | :--- | :--- |
7070
| uid2-ios-plugin-google-gma | `[email protected]:IABTechLab/uid2-ios-plugin-google-gma.git` | Exact Version: 1.0.0 |
7171

7272
### Installing with CocoaPods

docs/guides/mobile-plugin-ima-ios.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ dependencies: [
6565

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

68-
| Name | Location | Dependency Rule |
69-
| :--- | :--- |:---------------------|
68+
| Name | Location | Dependency Rule |
69+
| :--- | :--- | :--- |
7070
| uid2-ios-plugin-google-ima | `[email protected]:IABTechLab/uid2-ios-plugin-google-ima.git` | Exact Version: 1.0.0 |
7171

7272
### Installing with CocoaPods

0 commit comments

Comments
 (0)