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
|`u`| string | The raw UID2 corresponding to the email or phone number provided in the request. |
178
178
|`p`| string | One of the following:<ul><li>If the current raw UID2 was rotated in the last 90 days: the previous raw UID2.</li><li>Otherwise: `null`.</li></ul> |
179
-
|`r`| number | The Unix timestamp (in milliseconds) that indicates when the raw UID2 might be refreshed. The raw UID2 is guaranteed to be valid until this timestamp. |
179
+
|`r`| number | The Unix timestamp (in milliseconds) that indicates when the raw UID2 might be refreshed. The raw UID2 is valid until this timestamp. |
180
180
181
181
:::note
182
182
The raw UID2 does not change before the refresh timestamp. After the refresh timestamp, remapping the DII returns a new refresh timestamp, but the raw UID2 might or might not change. It is possible for the raw UID2 to remain unchanged for multiple refresh intervals.
Copy file name to clipboardExpand all lines: docs/getting-started/gs-normalization-encoding.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -194,16 +194,16 @@ You can use this tool to verify that your internal processes are set up to corre
194
194
195
195
## Troubleshooting
196
196
197
-
In all scenarios, follow the steps on your side to prepare your DII for processing, and then check your resulting values by using the [UID2 Hashing Tool](#uid2-hashing-tool). If the results don't match, check each step to find the error.
197
+
In all scenarios, follow the steps on your side to prepare your DII for processing, and then check your resulting values by using the [UID2 hashing tool](https://hashing-tool.samples.uidapi.com/). If the results don't match, check each step to find the error.
198
198
199
199
If you're having trouble or getting errors, or if you just want to be sure you're following the steps correctly, here are some things you can check:
200
200
201
201
-**Phone numbers**: Make sure you're normalizing—and normalizing correctly—as the first step.
202
202
203
203
The service normalizes emails, but it can't normalize phone numbers. For example, it can't determine the value for a missing country code. Use these resources:
204
204
- Instructions: [Phone Number Normalization](#phone-number-normalization).
205
-
- Tool for cross-checking: [UID2 Hashing Tool](#uid2-hashing-tool).
205
+
- Tool for cross-checking: [UID2 hashing tool](https://hashing-tool.samples.uidapi.com/).
206
206
207
207
-**Use the Base64-encoded value**: The process includes normalizing, then hashing, then Base64-encoding the bytes of the hash value. When generating UID2s, the input is the Base64-encoded value. Make sure you're using this 44-character string value.
208
208
209
-
- You might see the following error message: "The hashing value must be 44 characters." In this scenario, there is an error with the hashing function you're using. Use the hex to Base64 encoding of the SHA-256 hash. For details, see [Email Address Hash Encoding](#email-address-hash-encoding) or [Phone Number Hash Encoding](#phone-number-hash-encoding). To cross-check, test using the [UID2 Hashing Tool](#uid2-hashing-tool).
209
+
- You might see the following error message: "The hashing value must be 44 characters." In this scenario, there is an error with the hashing function you're using. Use the hex to Base64 encoding of the SHA-256 hash. For details, see [Email Address Hash Encoding](#email-address-hash-encoding) or [Phone Number Hash Encoding](#phone-number-hash-encoding). To cross-check, test using the [UID2 hashing tool](https://hashing-tool.samples.uidapi.com/).
For information about supported versions and deprecation dates, see [Private Operator Versions](../ref-info/deprecation-schedule.md#private-operator-versions).
@@ -371,12 +372,16 @@ The following table includes some additional commands that might help you manage
371
372
372
373
## UID2 Operator Error Codes
373
374
374
-
The following table lists errors that might occur during a Private Operator's startup sequence.
375
+
The following sections list error codes that might occur during a Private Operator's startup or runtime.
375
376
376
377
:::note
377
-
Error codes for Private Operator startup issues are applicable only to release v5.49.7 and later.
378
+
Error codes for Private Operator issues are applicable only to release v5.49.7 and later.
378
379
:::
379
380
381
+
### Startup Errors
382
+
383
+
The following errors might occur during operator startup:
384
+
380
385
| Error Code | Issue | Steps to Resolve |
381
386
| :--- | :--- | :--- |
382
387
| E01 | InstanceProfileMissingError | Attach an IAM instance profile to the EC2 instance with the required permissions. The UID2 Operator needs these permissions to access configurations from AWS Secrets Manager. |
@@ -386,6 +391,12 @@ Error codes for Private Operator startup issues are applicable only to release v
386
391
| E05 | OperatorKeyValidationError | Ensure the operator key is correct for the environment and matches the one provided to you. |
387
392
| E06 | UID2ServicesUnreachableError | Allow UID2 core and opt-out service IP addresses in the egress firewall. For IP addresses and DNS details, refer to the logs. |
388
393
394
+
### Runtime Errors
395
+
396
+
The following errors might occur during operator runtime:
397
+
398
+
<SnptRuntimeErrors />
399
+
389
400
## Technical Support
390
401
391
402
If you have trouble subscribing to the product, or deploying, [contact us](mailto:aws-mktpl-uid@thetradedesk.com).
For information about supported versions and deprecation dates, see [Private Operator Versions](../ref-info/deprecation-schedule.md#private-operator-versions).
@@ -349,17 +350,27 @@ To upgrade, complete the following steps:
349
350
350
351
## UID2 Operator Error Codes
351
352
352
-
The following table lists errors that might occur during a Private Operator's startup sequence.
353
+
The following sections list error codes that might occur during a Private Operator's startup or runtime.
353
354
354
355
:::note
355
-
Error codes for Private Operator startup issues are applicable only to release v5.49.7 and later.
356
+
Error codes for Private Operator issues are applicable only to release v5.49.7 and later.
356
357
:::
357
358
359
+
### Startup Errors
360
+
361
+
The following errors might occur during operator startup:
362
+
358
363
| Error Code | Issue | Steps to Resolve |
359
364
| :--- | :--- | :--- |
360
365
| E02 | OperatorKeyNotFoundError | Make sure that the secret vault and secret name that store the operator key are correctly configured. Make sure they are set as `VAULT_NAME` and `OPERATOR_KEY_SECRET_NAME`. |
361
366
| E03 | ConfigurationMissingError | Required attributes are missing in the configuration. Refer to the logs for details and update the missing attributes before running the Azure operator. |
362
367
| E04 | ConfigurationValueError | A configuration value is invalid. Verify that the configuration values align with the required format and environment. Note: `debug_mode = true` is allowed only in the `integ` environment. Check the logs for more details. |
363
368
| E05 | OperatorKeyValidationError | Ensure the operator key is correct for the environment and matches the one provided to you. |
364
369
| E06 | UID2ServicesUnreachableError | Allow UID2 core and opt-out service IP addresses in the egress firewall. For IP addresses and DNS details, refer to the logs. |
365
-
| E08 | OperatorKeyPermissionError | The managed identity (specified via the `operatorIdentifier` parameter) that launches the container must have access to the key vault where the operator key is stored. The value of `operatorIdentifier` must be identical across all configuration JSON files. |
370
+
| E08 | OperatorKeyPermissionError | The managed identity (specified via the `operatorIdentifier` parameter) that launches the container must have access to the key vault where the operator key is stored. The value of `operatorIdentifier` must be identical across all configuration JSON files. |
371
+
372
+
### Runtime Errors
373
+
374
+
The following errors might occur during operator runtime:
For information about supported versions and deprecation dates, see [Private Operator Versions](../ref-info/deprecation-schedule.md#private-operator-versions).
@@ -545,12 +546,16 @@ The Private Operator for GCP exposes [Prometheus-formatted metrics](https://prom
545
546
546
547
## UID2 Operator Error Codes
547
548
548
-
The following table lists errors that might occur during a Private Operator's startup sequence.
549
+
The following sections list error codes that might occur during a Private Operator's startup or runtime.
549
550
550
551
:::note
551
-
Error codes for Private Operator startup issues are applicable only to release v5.49.7 and later.
552
+
Error codes for Private Operator issues are applicable only to release v5.49.7 and later.
552
553
:::
553
554
555
+
### Startup Errors
556
+
557
+
The following errors might occur during operator startup:
558
+
554
559
| Error Code | Issue | Steps to Resolve |
555
560
| :--- | :--- | :--- |
556
561
| E02 | OperatorKeyNotFoundError | Make sure that the secret name specified exists in GCP Secret Manager in the same project as the operator, and that the service account has permission to access the secret. Make sure it's set to: `tee-env-API_TOKEN_SECRET_NAME`. If needed, you can check the logs for the specific secret name. |
@@ -559,3 +564,9 @@ Error codes for Private Operator startup issues are applicable only to release v
559
564
| E05 | OperatorKeyValidationError | Ensure the operator key is correct for the environment and matches the one provided to you. |
560
565
| E06 | UID2ServicesUnreachableError | Allow UID2 core and opt-out service IP addresses in the egress firewall. For IP addresses and DNS details, refer to the logs. |
561
566
| E08 | OperatorKeyPermissionError | Attach a service account to the Compute Engine instance template. The UID2 Operator needs these permissions to access the operator key from the GCP Secret Manager. |
567
+
568
+
### Runtime Errors
569
+
570
+
The following errors might occur during operator runtime:
<dd>In the context of mapping <ahref="#gl-dii">DII</a> to raw UID2s, a refresh timestamp is a Unix timestamp (in seconds) returned in the <code>r</code> field of the <ahref="../endpoints/post-identity-map">POST /identity/map</a> endpoint response. The raw UID2 is guaranteed to be valid until this timestamp. It is refreshed at some point after this time.</dd>
405
+
<dd>In the context of mapping <ahref="#gl-dii">DII</a> to raw UID2s, a refresh timestamp is a Unix timestamp (in seconds) returned in the <code>r</code> field of the <ahref="../endpoints/post-identity-map">POST /identity/map</a> endpoint response. The raw UID2 is valid until this timestamp. It is refreshed at some point after this time.</dd>
406
406
<dd>Use the refresh timestamp to determine when to regenerate raw UID2s for your stored data. We recommend checking for refresh opportunities daily by comparing the current time with the stored refresh timestamps.</dd>
| Error Code | Issue | How to Identify in Logs | Steps to Resolve |
2
+
| :--- | :--- | :--- | :--- |
3
+
| E12 | Data Download Failure | Look for log messages containing `E12: Data Download Failure` or `Failed to load` errors from `RotatingStoreVerticle`. These messages include HTTP status codes (for example, `HTTP response code 403`) or exception types (for example, `exception: IOException`). | Check the HTTP status code or exception in the error message and resolve accordingly:<br/>**404 errors**: Verify that the operator key is valid for the environment.<br/>**403 errors**: Verify that the operator key and credentials are correct.<br/>**Timeout errors**: Verify network connectivity, check that firewall/security group settings allow outbound HTTPS (port 443), and ensure that the UID2 service endpoints are accessible.<br/>**500/503 errors**: This code indicates a temporary UID2 service issue. Retry, and if the error persists contact UID2 support. |
0 commit comments