Add uid verify documentation to uid2docs#1003
Conversation
|
|
||
| ### UID Verify Chrome Extension | ||
|
|
||
| UID Verify is a Chrome browser extension for debugging UID2 and EUID integrations. It inspects SDK information on websites, tracks events and event history, and monitors storage (cookies and local storage). The extension supports integrations using Prebid.js and Google Secure Signals. |
There was a problem hiding this comment.
not sure if you need to say Google Chrome here instead of just Chrome. Also I think add UID before SDK information to be clear it is the UID SDK. if you do, it may need to be updated anywhere it says Chrome Web Store too.
There was a problem hiding this comment.
I updated this specific sentence with Google Chrom but @genwhittTTD let me know if we're supposed to use on over the other
docs/ref-info/ref-uid-verify.md
Outdated
|
|
||
| When integrating UID2 or EUID, it can be difficult to tell whether the SDK is initializing correctly, whether tokens are valid, or where in the lifecycle an error is occurring. UID Verify solves this by reading the SDK state, storage, and event stream directly from the page and presenting it in a structured, searchable interface. | ||
|
|
||
| The extension detects whether a page uses the UID2 SDK directly, Prebid.js, or Google Secure Signals (or a combination), and adjusts the displayed information accordingly. It supports both UID2 and EUID deployments. |
There was a problem hiding this comment.
"deployments" probably isn't the right word here, would say "integrations" or "use cases"
There was a problem hiding this comment.
also probably best when talking about the SDK to say UID SDK instead of UID2 SDK to be clear it could apply to UID2 or EUID
eiman-eltigani-ttd
force-pushed
the
eee-UID2-6591-add-uid2-verify-to-public-docs
branch
from
21117e1 to
590c7a2
Compare
| ::: | ||
|
|
||
| ## Interpreting Results | ||
|
|
There was a problem hiding this comment.
We need some lead-in copy here... so we don't have two consecutive section headers. Something simple to lead in to the content in the subsections.
docs/ref-info/ref-uid-verify.md
Outdated
| | Valid Identity | Whether the stored identity is currently valid — that is, the advertising token has not expired and the user has not opted out. | | ||
| | Optout Identity | Whether the identity reflects an opted-out user. | | ||
|
|
||
| **For Google Secure Signals integrations**, the tab shows the status of the secure signal and the current UID2 advertising token. If no signal has been generated yet, it indicates that neither a cached signal nor a UID2 SDK advertising token is available. Once the token is available, it confirms that it will be included in bid requests to Google Ad Manager. |
There was a problem hiding this comment.
Not totally understanding this but three small points:
- For Google Secure Signals integrations, the tab shows...
Here, I'm not sure why the bold. It's not a lead-in because it's followed by a comma. Missing context to know what to suggest.
- Once the token is available, it confirms that it will be included in bid requests to Google Ad Manager.
Rather than "Once" say "When..." because "once" has other meanings.
- (same sentence) Two many instances of "it" here, too close together.
docs/ref-info/ref-uid-verify.md
Outdated
|
|
||
| ### Callbacks Tab | ||
|
|
||
| The **Callbacks** tab is available for UID2 SDK integrations only. It displays the source code of all callback functions registered with the UID2 SDK, with syntax highlighting. This is useful for confirming that the correct callbacks are wired up and identifying where events are being handled in the page code. |
There was a problem hiding this comment.
Is there a more general term for "wired up"? Not sure what that is and maybe the audience will know but not sure. Does it mean, correctly set up / connected up? Or, working on the wire i.e. the web traffic? Or...?
If it's just my ignorance, no worries.
There was a problem hiding this comment.
Good call, updated in line 111 below to "registered" which is the standard developer term for this meaning the functions have been added to the SDK so that they are called automatically when each event occurs
docs/ref-info/ref-uid-verify.md
Outdated
|
|
||
| Use the search bar to filter by event type or token value. | ||
|
|
||
| This tab also includes an **Error Log** when errors are detected. The extension captures several categories of errors: failed network requests to the UID2 operator, failed resource loads (such as the UID2 SDK script), `console.error` calls from UID2 SDK code, and errors thrown by UID2 SDK methods. |
There was a problem hiding this comment.
Suggest bulleted list for the categories.
genwhittTTD
left a comment
genwhittTTD
left a comment
There was a problem hiding this comment.
Some comments. LMK any questions. Thx.
Co-authored-by: Gen Whitt <107279666+genwhittTTD@users.noreply.github.com>
Co-authored-by: Gen Whitt <107279666+genwhittTTD@users.noreply.github.com>
Co-authored-by: Gen Whitt <107279666+genwhittTTD@users.noreply.github.com>
Co-authored-by: Gen Whitt <107279666+genwhittTTD@users.noreply.github.com>
Co-authored-by: Gen Whitt <107279666+genwhittTTD@users.noreply.github.com>
Co-authored-by: Gen Whitt <107279666+genwhittTTD@users.noreply.github.com>
Co-authored-by: Gen Whitt <107279666+genwhittTTD@users.noreply.github.com>
Co-authored-by: Gen Whitt <107279666+genwhittTTD@users.noreply.github.com>
3 participants
Changes:
Integration Samples and Toolspage