gwh-APIDOCS-3914-change-heading-case#1010
Conversation
|
|
||
| 1. [Create a clean room for UID2 collaboration](#create-clean-room-for-uid2-collaboration). | ||
| 1. [Send your Databricks sharing identifier to your UID2 contact](#send-sharing-identifier-to-uid2-contact). | ||
| 1. [Send your databricks sharing identifier to your UID2 contact](#send-sharing-identifier-to-uid2-contact). |
There was a problem hiding this comment.
uppercase "data bricks" here and elsewhere
There was a problem hiding this comment.
Fixed, thx! There was one instance only (and none in EUID).
| If your UID2s are not being passed through Google, make sure that you chose the correct Web Signal Deployment Method during setup. | ||
|
|
||
| For details, see the **Important** note in [Allow Secure Signals Sharing](#allow-secure-signals-sharing). | ||
| For details, see the **Important** note in [Allow Secure Signals sharing](#allow-secure-signals-sharing). |
There was a problem hiding this comment.
is "Secure Signals" a proper name?
There was a problem hiding this comment.
| ::: | ||
|
|
||
| ## Private Operator Benefits | ||
| ## Private Operator benefits |
There was a problem hiding this comment.
is "Private Operator" a proper noun?
There was a problem hiding this comment.
Yes it is -- for UID2/EUID. Should be consistent throughout (and it is).
See https://unifiedid.com/docs/ref-info/glossary-uid#gl-private-operator
Also https://unifiedid.com/docs/ref-info/glossary-uid#gl-public-operator
| <SnptUpgradePolicy /> | ||
|
|
||
| ## Keeping the Operator Key Secure | ||
| ## Keeping the operator key secure |
There was a problem hiding this comment.
Is this related to "Private Operator?" Should it be reverted to uppercase?
There was a problem hiding this comment.
Private Operator is initial cap for UID2/EUID but operator key is not. Probably the Public Operator has an operator key also (though I'm not sure about that).
I checked for consistency with EUID and this is consistent. No change here.
Update based on looking at glossary entries for you! Operator is initial cap in the glossary: https://unifiedid.com/docs/ref-info/glossary-uid#gl-operator
So... this is an inconsistency which I'd like to address, but not on this PR. This is consistent with EUID which SW reviewed. If you're OK with this I'll write a follow-up Jira for a clean sweep on this, for UID2 and EUID both. LMK. Thx much.
| | Set `params.uid2Token` to the response body as a JavaScript object. | See [Client Refresh mode uid2Token example](#client-refresh-mode-uid2token-example) | You might choose to provide the response body via `params.uid2Token` in either of these cases:<ul><li>If you are already storing a lot of data in the cookie and adding the response body might exceed the cookie size limit.</li><li>If you prefer to have the Prebid module store the token value for you.</li></ul> | | ||
|
|
||
| #### Client Refresh Mode Cookie Example | ||
| #### Client Refresh mode cookie example |
There was a problem hiding this comment.
is "Client Refresh" a proper noun?
There was a problem hiding this comment.
@ericwTTD Yes per SW senior UID2 Eng. This came from his edits on EUID therefore I believe yes. I had it the other way at first but this was one of the things I had to fix. There are two modes in this doc and both of them are initial cap: Client Refresh mode and Server-Only mode.
However -- I did a pass to check for consistent capitalization across all docs and found two instances in UID2, one in EUID, where it wasn't consistent. So this is in the updates. Thx.
| | :--- | :--- | :--- | | ||
| | `UID2_TOKEN` | TEXT | The value is one of the following:<ul><li>Encryption successful: The UID2 token containing the raw UID2.</li><li>Encryption not successful: `NULL`.</li></ul> | | ||
| | `ENCRYPTION_STATUS` | TEXT | The value is one of the following:<ul><li>Encryption successful: `NULL`.</li><li>Encryption not successful: The reason why the raw UID2 was not encrypted. For example: `INVALID_RAW_UID2` or `INVALID NOT_AUTHORIZED_FOR_MASTER_KEY`.<br/>For details, see [Values for the ENCRYPTION_STATUS Column](#values-for-the-encryption_status-column).</li></ul> | | ||
| | `ENCRYPTION_STATUS` | TEXT | The value is one of the following:<ul><li>Encryption successful: `NULL`.</li><li>Encryption not successful: The reason why the raw UID2 was not encrypted. For example: `INVALID_RAW_UID2` or `INVALID NOT_AUTHORIZED_FOR_MASTER_KEY`.<br/>For details, see [Values for the encryption_status column](#values-for-the-encryption_status-column).</li></ul> | |
There was a problem hiding this comment.
ENCRYPTION_STATUS should remain all caps?
There was a problem hiding this comment.
Yes! Great catch. Fixed all instances. Doesn't exist in EUID. TYSM.
| | `UID2` | TEXT | The value is one of the following:<ul><li>Decryption successful: The raw UID2 corresponding to the UID2 token.</li><li>Decryption not successful: `NULL`.</li></ul> | | ||
| | `SITE_ID` | INT | The value is one of the following:<ul><li>Decryption successful: The identifier of the UID2 participant that encrypted the token.</li><li>Decryption not successful: `NULL`.</li></ul> | | ||
| | `DECRYPTION_STATUS` | TEXT | The value is one of the following:<ul><li>Decryption successful: `NULL`.</li><li>Decryption not successful: The reason why the UID2 token was not decrypted; for example, `EXPIRED_TOKEN`.<br/>For details, see [Values for the DECRYPTION_STATUS Column](#values-for-the-decryption_status-column).</li></ul> | | ||
| | `DECRYPTION_STATUS` | TEXT | The value is one of the following:<ul><li>Decryption successful: `NULL`.</li><li>Decryption not successful: The reason why the UID2 token was not decrypted; for example, `EXPIRED_TOKEN`.<br/>For details, see [Values for the decryption_status column](#values-for-the-decryption_status-column).</li></ul> | |
There was a problem hiding this comment.
DECRYPTION_STATUS should remain all caps in description?
There was a problem hiding this comment.
Yes! Same thing: fixed 12 instances. Doesn't exist in EUID. TYSM.
| | `UID` | TEXT | The value is one of the following:<ul><li>DII was successfully mapped: The UID2 associated with the DII.</li><li>DII was not successfully mapped: `NULL`.</li></ul> | | ||
| | `BUCKET_ID` | TEXT | The value is one of the following:<ul><li>DII was successfully mapped: The ID of the <Link href="../ref-info/glossary-uid#gl-salt-bucket">salt bucket</Link> used to generate the UID2. This ID maps to the bucket ID in the `SALT_BUCKETS` view.</li><li>DII was not successfully mapped: `NULL`.</li></ul> | | ||
| | `UNMAPPED` | TEXT | The value is one of the following:<ul><li>DII was successfully mapped: `NULL`.</li><li>DII was not successfully mapped: The reason why the identifier was not mapped: `OPTOUT`, `INVALID IDENTIFIER`, or `INVALID INPUT TYPE`.<br/>For details, see [Values for the UNMAPPED Column](#values-for-the-unmapped-column).</li></ul> | | ||
| | `UNMAPPED` | TEXT | The value is one of the following:<ul><li>DII was successfully mapped: `NULL`.</li><li>DII was not successfully mapped: The reason why the identifier was not mapped: `OPTOUT`, `INVALID IDENTIFIER`, or `INVALID INPUT TYPE`.<br/>For details, see [Values for the unmapped column](#values-for-the-unmapped-column).</li></ul> | |
There was a problem hiding this comment.
UNMAPPED should stay all caps?
There was a problem hiding this comment.
Yes, TYSM. Fixed 4 instances. Doesn't exist in EUID.
| #### Get the Principal ID of the Managed Identity | ||
| #### Get the principal ID of the managed identity | ||
|
|
||
| To get the Principal ID, run the following command, using your own values as needed: |
There was a problem hiding this comment.
@ericwTTD thx! Agree, after some research: https://learn.microsoft.com/en-us/graph/utcm-authentication-setup#set-up-the-tcm-service-principal.
And done: one instance in each language, not applicable to EUID.
| | Reloads `syslog-ng`. | `sudo /usr/sbin/syslog-ng-ctl reload` | | ||
|
|
||
| ## Keeping the Operator Key Secure | ||
| ## Keeping the operator key secure |
There was a problem hiding this comment.
should "operator" be uppercase?
There was a problem hiding this comment.
@ericwTTD I think not. Made sure it's in sync with EUID which was very thoroughly reviewed by Eng, and it is.
Update: see my earlier response. This is a change we should make in UID2 and EUID to be consistent, and it affects more than headings. Targeted for a separate Jira if you're OK with that.
| <SnptRotatingTheKeys /> | ||
|
|
||
| ## UID2 Operator Error Codes | ||
| ## UID2 Operator error codes |
There was a problem hiding this comment.
should "Operator" be lowercase?
There was a problem hiding this comment.
@ericwTTD See my previous comment. Consistent with EUID but should be addressed on a follow-up pass.
| ``` | ||
|
|
||
| ### Set Up the Gateway Load Balancer | ||
| ### Set up the gateway load balancer |
There was a problem hiding this comment.
in body text this is a proper noun?
There was a problem hiding this comment.
Great catch. TYSM. Fixed in all instances.
| To set up and configure the account that you created when you installed the gcloud CLI, complete the following steps. Replace the placeholder values with your own valid values. | ||
|
|
||
| 1. Switch to the project that you created in [Confidential Space Account Setup](#confidential-space-account-setup): | ||
| 1. Switch to the project that you created in [Confidential Space account setup](#confidential-space-account-setup): |
There was a problem hiding this comment.
is "Confidential Space" a proper noun?
There was a problem hiding this comment.
| ::: | ||
|
|
||
| #### Create Secret for the Operator Key in Secret Manager | ||
| #### Create secret for the operator key in secret manager |
There was a problem hiding this comment.
is "secret manager" a proper noun?
There was a problem hiding this comment.
Great catch, thank you. It is: https://cloud.google.com/security/products/secret-manager
Fixed, 6 instances.
| November 2, 2023 | ||
|
|
||
| The Client-Side Integration Guide for Prebid.js is a completely new document at the existing URL, covering a way of integrating UID2 with Prebid that does not require any server-side work. | ||
| The Client-side integration guide for Prebid.js is a completely new document at the existing URL, covering a way of integrating UID2 with Prebid that does not require any server-side work. |
There was a problem hiding this comment.
keep "Client" uppercase?
There was a problem hiding this comment.
I think you're saying that Client should be lowercase here? Not sure.
Anyway this is a reference to a guide title, without a link on it. It's history. But what I did was apply italics on it, as we do elsewhere for the few references to a guide that are not actually links. So it's consistent.
This string does not exist in EUID.
| <CustomTagsContainer tags="Guides, Mobile, SDKs"> | ||
|
|
||
| ### IMA Mobile Plugin for Android | ||
| ### IMA mobile Plugin for Android |
There was a problem hiding this comment.
should "Plugin" also be lowercase?
There was a problem hiding this comment.
Good point, TY!
I'd originally lowercased plugin in titles, but as a result of the EUID edits I initial capped it, per edits from the senior engineer, as a product name. But, looking at EUID, it's IMA Plugin for Android etc... not IMA mobile Plugin for Android, which looks weird re case and is also redundant.
The "xxx Plugin for xxx" naming is consistent across everything except these update announcements. With Plugin capitalized.
I updated these to remove the word "mobile" in the title here. There are no other instances.
| <CustomTagsContainer tags="Infrastructure"> | ||
|
|
||
| ### UID2 Website in Japanese | ||
| ### UID2 website in japanese |
There was a problem hiding this comment.
Aargh great catch TYSM.
| As a publisher, there are two ways to use the SDK for Java: | ||
| 1. [**Basic Usage**](#basic-usage) is for publishers who want to use this SDK's HTTP implementation (synchronous [OkHttp](https://square.github.io/okhttp/)). | ||
| 2. [**Advanced Usage**](#advanced-usage) is for publishers who prefer to use their own HTTP library. | ||
| 1. [**basic usage**](#basic-usage) is for publishers who want to use this SDK's HTTP implementation (synchronous [OkHttp](https://square.github.io/okhttp/)). |
There was a problem hiding this comment.
Great catch thx. Done, but also I removed the formatting on the link. And the same issue existed in EUID so I fixed that too.
| 2. [**Advanced Usage**](#advanced-usage) is for publishers who prefer to use their own HTTP library. | ||
| 1. [**basic usage**](#basic-usage) is for publishers who want to use this SDK's HTTP implementation (synchronous [OkHttp](https://square.github.io/okhttp/)). | ||
| 2. [**advanced usage**](#advanced-usage) is for publishers who prefer to use their own HTTP library. | ||
|
|
There was a problem hiding this comment.
Yep fixed as above. TYSM.
| @@ -24,10 +24,10 @@ The Trade Desk (現在の UID2 Administrator) とすでに取引関係がある | |||
|
|
|||
| | Your Role | Contact Email | | |||
| | :--- | :--- | | |||
| | パブリッシャー、アプリ開発者 | [UID2publishers@thetradedesk.com](mailto:UID2publishers@thetradedesk.com) | | |||
| | 代理店、ブランド、DSP、SSP、Customer Data Platform (CDP)、データプロバイダー | [UID2partners@thetradedesk.com](mailto:UID2partners@thetradedesk.com) | | |||
| | パブリッシャー、アプリ開発者 | [Uid2publishers@thetradedesk.com](mailto:UID2publishers@thetradedesk.com) | | |||
| | パブリッシャー、アプリ開発者 | [UID2publishers@thetradedesk.com](mailto:UID2publishers@thetradedesk.com) | | ||
| | 代理店、ブランド、DSP、SSP、Customer Data Platform (CDP)、データプロバイダー | [UID2partners@thetradedesk.com](mailto:UID2partners@thetradedesk.com) | | ||
| | パブリッシャー、アプリ開発者 | [Uid2publishers@thetradedesk.com](mailto:UID2publishers@thetradedesk.com) | | ||
| | 代理店、ブランド、DSP、SSP、Customer Data Platform (CDP)、データプロバイダー | [Uid2partners@thetradedesk.com](mailto:UID2partners@thetradedesk.com) | |
|
|
||
| この条件を満たす必要がある場合、または質問がある場合は、[UID2partners@thetradedesk.com](mailto:UID2partners@thetradedesk.com) までお問い合わせください。 | ||
| この条件を満たす必要がある場合、または質問がある場合は、[Uid2partners@thetradedesk.com](mailto:UID2partners@thetradedesk.com) までお問い合わせください。 |
There was a problem hiding this comment.
revert email formatting?
| @@ -80,9 +80,9 @@ Server-Side SDK を使用している場合、SDK はエンドポイントに関 | |||
| 1. [Establish identity: capture user data](#establish-identity-capture-user-data) | |||
| 2. [Bid using a UID2 token](#bid-using-a-uid2-token) | |||
| 3. [Refresh a UID2 token](#refresh-a-uid2-token) | |||
| 4. [Clear Identity: user logout](#clear-identity-user-logout) | |||
| 4. [Clear identity: user logout](#clear-identity-user-logout) | |||
| @@ -136,9 +136,9 @@ DII が電話番号の場合、UID2 [電話番号正規化](../getting-started/g | |||
| | :--- | :--- | :--- | | |||
| | `UID2` | TEXT | DII は正常にマッピングされました: <br/>DII は正常にマップされませんでした: `NULL`。 | | |||
| | `BUCKET_ID` | TEXT | DII は正常にマップされました: UID2 の生成に使われたセカンドレベルのソルトバケットの ID。この ID は `UID2_SALT_BUCKETS` ビューのバケット ID に対応します。<br/>DII は正常にマップされませんでした: `NULL`。 | | |||
| | `UNMAPPED` | TEXT | DII は正常にマッピングされました: `NULL`<br/>DII は正常にマップされませんでした: `NULL`: DII は正常にマップされませんでした: 識別子がマップされなかった理由: `OPTOUT`、`INVALID IDENTIFIER`、`INVALID INPUT TYPE` のいずれか。詳細は [Values for the UNMAPPED Column](#values-for-the-unmapped-column) を参照してください。 | | |||
| | `UNMAPPED` | TEXT | DII は正常にマッピングされました: `NULL`<br/>DII は正常にマップされませんでした: `NULL`: DII は正常にマップされませんでした: 識別子がマップされなかった理由: `OPTOUT`、`INVALID IDENTIFIER`、`INVALID INPUT TYPE` のいずれか。詳細は [Values for the unmapped column](#values-for-the-unmapped-column) を参照してください。 | | |||
There was a problem hiding this comment.
Revert "unmapped" before "column?"
| @@ -8,7 +8,7 @@ displayed_sidebar: docs | |||
|
|
|||
| import Link from '@docusaurus/Link'; | |||
|
|
|||
| # UID2 GMA Plugin for Android Integration Guide | |||
| # UID2 GMA Plugin for Android integration guide | |||
| @@ -156,7 +156,7 @@ Key Vault を作成したら、[managed identity](https://learn.microsoft.com/en | |||
| | Parameter | Description | | |||
| | :--- | :--- | | |||
| | `vaultName` | Operator Key シークレットをホストするための Key Vault の名前。選択する名前はグローバルに一意である必要があります。 | | |||
| | `operatorKeyValue` | アカウント設定の一環として UID チームから受け取った `OPERATOR_KEY` シークレット値 ([Set Up UID2 Operator Account](#set-up-uid2-operator-account) を参照)。この値はあなたに固有であり、パスワードとして機能します。安全で秘密に保つ必要があります。 | | |||
| | `operatorKeyValue` | アカウント設定の一環として UID チームから受け取った `OPERATOR_KEY` シークレット値 ([Set up UID2 Operator account](#set-up-uid2-operator-account) を参照)。この値はあなたに固有であり、パスワードとして機能します。安全で秘密に保つ必要があります。 | | |||
| @@ -749,84 +749,84 @@ SDK for JavaScript Version 3 の機能強化に伴い、ドキュメントが大 | |||
|
|
|||
| <CustomTagsContainer tags="Guides, Private Operator"> | |||
|
|
|||
| ### Private Operator Guide for Google Confidential Space | |||
| ### Private Operator guide for Google confidential space | |||
There was a problem hiding this comment.
uppercase "Confidential Space?"
|
|
||
| パブリッシャーとして、SDK for Java を使用するには 2 つの方法があります: | ||
| 1. [**Basic Usage**](#basic-usage) は、この SDK の HTTP 実装 (synchronous [OkHttp](https://square.github.io/okhttp/)) を使いたいパブリッシャー向けです。 | ||
| 2. [**Advanced Usage**](#advanced-usage) は、独自の HTTP ライブラリを使用したいパブリッシャー向けです。 | ||
| 1. [**basic usage**](#basic-usage) は、この SDK の HTTP 実装 (synchronous [OkHttp](https://square.github.io/okhttp/)) を使いたいパブリッシャー向けです。 |
| 1. [**Basic Usage**](#basic-usage) は、この SDK の HTTP 実装 (synchronous [OkHttp](https://square.github.io/okhttp/)) を使いたいパブリッシャー向けです。 | ||
| 2. [**Advanced Usage**](#advanced-usage) は、独自の HTTP ライブラリを使用したいパブリッシャー向けです。 | ||
| 1. [**basic usage**](#basic-usage) は、この SDK の HTTP 実装 (synchronous [OkHttp](https://square.github.io/okhttp/)) を使いたいパブリッシャー向けです。 | ||
| 2. [**advanced usage**](#advanced-usage) は、独自の HTTP ライブラリを使用したいパブリッシャー向けです。 |
Change all headings in the docs from heading case to sentence case, including h1 (using a Claude script).
includes YAML values.