|
1 | 1 | # UID2 Integration Examples |
2 | 2 |
|
3 | | -If you are a content publisher interested in generating identity tokens utilizing UID2 for the RTB bid stream, you can build and run either of the two example applications to see how you can use the UID2 services and which integration fits your needs best. |
4 | | - |
5 | | -Both examples illustrate the basic steps that you need to consider for your integration. For example, you need to decide how to implement user login and logout, how to manage UID2 identity information and use it for targeted advertising, how to refresh tokens, deal with missing identities, and handle user opt-outs. |
6 | | - |
7 | | -The following table summarizes both examples. |
8 | | - |
9 | | -| Example Documentation | Primary Audience | Example Description | Integration Steps | |
10 | | -| :--- | :--- | :--- | :--- | |
11 | | -| [UID2 SDK Integration Example](./publisher/standard/README.md) | Publishers with web assets | Demonstrates how to use the UID2 services with the [Client-Side Identity JavaScript SDK](https://github.com/UnifiedID2/uid2docs/blob/main/api/v1/sdks/client-side-identity-v1.md) (also known as the UID2 SDK) to implement the standard UID2 integration workflow. | [UID2 SDK Integration Guide](https://github.com/UnifiedID2/uid2docs/blob/main/api/v1/guides/publisher-client-side.md) | |
12 | | -| [Server-Only UID2 Integration Example](./publisher/server_only/README.md) | App developers and CTV broadcasters | Demonstrates how to use the UID2 services to implement a custom (server-only) UID2 integration workflow without relying on an SDK for establishing client UID2 identity and retrieving advertising tokens. | [Server-Only UID2 Integration Guide](https://github.com/UnifiedID2/uid2docs/blob/main/api/v1/guides/custom-publisher-integration.md) | |
13 | | - |
14 | | -The documentation for each example includes instructions on how to build and run the application and suggests steps that you may take to test and explore it. Each step is annotated with comments that explain what takes place on the backend and how the UID2 services work. |
| 3 | +The [UID2 framework](https://github.com/UnifiedID2/uid2docs/tree/main) enables publishers to integrate in either of the following ways: |
15 | 4 |
|
| 5 | +- Via the standard integration workflow, using the [Client-Side Identity JavaScript SDK](https://github.com/UnifiedID2/uid2docs/blob/main/api/v2/sdks/client-side-identity.md) (also known as the UID2 SDK). |
| 6 | +- Via a server-only or custom integration, by building a direct integration without using the UID2 SDK. |
16 | 7 |
|
| 8 | +If you are a content publisher interested in generating UID2 tokens for the real-time bidding (RTB) bid stream and want to see how you can use the UID2 services and which integration fits your needs best, you can build and run an example application for each integration. |
17 | 9 |
|
| 10 | +The following table summarizes both examples and provides links to the example applications, their documentation, and the respective step-by-step integration guides. |
18 | 11 |
|
| 12 | +| Example Application | Example Description | Primary Audience | Example Documentation| Integration Guide | |
| 13 | +| :--- | :--- | :--- | :--- | :--- | |
| 14 | +| [UID2 SDK Integration Example](https://example-jssdk-integ.uidapi.com/) | Demonstrates how to use the UID2 services with the [UID2 SDK](https://github.com/UnifiedID2/uid2docs/blob/main/api/v1/sdks/client-side-identity-v1.md) to implement the standard UID2 integration workflow. | Publishers with web assets | [UID2 SDK Integration Example](./publisher/standard/README.md) | [UID2 SDK Integration Guide](https://github.com/UnifiedID2/uid2docs/blob/main/api/v1/guides/publisher-client-side.md) | |
| 15 | +| [Server-Only UID2 Integration Example](https://example-srvonly-integ.uidapi.com/login) |Demonstrates how to use the UID2 services to implement a custom (server-only) UID2 integration workflow without relying on an SDK for establishing client UID2 identity and retrieving advertising tokens.| App developers and CTV broadcasters | [Server-Only UID2 Integration Example](./publisher/server_only/README.md) | [Server-Only UID2 Integration Guide](https://github.com/UnifiedID2/uid2docs/blob/main/api/v1/guides/custom-publisher-integration.md) | |
19 | 16 |
|
| 17 | +The example applications illustrate the basic steps that you need to consider for your integration. For example, you need to decide how to do the following: |
| 18 | +- Implement user login and logout. |
| 19 | +- Manage UID2 identity information and use it for targeted advertising. |
| 20 | +- Refresh tokens. |
| 21 | +- Deal with missing identities. |
| 22 | +- Handle user opt-outs. |
20 | 23 |
|
| 24 | +The documentation for each example includes instructions on how to build and run the application and suggests steps that you may take to test and explore it. Each step is annotated with comments that explain what takes place on the backend and how the UID2 services work. |
0 commit comments