Skip to content

Commit ae0b536

Browse files
authored
Merge branch 'main' into jpn-translation-update-828-847
2 parents b5b4f00 + a46e0cc commit ae0b536

26 files changed

+997
-29
lines changed

docs/getting-started/gs-encryption-decryption.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ The following table describes the field layout for request encryption code.
5757

5858
| Offset (Bytes) | Size (Bytes) | Description |
5959
| :--- | :--- | :--- |
60-
| 0 | 8 | The <a href="../ref-info/glossary-uid#gl-unix-time">Unix</a> timestamp (in milliseconds). Must be int64 big endian. |
60+
| 0 | 8 | The <a href="../ref-info/glossary-uid#gl-unix-time">Unix</a> timestamp (in milliseconds) of the request, in int64 big endian format.<br/>When the server receives and decrypts the envelope, it checks the embedded timestamp. If the timestamp is older than 60 seconds, the request is considered stale and is rejected. |
6161
| 8 | 8 | Nonce: Random 64 bits of data used to help protect against replay attacks. The corresponding [Unencrypted Response Data Envelope](#unencrypted-response-data-envelope) should contain the same nonce value for the response to be considered valid. |
6262
| 16 | N | Payload, which is a request JSON document serialized in UTF-8 encoding. |
6363

@@ -96,7 +96,7 @@ The following table describes the field layout for response decryption code.
9696

9797
| Offset (Bytes) | Size (Bytes) | Description |
9898
| :--- | :--- | :--- |
99-
| 0 | 8 | The Unix timestamp (in milliseconds). Must be int64 big endian. |
99+
| 0 | 8 | The Unix timestamp (in milliseconds) of the response, in int64 big endian format. |
100100
| 8 | 8 | Nonce. For the response to be considered valid, this should match the nonce in the [unencrypted request data envelope](#unencrypted-request-data-envelope). |
101101
| 16 | N | Payload, which is a response JSON document serialized in UTF-8 encoding. |
102102

docs/guides/integration-mobile-overview.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,13 @@ For details, refer to one of the following guides:
5353

5454
- [Client-Side Integration Guide for Mobile](integration-mobile-client-side.md)
5555
- [Client-Server Integration Guide for Mobile](integration-mobile-client-server.md)
56+
- [Server-Side Integration Guide for Mobile](integration-mobile-server-side.md)
5657

5758
## Mobile Integration Paths
5859

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

61-
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).
62+
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)
6263

6364
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).
6465

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

7172
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).
7273

73-
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)
74+
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)
7475

75-
### Client-Side or Client-Server Integration?
76+
### Client-Side, Client-Server, or Server-Side Integration?
7677

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

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

8182
| Scenario | Option | Integration Guide |
8283
| :--- | :--- | :--- |
83-
| 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) |
84-
| 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) |
84+
| 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) |
85+
| 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) |
86+
| 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) |
8587

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: UID2 Server-Side Integration Guide for Mobile
3+
sidebar_label: Server-Side Integration for Mobile
4+
pagination_label: UID2 Server-Side Integration Guide for Mobile
5+
description: Setting up a mobile integration with token generate and refresh both on the server side.
6+
hide_table_of_contents: false
7+
sidebar_position: 04
8+
---
9+
10+
import Link from '@docusaurus/Link';
11+
12+
# UID2 Server-Side Integration Guide for Mobile
13+
14+
This guide is for mobile app publishers who want to manage the UID2 token entirely on the server side:
15+
16+
- The token is generated on the server side.
17+
- The token is refreshed as needed on the server side.
18+
19+
This setup requires that most of the code changes are done on the server side, with minimal changes in the mobile app.
20+
21+
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.
22+
23+
To implement using this approach, follow the instructions in [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md).
24+
25+
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:
26+
27+
- [SDK for Java Reference Guide: Usage for Publishers](../sdks/sdk-ref-java.md#usage-for-publishers)
28+
- [SDK for Python Reference Guide: Usage for Publishers](../sdks/sdk-ref-python.md#usage-for-publishers)

docs/guides/integration-options-private-operator.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ If you choose to be a Private Operator, several implementation options are avail
5151
- [Nitro Enclave](https://aws.amazon.com/ec2/nitro/) from AWS
5252
- [Confidential Space](https://cloud.google.com/confidential-computing#confidential-space), a confidential computing option from [Google Cloud](https://cloud.google.com/docs/overview/) Platform
5353
- [Confidential Containers](https://learn.microsoft.com/en-us/azure/confidential-computing/confidential-containers), a confidential computing option from Microsoft Azure
54+
- [Azure Kubernetes Service (AKS)](https://learn.microsoft.com/en-us/azure/aks/what-is-aks), a confidential computing solution that runs on virtual nodes on Microsoft Azure container instances and uses Kubernetes.
5455

5556
## Private Operator Workflow
5657

@@ -110,3 +111,4 @@ There is no functional difference between the Private Operator versions.
110111
| 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. |
111112
| 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. |
112113
| 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. |
114+
| 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. |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To integrate with UID2, you'll need to have a UID2 account. If you haven't yet c
3333

3434
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).
3535

36-
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).
36+
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)
3737

3838
## Requirements
3939

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ To integrate with UID2, you'll need to have a UID2 account. If you haven't yet c
3333

3434
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).
3535

36-
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).
37-
36+
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)
3837
## Requirements
3938

4039
To run this plugin, install the following:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To integrate with UID2, you'll need to have a UID2 account. If you haven't yet c
3333

3434
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).
3535

36-
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).
36+
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)
3737

3838
## Requirements
3939

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To integrate with UID2, you'll need to have a UID2 account. If you haven't yet c
3333

3434
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).
3535

36-
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).
36+
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)
3737

3838
## Requirements
3939

0 commit comments

Comments
 (0)