Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/endpoints/summary-endpoints.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: UID2 endpoints - summary
title: Endpoints - summary
description: Summary of the endpoints available in the UID2 service.
hide_table_of_contents: false
sidebar_position: 01
Expand All @@ -8,7 +8,7 @@ displayed_sidebar: docs

import Link from '@docusaurus/Link';

# UID2 endpoints: Summary
# Endpoints: Summary

All UID2 endpoints require a client secret for encrypting API requests (except [POST /token/refresh](post-token-refresh.md) requests) and decrypting responses. For details, and code examples in different programming languages, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md).

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/gs-faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The best choice depends on your unique scenario and needs. For more information

- [The UID2 Operator](../ref-info/ref-operators-public-private.md)

- [UID2 Private Operator integration overview](../guides/integration-options-private-operator.md)
- [Private Operator integration overview](../guides/integration-options-private-operator.md)

## FAQs for publishers

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/integration-google-ss.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emai
This guide covers integration steps for publishers using UID2 with the Google Ad Manager secure signals feature (previously known as Encrypted Signals for Publishers, ESP).

:::note
To use the UID2 Google Ad Manager secure signals integration, if you are using an SDK you must have your UID2 integration already set up. This does not apply if you are using server-side integration. For a summary of all the integration options available, see [UID2 integration guides: Summary](summary-guides.md).
To use the UID2 Google Ad Manager secure signals integration, if you are using an SDK you must have your UID2 integration already set up. This does not apply if you are using server-side integration. For a summary of all the integration options available, see [Integration guides: Summary](summary-guides.md).
:::

## Overview
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/integration-javascript-client-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ For an example of what a UID2 token might look like in the bidstream, when it's
```

:::info
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.
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 [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.
:::

:::tip
Expand Down
8 changes: 4 additions & 4 deletions docs/guides/integration-javascript.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: UID2 integration overview for JavaScript
sidebar_label: UID2 integration overview for JavaScript
pagination_label: UID2 integration overview for JavaScript
title: Integration overview for JavaScript
sidebar_label: Integration overview for JavaScript
pagination_label: Integration overview for JavaScript
description: Overview of options for integrating with the SDK for JavaScript as part of your UID2 implementation.
hide_table_of_contents: false
sidebar_position: 04
Expand All @@ -12,7 +12,7 @@ import Link from '@docusaurus/Link';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';

# UID2 integration overview for JavaScript
# Integration overview for JavaScript

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) using the SDK for JavaScript.

Expand Down
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 @@ -47,7 +47,7 @@ You'll need to complete the following steps:
3. [Add the UID2 mobile SDK to your mobile app](#add-the-uid2-mobile-sdk-to-your-mobile-app).
4. [Configure the UID2 mobile SDK](#configure-the-uid2-mobile-sdk).
5. [Check that the token was successfully generated and then pass it for bidstream use](#pass-generated-token-for-bidstream-use).
6. [Optionally, integrate the UID2 GMA/IMA Plugin for GAM Secure Signals integration](#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration).
6. [Optionally, integrate the GMA/IMA Plugin for GAM Secure Signals integration](#optional-gmaima-plugin-for-gam-secure-signals-integration).

## Mobile SDK version

Expand Down Expand Up @@ -324,11 +324,11 @@ UID2Manager.shared.automaticRefreshEnabled = false
</TabItem>
</Tabs>

## Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration
## Optional: GMA/IMA Plugin for GAM Secure Signals integration

<SnptGMAIMA_Plugins />

## Optional: UID2 integration with Prebid Mobile SDK
## Optional: Integration with Prebid Mobile SDK

:::important
The UID2 integration with Prebid Mobile SDK v2 requires version 1.6.0 of the UID2 SDK for Android, or version 1.7.0 of the UID2 SDK for iOS.
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/integration-mobile-client-side.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ To integrate with UID2 client-side, you'll need to complete the following steps:

1. [Check that the token was successfully generated and then pass it for bidstream use](#pass-generated-token-for-bidstream-use).

1. [Optionally, integrate the UID2 GMA/IMA Plugin for GAM Secure Signals integration](#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration).
1. [Optionally, integrate the GMA/IMA Plugin for GAM Secure Signals integration](#optional-gmaima-plugin-for-gam-secure-signals-integration).

## Mobile SDK version

Expand Down Expand Up @@ -735,11 +735,11 @@ If the response status indicates that the DII has been opted out of UID2, you mi

<SnptEnableLogging />

## Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration
## Optional: GMA/IMA Plugin for GAM Secure Signals integration

<SnptGMAIMA_Plugins />

## Optional: UID2 integration with Prebid Mobile SDK
## Optional: Integration with Prebid Mobile SDK

:::important
The UID2 integration with Prebid Mobile SDK v2 requires version 1.6.0 of the UID2 SDK for Android, or version 1.7.0 of the UID2 SDK for iOS.
Expand Down
14 changes: 7 additions & 7 deletions docs/guides/integration-mobile-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,12 +104,12 @@ The following table summarizes the mobile integration options for managing the U
</thead>
<tbody>
<tr>
<td>UID2 Android SDK</td>
<td>Android SDK</td>
<td>[SDK for Android reference guide](../sdks/sdk-ref-android.md)</td>
<td>One of the following:<ul><li>[Client-side integration guide for mobile](../guides/integration-mobile-client-side.md)</li><li>[Client-server integration guide for mobile](../guides/integration-mobile-client-server.md)</li></ul></td>
</tr>
<tr>
<td>UID2 iOS SDK</td>
<td>iOS SDK</td>
<td>[SDK for iOS reference guide](../sdks/sdk-ref-ios.md)</td>
<td>One of the following:<ul><li>[Client-side integration guide for mobile](../guides/integration-mobile-client-side.md)</li><li>[Client-server integration guide for mobile](../guides/integration-mobile-client-server.md)</li></ul></td>
</tr>
Expand All @@ -124,11 +124,11 @@ The following table summarizes the options supported by UID2.

| 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:<ol><li>[UID2 GMA Plugin for Android integration guide](../guides/mobile-plugin-gma-android.md)</li><li>One of the following:<ul><li>Client-side: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)</li><li>Client-server: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)</li></ul></li></ol> |
| 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:<ol><li>[UID2 GMA Plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md)</li><li>One of the following:<ul><li>Client-side: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)</li><li>Client-server: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)</li></ul></li></ol> |
| You want to use Google IMA to integrate multimedia ads into your Android app | Both of the following, in this sequence:<ol><li>[UID2 IMA Plugin for Android integration guide](../guides/mobile-plugin-ima-android.md)</li><li>One of the following:<ul><li>Client-side: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)</li><li>Client-server: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)</li></ul></li></ol> |
| You want to use Google IMA to integrate multimedia ads into your iOS app | Both of the following, in this sequence:<ol><li>[UID2 IMA Plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md)</li><li>One of the following:<ul><li>Client-side: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)</li><li>Client-server: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)</li></ul></li></ol> |
| 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:<ul><li>Client-side: [Optional: UID2 integration with Prebid Mobile SDK](../guides/integration-mobile-client-side.md#optional-uid2-integration-with-prebid-mobile-sdk)</li><li>Client-server: [Optional: UID2 integration with Prebid Mobile SDK](../guides/integration-mobile-client-server.md#optional-uid2-integration-with-prebid-mobile-sdk)</li></ul> |
| 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:<ol><li>[GMA Plugin for Android integration guide](../guides/mobile-plugin-gma-android.md)</li><li>One of the following:<ul><li>Client-side: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-gmaima-plugin-for-gam-secure-signals-integration)</li><li>Client-server: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-gmaima-plugin-for-gam-secure-signals-integration)</li></ul></li></ol> |
| 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:<ol><li>[GMA Plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md)</li><li>One of the following:<ul><li>Client-side: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-gmaima-plugin-for-gam-secure-signals-integration)</li><li>Client-server: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-gmaima-plugin-for-gam-secure-signals-integration)</li></ul></li></ol> |
| You want to use Google IMA to integrate multimedia ads into your Android app | Both of the following, in this sequence:<ol><li>[IMA Plugin for Android integration guide](../guides/mobile-plugin-ima-android.md)</li><li>One of the following:<ul><li>Client-side: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-gmaima-plugin-for-gam-secure-signals-integration)</li><li>Client-server: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-gmaima-plugin-for-gam-secure-signals-integration)</li></ul></li></ol> |
| You want to use Google IMA to integrate multimedia ads into your iOS app | Both of the following, in this sequence:<ol><li>[IMA Plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md)</li><li>One of the following:<ul><li>Client-side: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-gmaima-plugin-for-gam-secure-signals-integration)</li><li>Client-server: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-gmaima-plugin-for-gam-secure-signals-integration)</li></ul></li></ol> |
| 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:<ul><li>Client-side: [Optional: Integration with Prebid Mobile SDK](../guides/integration-mobile-client-side.md#optional-integration-with-prebid-mobile-sdk)</li><li>Client-server: [Optional: Integration with Prebid Mobile SDK](../guides/integration-mobile-client-server.md#optional-integration-with-prebid-mobile-sdk)</li></ul> |

### Functionality summary

Expand Down
12 changes: 6 additions & 6 deletions docs/guides/integration-options-private-operator.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: UID2 integrations for Private Operators
title: Private Operator integration overview
description: Information summary for Private Operators.
hide_table_of_contents: false
displayed_sidebar: docs
Expand All @@ -10,7 +10,7 @@ import SnptUpgradePolicy from '../snippets/_snpt-private-operator-upgrade-policy
import SnptRotatingTheKeys from '../snippets/_snpt-private-operator-rotating-the-keys.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';

# UID2 Private Operator integration overview
# Private Operator integration overview

UID2 participants that host their own <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link> send their own first-party <Link href="../ref-info/glossary-uid#gl-dii">directly identifying information (DII)</Link> to their own local UID2 <Link href="../ref-info/glossary-uid#gl-operator">Operator</Link> service, running in a private environment.

Expand Down Expand Up @@ -132,7 +132,7 @@ There is no functional difference between the Private Operator versions.

| Integration Type| Documentation | Content Description |
| :--- | :--- | :--- |
| AWS | [UID2 Private Operator for AWS integration guide](../guides/operator-guide-aws-marketplace.md) | Instructions for setting up a Private Operator service for AWS Marketplace. |
| GCP Confidential Space | [UID2 Private Operator for GCP integration guide](../guides/operator-private-gcp-confidential-space.md) | Information for setting up the UID2 Operator Service in [Confidential Space](https://cloud.google.com/confidential-computing#confidential-space), a confidential computing option from [Google Cloud](https://cloud.google.com/docs/overview/) Platform. |
| Azure | [UID2 Private Operator for Azure integration guide](../guides/operator-guide-azure-enclave.md) | Instructions for setting up the UID2 Operator Service in an instance of Confidential Containers, a confidential computing option from Microsoft Azure. |
| AKS | [UID2 Private Operator for AKS integration guide](../guides/operator-guide-aks-enclave.md) | Instructions for setting up the UID2 Operator Service in an instance of AKS, a confidential computing solution that runs on virtual nodes on Microsoft Azure container instances and uses Kubernetes. |
| AWS | [Private Operator for AWS integration guide](../guides/operator-guide-aws-marketplace.md) | Instructions for setting up a Private Operator service for AWS Marketplace. |
| GCP Confidential Space | [Private Operator for GCP integration guide](../guides/operator-private-gcp-confidential-space.md) | Information for setting up the UID2 Operator Service in [Confidential Space](https://cloud.google.com/confidential-computing#confidential-space), a confidential computing option from [Google Cloud](https://cloud.google.com/docs/overview/) Platform. |
| Azure | [Private Operator for Azure integration guide](../guides/operator-guide-azure-enclave.md) | Instructions for setting up the UID2 Operator Service in an instance of Confidential Containers, a confidential computing option from Microsoft Azure. |
| AKS | [Private Operator for AKS integration guide](../guides/operator-guide-aks-enclave.md) | Instructions for setting up the UID2 Operator Service in an instance of AKS, a confidential computing solution that runs on virtual nodes on Microsoft Azure container instances and uses Kubernetes. |
6 changes: 3 additions & 3 deletions docs/guides/integration-prebid-mobile-summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ displayed_sidebar: docs

import Link from '@docusaurus/Link';

# UID2 mobile integration with Prebid Mobile SDK
# Mobile integration with Prebid Mobile SDK

UID2 integration with Prebid is also supported for Android and iOS mobile devices, using the UID2 integration with Prebid Mobile SDK option.

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

- [Client-side integration guide for mobile: UID2 integration with Prebid Mobile SDK](integration-mobile-client-side#optional-uid2-integration-with-prebid-mobile-sdk)
- [Client-server integration guide for mobile: UID2 integration with Prebid Mobile SDK](integration-mobile-client-server#optional-uid2-integration-with-prebid-mobile-sdk)
- [Client-side integration guide for mobile: UID2 integration with Prebid Mobile SDK](integration-mobile-client-side#optional-integration-with-prebid-mobile-sdk)
- [Client-server integration guide for mobile: UID2 integration with Prebid Mobile SDK](integration-mobile-client-server#optional-integration-with-prebid-mobile-sdk)
10 changes: 5 additions & 5 deletions docs/guides/integration-prebid.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: UID2 integration overview for Prebid
sidebar_label: UID2 integration overview for Prebid
pagination_label: UID2 integration overview for Prebid
title: Integration overview for Prebid
sidebar_label: Integration overview for Prebid
pagination_label: Integration overview for Prebid
description: Overview of options for integrating with Prebid as part of your UID2 implementation.
hide_table_of_contents: false
sidebar_position: 04
Expand All @@ -13,7 +13,7 @@ import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptStoreUID2TokenInBrowser from '../snippets/_snpt-prebid-storing-uid2-token-in-browser.mdx';

# UID2 integration overview for Prebid
# Integration overview for Prebid

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>.

Expand Down Expand Up @@ -87,4 +87,4 @@ For detailed instructions, refer to one of the following integration guides:

## UID2 integration with Prebid Mobile SDK for mobile devices

UID2 integration with Prebid is supported for Android and iOS mobile devices using the [UID2 mobile integration with Prebid Mobile SDK](integration-prebid-mobile-summary.md).
UID2 integration with Prebid is supported for Android and iOS mobile devices using the [Mobile integration with Prebid Mobile SDK](integration-prebid-mobile-summary.md).
Loading
Loading