Adds region to Customer Privacy API #1832
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rcaplanshopify
commented
Mar 18, 2024
Comment on lines
+1801
to
+1804
| * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails. | ||
| * | ||
| * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). | ||
| */ |
There was a problem hiding this comment.
It seems strange that these don't render in the docs. Are the examples mean for IDE type signatures only?
I see the protected customer data information render for country and province code, but no examples for them, either.
There was a problem hiding this comment.
Ya, @examples isn't supported yet. Only helpful for IDE.
jamesvidler
approved these changes
Mar 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
Adds region property to Customer Privacy API to allow partners to determine if/when to render more granular consent controls.
Solution
The update uses the
getRegionmethod of theconsent-tracking-apipackage to surface theregionvalue from the_tracking_consentcookie.The Customer Privacy API parses the string that contains country and province data (when available) and translates it into country and province code values for the new
regionobject.🎩
Docs
Checklist