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
12 changes: 7 additions & 5 deletions docs/guides/integration-mobile-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,13 @@ For details, refer to one of the following guides:

- [Client-Side Integration Guide for Mobile](integration-mobile-client-side.md)
- [Client-Server Integration Guide for Mobile](integration-mobile-client-server.md)
- [Server-Side Integration Guide for Mobile](integration-mobile-server-side.md)

## Mobile Integration Paths

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

1. Do you want to retrieve the UID2 token on the client side or on the server side? See [Client-Side or Client-Server Integration](#client-side-or-client-server-integration).
1. Do you want to retrieve the UID2 token on the client side or on the server side? See [Client-Side, Client-Server, or Server-Side Integration?](#client-side-client-server-or-server-side-integration)

1. What do you want to use to retrieve and refresh the UID2 token? See [Generating, Storing, and Refreshing the UID2 Token](#generating-storing-and-refreshing-the-uid2-token).

Expand All @@ -70,18 +71,19 @@ To integrate with UID2, you'll need to have a UID2 account. If you haven't yet c

When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).

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?](#client-side-or-client-server-integration)
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, Client-Server, or Server-Side Integration?](#client-side-client-server-or-server-side-integration)

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

The options for integrating with UID2 using the UID2 mobile SDKs are summarized in the following table. Choose the <Link href="../ref-info/glossary-uid#gl-integration-approaches">integration approach</Link> that's best for you.

For details, see [Integration Approaches](../ref-info/ref-integration-approaches.md).

| Scenario | Option | Integration Guide |
| :--- | :--- | :--- |
| You have access to <Link href="../ref-info/glossary-uid#gl-dii">DII</Link> (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 | [UID2 Client-Side Integration Guide for Mobile](integration-mobile-client-side.md) |
| You have access to DII on the server side only and can do the necessary development to generate UID2 tokens server-side, or you are using a <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link>. | Client-Server Integration | [UID2 Client-Server Integration Guide for Mobile](integration-mobile-client-server.md) |
| You have access to <Link href="../ref-info/glossary-uid#gl-dii">DII</Link> (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 | [UID2 Client-Side Integration Guide for Mobile](integration-mobile-client-side.md) |
| You have access to DII on the server side only and can do the necessary development to generate UID2 tokens server-side, but you want to refresh tokens on the client side&#8212;or you are using a <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link>. | Client-Server Integration | [UID2 Client-Server Integration Guide for Mobile](integration-mobile-client-server.md) |
| You have access to DII on the server side only and can do the necessary development to generate UID2 tokens server-side, or you are using a <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link>. | Server-Side Integration | [UID2 Server-Side Integration Guide for Mobile](integration-mobile-server-side.md) |

### Generating, Storing, and Refreshing the UID2 Token

Expand Down
28 changes: 28 additions & 0 deletions docs/guides/integration-mobile-server-side.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: UID2 Server-Side Integration Guide for Mobile
sidebar_label: Server-Side Integration for Mobile
pagination_label: UID2 Server-Side Integration Guide for Mobile
description: Setting up a mobile integration with token generate and refresh both on the server side.
hide_table_of_contents: false
sidebar_position: 04
---

import Link from '@docusaurus/Link';

# UID2 Server-Side Integration Guide for Mobile

This guide is for mobile app publishers who want to manage the UID2 token entirely on the server side:

- The token is generated on the server side.
- The token is refreshed as needed on the server side.

This setup requires that most of the code changes are done on the server side, with minimal changes in the mobile app.

One advantage of this approach is that if you're dealing with multiple platforms (Web / CTV / mobile), doing everything on the server side can reduce platform-specific efforts.

To implement using this approach, follow the instructions in [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md).

If your server-side code is in Java or Python, you can use one of the UID2 SDKs to make the HTTP requests to UID2, instead of writing your own source code. For details, refer to one of the following SDK guides:

- [SDK for Java Reference Guide: Usage for Publishers](../sdks/sdk-ref-java.md#usage-for-publishers)
- [SDK for Python Reference Guide: Usage for Publishers](../sdks/sdk-ref-python.md#usage-for-publishers)
2 changes: 1 addition & 1 deletion docs/guides/mobile-plugin-gma-android.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To integrate with UID2, you'll need to have a UID2 account. If you haven't yet c

When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).

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?](integration-mobile-overview#client-side-or-client-server-integration).
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, Client-Server, or Server-Side Integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration)

## Requirements

Expand Down
3 changes: 1 addition & 2 deletions docs/guides/mobile-plugin-gma-ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ To integrate with UID2, you'll need to have a UID2 account. If you haven't yet c

When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).

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?](integration-mobile-overview#client-side-or-client-server-integration).

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, Client-Server, or Server-Side Integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration)
## Requirements

To run this plugin, install the following:
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/mobile-plugin-ima-android.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To integrate with UID2, you'll need to have a UID2 account. If you haven't yet c

When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).

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?](integration-mobile-overview#client-side-or-client-server-integration).
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, Client-Server, or Server-Side Integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration)

## Requirements

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/mobile-plugin-ima-ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To integrate with UID2, you'll need to have a UID2 account. If you haven't yet c

When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).

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?](integration-mobile-overview#client-side-or-client-server-integration).
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, Client-Server, or Server-Side Integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration)

## Requirements

Expand Down
1 change: 1 addition & 0 deletions docs/guides/summary-guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ The following documentation resources are available for publishers integrating w
| [Mobile Integration Overview for Android and iOS](integration-mobile-overview.md) | An overview of options for mobile app publishers who want to integrate with UID2 using the SDK for Android or the SDK for iOS. |
| [Client-Side Integration Guide for Mobile](integration-mobile-client-side.md) | An integration guide for mobile app publishers who want to integrate with UID2 with changes only within the mobile app (no server-side changes). |
| [Client-Server Integration Guide for Mobile](integration-mobile-client-server.md) | An integration guide for mobile app publishers who want to integrate with UID2 by doing the following:<ol><li>Generating UID2 tokens server-side via either a Public or Private Operator.</li><li>Passing the resulting <Link href="../ref-info/glossary-uid#gl-identity">identities</Link> to a mobile app for passing into the bidstream.</li></ol> |
| [Server-Side Integration Guide for Mobile](../guides/integration-mobile-server-side.md) | An integration guide for mobile app publishers who want to manage the UID2 token entirely on the server side. |

### CTV Integrations

Expand Down
1 change: 1 addition & 0 deletions docs/overviews/overview-publishers.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ The following resources are available for publisher integrations supporting Andr
| Android/iOS (Overview) | [Mobile Integration Overview for Android and iOS](../guides/integration-mobile-overview.md) | An overview of options for mobile app publishers who want to integrate with UID2 using the SDK for Android or the SDK for iOS. |
| Android/iOS, Client-Side Integration | [Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md) | An integration guide for mobile app publishers who want to integrate with UID2 with changes only within the mobile app (no server-side changes). |
| Android/iOS, Client-Server Integration | [Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md) | An integration guide for mobile app publishers who want to integrate with UID2 by doing the following:<ol><li>Generating UID2 tokens server-side via either a Public or Private Operator.</li><li>Passing the resulting <Link href="../ref-info/glossary-uid#gl-identity">identities</Link> to a mobile app for passing into the bidstream.</li></ol> |
| Android/iOS, Server-Side Integration | [Server-Side Integration Guide for Mobile](../guides/integration-mobile-server-side.md) | An integration guide for mobile app publishers who want to manage the UID2 token entirely on the server side. |
| Android | [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) |An SDK that facilitates the process of generating or establishing client identity using UID2 and retrieving UID2 tokens for publishers that need to support Android apps. |
| iOS | [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md) | An SDK that facilitates the process of generating or establishing client identity using UID2 and retrieving UID2 tokens for publishers that need to support iOS apps. |

Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/sdk-ref-android.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ When initial account setup is complete, you'll receive instructions and a link t
- Optional: For a client-side implementation, set up configuration values such as domain names or mobile app IDs.
- Optionally, configure other values, such as setting up information about team members.

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. For a summary of mobile integration options, see [Client-Side or Client-Server Integration?](../guides/integration-mobile-overview#client-side-or-client-server-integration).
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. For a summary of mobile integration options, see [Client-Side, Client-Server, or Server-Side Integration?](../guides/integration-mobile-overview#client-side-client-server-or-server-side-integration)

<!-- You'll be granted permission to use specific functions offered by the SDK, and given credentials for that access. -->

Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/sdk-ref-ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ When initial account setup is complete, you'll receive instructions and a link t
- Optional: For a client-side implementation, set up configuration values such as domain names or mobile app IDs.
- Optionally, configure other values, such as setting up information about team members.

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. For a summary of mobile integration options, see [Client-Side or Client-Server Integration?](../guides/integration-mobile-overview#client-side-or-client-server-integration).
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. For a summary of mobile integration options, see [Client-Side, Client-Server, or Server-Side Integration?](../guides/integration-mobile-overview#client-side-client-server-or-server-side-integration)

<!-- You'll be granted permission to use specific functions offered by the SDK, and given credentials for that access. -->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,13 @@ UID2 mobile SDK を使用してモバイルアプリを UID2 とインテグレ

- [Client-Side Integration Guide for Mobile](integration-mobile-client-side.md)
- [Client-Server Integration Guide for Mobile](integration-mobile-client-server.md)
- [Server-Side Integration Guide for Mobile](integration-mobile-server-side.md)

## Mobile Integration Paths

モバイルシナリオに最適なインテグレーションパスを決定するには、次の点を考慮してください:

1. UID2 Token を Client-Side または Server-Side で取得しますか? [Generating, Storing, and Refreshing the UID2 Token](#generating-storing-and-refreshing-the-uid2-token) を参照してください。
1. UID2 Token を Client-Side または Server-Side で取得しますか? [Client-Side, Client-Server, or Server-Side Integration?](#client-side-client-server-or-server-side-integration) を参照してください。

1. UID2 Token の取得とリフレッシュ何を使いますか? [Generating, Storing, and Refreshing the UID2 Token](#generating-storing-and-refreshing-the-uid2-token) を参照してください。

Expand All @@ -70,9 +71,9 @@ UID2 とインテグレーションんするには、UID2 アカウントが必

アカウントのセットアップが完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするためのリンクと手順が送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting Started with the UID2 Portal](../portal/portal-getting-started.md) を参照してください。

UID2 Portal での手順は、実装が Client-Side、Client-Server、または Server-Side であるかによって異なります。各インテグレーションガイドに具体的な手順が記載されています。概要は、[Client-Side or Client-Server Integration?](#client-side-or-client-server-integration) を参照してください。
UID2 Portal での手順は、実装が Client-Side、Client-Server、または Server-Side であるかによって異なります。各インテグレーションガイドに具体的な手順が記載されています。概要は、[Client-Side, Client-Server, or Server-Side Integration?](#client-side-client-server-or-server-side-integration) を参照してください。

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

UID2 mobile SDK を使用して UID2 とインテグレーションするためのオプションは、次の表にまとめられています。最適な <Link href="../ref-info/glossary-uid#gl-integration-approaches">Integration approach</Link> を選択してください。

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: UID2 Server-Side Integration Guide for Mobile
sidebar_label: Server-Side Integration for Mobile
pagination_label: UID2 Server-Side Integration Guide for Mobile
description: Setting up a mobile integration with token generate and refresh both on the server side.
hide_table_of_contents: false
sidebar_position: 04
---

import Link from '@docusaurus/Link';

# UID2 Server-Side Integration Guide for Mobile

This guide is for mobile app publishers who want to manage the UID2 token entirely on the server side:

- The token is generated on the server side.
- The token is refreshed as needed on the server side.

This setup requires that most of the code changes are done on the server side, with minimal changes in the mobile app.

One advantage of this approach is that if you're dealing with multiple platforms (Web / CTV / mobile), doing everything on the server side can reduce platform-specific efforts.

To implement using this approach, follow the instructions in [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md).

If your server-side code is in Java or Python, you can use one of the UID2 SDKs to make the HTTP requests to UID2, instead of writing your own source code. For details, refer to one of the following SDK guides:

- [SDK for Java Reference Guide: Usage for Publishers](../sdks/sdk-ref-java.md#usage-for-publishers)
- [SDK for Python Reference Guide: Usage for Publishers](../sdks/sdk-ref-python.md#usage-for-publishers)
Loading