Add tracking_token documentation for explicit device linking#1589
Add tracking_token documentation for explicit device linking#1589
Conversation
Summary of ChangesHello @oschwald, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces and documents the Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
Deploying dev-site with
|
| Latest commit: |
8ad7ecd
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://1ad0d98c.dev-site-4ua.pages.dev |
| Branch Preview URL: | https://greg-eng-4045.dev-site-4ua.pages.dev |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
The pull request introduces documentation for the tracking_token feature, including its addition to the device request schema, new warning codes, and an expanded device tracking page with an explicit device linking section. The changes generally improve clarity and provide necessary information for users to implement this new feature. All original comments have been retained as they align with general best practices for documentation and do not contradict the provided rules. I've focused on ensuring grammatical correctness, consistency in terminology, and adherence to the specified documentation style guide, particularly regarding articles, punctuation, and brand names. I've also identified an opportunity to improve the clarity of a sentence for better readability.
| {{</minfraud-schema-row>}} | ||
|
|
||
| {{< minfraud-schema-row key="tracking_token" type="request" valueType="string" valueTypeNote="max length: 255" >}} | ||
| The token returned by the [Device Tracking Add-On](/minfraud/track-devices) `trackDevice()` function, used for explicit device linking. When provided, this token enables high-confidence device matching that does not rely on IP address alone. |
There was a problem hiding this comment.
This sentence could be rephrased for better clarity. The current phrasing is a bit clunky. Consider simplifying it to improve readability.
| The token returned by the [Device Tracking Add-On](/minfraud/track-devices) `trackDevice()` function, used for explicit device linking. When provided, this token enables high-confidence device matching that does not rely on IP address alone. | |
| The token returned by the [Device Tracking Add-On](/minfraud/track-devices) `trackDevice()` function, used for explicit device linking. When provided, this token enables high-confidence device matching that does not rely solely on IP address. |
content/minfraud/track-devices.md
Outdated
|
|
||
| ### Mobile SDKs | ||
|
|
||
| The Android and iOS SDKs also support the tracking token feature for explicit |
There was a problem hiding this comment.
The word "tracking token" should be formatted as inline code using backticks for consistency with other technical terms in the documentation. This aligns with the style guide's recommendation for inline code formatting.
| The Android and iOS SDKs also support the tracking token feature for explicit | |
| The Android and iOS SDKs also support the `tracking token` feature for explicit |
References
- Format field names as code when referenced in prose:
ipv4_32(not plain text ipv4_32). (link)
oschwald
force-pushed
the
greg/eng-4045
branch
3 times, most recently
from
4f4449f to
f9ea5ee
Compare
Update API request/response docs and expand the device tracking page with explicit device linking guidance and examples. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
oschwald
force-pushed
the
greg/eng-4045
branch
from
f9ea5ee to
9ca9841
Compare
content/minfraud/track-devices.md
Outdated
| }) | ||
| ) | ||
| .then(({ trackingToken }) => { | ||
| // Store the tracking token to include in your minFraud API request |
There was a problem hiding this comment.
I wonder if here and the below example should say something like it's optional to do this.
content/minfraud/track-devices.md
Outdated
| - `script-src`: `device.maxmind.com` | ||
| - `connect-src`: `d-ipv4.mmapiws.com`, `d-ipv6.mmapiws.com` | ||
|
|
||
| ### Custom hostname |
There was a problem hiding this comment.
Should this be outside the explicit device linking section? i.e. ## maybe.
content/minfraud/track-devices.md
Outdated
| - Tokens should be treated as **transient**. Generate a fresh token for each | ||
| session or transaction rather than storing tokens long-term. | ||
|
|
||
| ### Content Security Policy (CSP) requirements |
content/minfraud/track-devices.md
Outdated
|
|
||
| ## Explicit device linking | ||
|
|
||
| By default, the minFraud service matches devices using IP address. This works |
There was a problem hiding this comment.
"using IP addresses" maybe? It reads a bit odd to me.
content/minfraud/track-devices.md
Outdated
| - **VPNs** where multiple users route traffic through the same VPN endpoint. | ||
|
|
||
| Explicit device linking solves this by using a `tracking_token` to match devices | ||
| with high confidence, independent of IP address. |
There was a problem hiding this comment.
"of the IP address" perhaps?
| | `SHIPPING_POSTAL_NOT_FOUND` | The shipping postal code could not be found in our database. This may impact our ability to provide accurate distance calculations. | | ||
| | `SHIPPING_REGION_NOT_FOUND` | The shipping region could not be found in our database. This may impact our ability to provide accurate distance calculations. | | ||
| | `TRACKING_TOKEN_INVALID` | The tracking token provided was invalid or malformed. | | ||
| | `TRACKING_TOKEN_NOT_FOUND` | The tracking token provided was not found on our system. | |
Address PR review feedback: add notes that tracking token capture is optional, pluralize "IP addresses", add article "the IP address", and fix "in our system" preposition. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
These sections apply to device tracking generally, not just explicit device linking, so they should be ## sections rather than ### subsections. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2 participants
Summary
tracking_tokento Device request schema in API docsTRACKING_TOKEN_INVALIDandTRACKING_TOKEN_NOT_FOUNDwarning codes to response docsENG-4045
Test plan
🤖 Generated with Claude Code