sch-UID2-5558 v3 identity map #887
Conversation
| 複数のメールアドレス、電話番号、またはそれぞれのハッシュを、raw UID2 と <Link href="../ref-info/glossary-uid#gl-salt-bucket-id">salt bucket IDs</Link> にマッピングします。このエンドポイントを使用して、オプトアウト情報の更新をチェックすることもできます | ||
|
|
||
| Used by: このエンドポイントは、主に広告主やデータプロバイダーが使用します。詳細は [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) を参照してください。 | ||
|
|
||
| UID2 の Opt-Out ワークフローとユーザーが Opt-Out する方法の詳細は、[User Opt-Out](../getting-started/gs-opt-out.md) を参照してください。 | ||
|
|
||
| ## Version | ||
|
|
||
| This documentation is for the latest version of this endpoint. If you're using an earlier version, we recommend that you upgrade your integration. For migration steps, see [TODO]. |
There was a problem hiding this comment.
For now I think we should remove "If you're using an earlier version, we recommend that you upgrade your integration. For migration steps, see [TODO]."
There was a problem hiding this comment.
@sophia-chen-ttd @vishalegbert-ttd we should not make any edits that add English copy into the Japanese version. My bad. I see my comment in https://github.com/IABTechLab/uid2docs/pull/886/files#diff-809a0199a403c7ccc7be74f78522559c07b514520b28a7f5b5c3b24a88364f2f. We need to make any necessary changes so that it builds correctly and the links work, but leave the rest for the translator. Apologies for this.
There was a problem hiding this comment.
I've left the /identity/map endpoint page empty, reverted all copy changes in the Japanese version. Only updated links to point to the /v2/identity/map page
| # POST /identity/map (v2) | ||
|
|
||
| :::important | ||
| This documentation is for an earlier version of the `POST /identity/map` endpoint. If you're using this earlier version, we recommend upgrading. For the latest version, v3, see [POST /identity/map](post-identity-map.md). For migration steps, see [TODO]. |
There was a problem hiding this comment.
For now I think we should remove this whole alert block
There was a problem hiding this comment.
@vishalegbert-ttd I do think that somehow we need to differentiate between the two versions, and who should use which. Usually, for versioning, we do that at the top of the doc: see https://unifiedid.com/docs/sdks/sdk-ref-javascript-v3. That's why this is in here, FYI.
There was a problem hiding this comment.
I've linked the V3 endpoint page from the V2 endpoint page
|
|
||
| Identifiers that cannot be mapped to a UID2 are mapped to an error object with the reason for unsuccessful mapping. An unsuccessful mapping occurs if the identifier is considered invalid or if the identifier has opted out from the UID2 ecosystem. In these cases, the response status is still "success". | ||
| The response arrays preserve the order of input arrays. Each element in the response array maps directly to the element at the same index in the corresponding request array. This ensures that results can be reliably associated with their corresponding inputs based on array position. |
There was a problem hiding this comment.
It'd be nice to get an example for this. We have an example input above and an example output below, but they do not actually match and do not illustrate the point.
There was a problem hiding this comment.
Thanks, added an example
docs/endpoints/post-identity-map.md
Outdated
| --- | ||
|
|
||
| import Link from '@docusaurus/Link'; | ||
|
|
||
| # POST /identity/map | ||
|
|
||
| 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. | ||
| Maps multiple email addresses, phone numbers, or their respective hashes to their UID2s. You can also use this endpoint to check for updates to opt-out information, check when a UID2 can be refreshed, or view the previous UID2 if the current UID2 is less than 90 days old. |
There was a problem hiding this comment.
@vishalegbert-ttd need help with this: "check when a UID2 can be refreshed"
A UID2 can always be refreshed. Not sure what this should say. Check the time stamp to determine when to refresh the UID2, perhaps?
gmsdelmundo
force-pushed
the
sch-UID2-5558-v3-identity-map
branch
2 times, most recently
from
9508813 to
b09c6f2
Compare
Preview: https://unifiedid2.github.io/uid2-docs-preview/docs/endpoints/post-identity-map