You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+51-12Lines changed: 51 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,18 +2,36 @@
2
2
3
3
The UID 2 Project is subject to Tech Lab IPR’s Policy and is managed by the IAB Tech Lab Addressability Working Group and Privacy & Rearc Commit Group. Please review [the governance rules](https://github.com/IABTechLab/uid2-core/blob/master/Software%20Development%20and%20Release%20Procedures.md).
4
4
5
-
This SDK simplifies integration with UID2 for those using Python.
5
+
This document includes:
6
+
*[Who Is this SDK for?](#who-is-this-sdk-for)
7
+
*[Requirements](#requirements)
8
+
*[Install](#install)
9
+
*[Usage for DSPs](#usage-for-dsps)
10
+
*[Usage for UID2 Sharers](#usage-for-uid2-sharers)
11
+
*[Development](#development)
12
+
*[Example Usage](#example-usage)
6
13
7
-
## Dependencies
14
+
## Who Is this SDK for?
15
+
16
+
This SDK simplifies integration with UID2 for DSPs and UID Sharers, as described in [UID2 Integration Guides](https://unifiedid.com/docs/category/integration-guides).
17
+
18
+
## Requirements
8
19
9
20
This SDK supports Python 3.6 and above.
10
21
11
-
## Quick Start
22
+
## Install
12
23
13
-
Connect to the UID2 service, refresh the encryption keys, and then use the keys to decrypt an advertising token, to arrive at the corresponding advertising ID:
24
+
The SDK can be installed using pip.
25
+
```
26
+
pip install uid2-client
27
+
```
28
+
29
+
## Usage for DSPs
14
30
31
+
Connect to the UID2 service, refresh the encryption keys, and then use the keys to decrypt an advertising token, to arrive at the corresponding advertising ID:
32
+
For examples of usage for DSPs, see [sample_client.py](examples/sample_client.py) and [sample_auto_refresh.py](examples/sample_auto_refresh.py)
* Example for Sharers (decryption/encryption of tokens/uids)
44
+
## Usage for Sharers
45
+
46
+
A UID2 sharer is a participant that wants to share UID2s or EUIDs with another participant. Raw UID2s must be encrypted into UID2 tokens before sending them to another participant.
47
+
For examples of usage, see [sample_sharing.py](examples/sample_sharing.py) and [sample_auto_refresh.py](examples/sample_auto_refresh.py)
0 commit comments