Skip to content

Commit bad1d0c

Browse files
committed
Merge branch 'main' into xuy-UID2-4736-update-private-operator-docs
2 parents 82ed57f + b841e3d commit bad1d0c

File tree

237 files changed

+7146
-1298
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

237 files changed

+7146
-1298
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Vulnerability Scan Failure Slack Notify
2+
on:
3+
workflow_dispatch:
4+
inputs:
5+
vulnerability_severity:
6+
description: The severity to fail the workflow if such vulnerability is detected. DO NOT override it unless a Jira ticket is raised. DO NOT use 'CRITICAL' unless a Jira ticket is raised.
7+
type: choice
8+
options:
9+
- CRITICAL,HIGH
10+
- CRITICAL,HIGH,MEDIUM
11+
- CRITICAL
12+
default: 'CRITICAL,HIGH'
13+
schedule:
14+
- cron: '0 16 * * *' # 9:00 AM GMT -7
15+
- cron: '0 0 * * *' # 5:00 PM GMT -7
16+
17+
jobs:
18+
vulnerability-scan-failure-notify:
19+
uses: IABTechLab/uid2-shared-actions/.github/workflows/shared-vulnerability-scan-failure-notify.yaml@v3
20+
secrets:
21+
SLACK_WEBHOOK : ${{ secrets.SLACK_WEBHOOK }}
22+
with:
23+
scan_type: fs
24+
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { Redirect } from '@docusaurus/router';
2+
3+
<Redirect to="/docs/category/dsp-integrations-1" />;
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { Redirect } from '@docusaurus/router';
2+
3+
<Redirect to="/docs/guides/integration-options-private-operator" />;
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { Redirect } from '@docusaurus/router';
2+
3+
<Redirect to="/docs/guides/integration-options-private-operator" />;
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { Redirect } from '@docusaurus/router';
2+
3+
<Redirect to="/docs/guides/integration-options-private-operator" />;
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { Redirect } from '@docusaurus/router';
2+
3+
<Redirect to="/docs/guides/integration-options-private-operator" />;
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { Redirect } from '@docusaurus/router';
2+
3+
<Redirect to="/docs/guides/integration-options-private-operator" />;

docs/endpoints/post-identity-buckets.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import Link from '@docusaurus/Link';
1111

1212
Monitors rotated <Link href="../ref-info/glossary-uid#gl-salt-bucket">salt buckets</Link>.
1313

14-
Used by: This endpoint is used mainly by advertisers and data providers. For details, see [Advertiser/Data Provider Integration Guide](../guides/integration-advertiser-dataprovider-overview.md).
14+
Used by: This endpoint is used mainly by advertisers and data providers. For details, see [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md).
1515

1616
## Request Format
1717

@@ -30,7 +30,7 @@ You must encrypt all requests using your secret. For details, and code examples
3030
| `{environment}` | string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`<br/>Production environment: The best choice depends on where your users are based. For information about how to choose the best URL for your use case, and a full list of valid base URLs, see [Environments](../getting-started/gs-environments.md). |
3131

3232
:::note
33-
The integration environment and the production environment require different <Link href="../ref-info/glossary-uid#gl-api-key">API keys</Link>.
33+
The integration environment and the production environment require different <Link href="../ref-info/glossary-uid#gl-api-key">API keys</Link>. For information about getting credentials for each environment, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials).
3434
:::
3535

3636
### Unencrypted JSON Body Parameters

docs/endpoints/post-identity-map.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import Link from '@docusaurus/Link';
1111

1212
Maps multiple email addresses, phone numbers, or their respective hashes to their raw UID2s and <Link href="../ref-info/glossary-uid#gl-salt-bucket-id">salt bucket IDs</Link>. You can also use this endpoint to check for updates to opt-out information.
1313

14-
Used by: This endpoint is used mainly by advertisers and data providers. For details, see [Advertiser/Data Provider Integration Guide](../guides/integration-advertiser-dataprovider-overview.md).
14+
Used by: This endpoint is used mainly by advertisers and data providers. For details, see [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md).
1515

1616
For details about the UID2 opt-out workflow and how users can opt out, see [User Opt-Out](../getting-started/gs-opt-out.md).
1717

@@ -22,7 +22,7 @@ Here's what you need to know:
2222
- The maximum request size is 1MB.
2323
- To map a large number of email addresses, phone numbers, or their respective hashes, send them in *sequential* batches with a maximum batch size of 5,000 items per batch.
2424
- Unless you are using a <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link>, do not send batches in parallel. In other words, use a single HTTP connection and send batches of hashed or unhashed <Link href="../ref-info/glossary-uid#gl-dii">directly identifying information (DII)</Link> values consecutively, without creating multiple parallel connections.
25-
- Be sure to store mappings of email addresses, phone numbers, or their respective hashes.<br/>Not storing mappings could increase processing time drastically when you have to map millions of email addresses or phone numbers. Recalculating only those mappings that actually need to be updated, however, reduces the total processing time because only about 1/365th of raw UID2s need to be updated daily. See also [Advertiser/Data Provider Integration Guide](../guides/integration-advertiser-dataprovider-overview.md) and [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers).
25+
- Be sure to store mappings of email addresses, phone numbers, or their respective hashes.<br/>Not storing mappings could increase processing time drastically when you have to map millions of email addresses or phone numbers. Recalculating only those mappings that actually need to be updated, however, reduces the total processing time because only about 1/365th of raw UID2s need to be updated daily. See also [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) and [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers).
2626

2727
## Request Format
2828

@@ -41,7 +41,7 @@ You must encrypt all requests using your secret. For details, and code examples
4141
| `{environment}` | string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`<br/>Production environment: The best choice depends on where your users are based. For information about how to choose the best URL for your use case, and a full list of valid base URLs, see [Environments](../getting-started/gs-environments.md). |
4242

4343
:::note
44-
The integration environment and the production environment require different <Link href="../ref-info/glossary-uid#gl-api-key">API keys</Link>.
44+
The integration environment and the production environment require different <Link href="../ref-info/glossary-uid#gl-api-key">API keys</Link>. For information about getting credentials for each environment, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials).
4545
:::
4646

4747
### Unencrypted JSON Body Parameters

docs/endpoints/post-optout-status.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Used by: This endpoint is used by advertisers, data providers, DSPs, and sharers
1515

1616
For details, refer to the following documentation, depending on your role:
1717

18-
- [Advertiser/Data Provider Integration Guide](../guides/integration-advertiser-dataprovider-overview.md)
18+
- [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md)
1919
- [DSP Integration Guide](../guides/dsp-guide.md)
2020
- [UID2 Sharing: Overview](../sharing/sharing-overview)
2121

@@ -43,7 +43,7 @@ You must encrypt all requests using your secret. For details, and code examples
4343
| `{environment}` | string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`<br/>Production environment: The best choice depends on where your users are based. For information about how to choose the best URL for your use case, and a full list of valid base URLs, see [Environments](../getting-started/gs-environments.md). |
4444

4545
:::note
46-
The integration environment and the production environment require different <Link href="../ref-info/glossary-uid#gl-api-key">API keys</Link>.
46+
The integration environment and the production environment require different <Link href="../ref-info/glossary-uid#gl-api-key">API keys</Link>. For information about getting credentials for each environment, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials).
4747
:::
4848

4949
### Unencrypted JSON Body Parameters

0 commit comments

Comments
 (0)