Skip to main content
Anchor to consentManagement

consentManagement

query

Interaction of the current visitor consent with the configured consent policies of the shop.

Anchor to Possible returnsPossible returns

Anchor to ConsentManagementConsentManagement
•ConsentManagement!

Interaction of the current visitor consent with the configured consent policies of the shop.

Anchor to bannerbanner
•ConsentManagementBanner

The privacy banner that should be displayed to the visitor, if any, plus the list of country/regions configured in the cookie banner visibility.

Anchor to cookiescookies
•ConsentManagementCookies!
non-null

Given the provided visitor consent, the resulting ConsentManagementCookies that need to be setin the browser for the Consent Management Platform to work and respect visitor consent.

Arguments

Anchor to landingPagelandingPage
•String

A possible landing_page that was on hold to be set when consent is granted.

Anchor to origReferrerorigReferrer
•String

A possible referrer that was on hold to be set when consent is granted.

Anchor to visitorConsentvisitorConsent
•VisitorConsent!
required

The latest visitor consent that the cookies should be calculated for.

Anchor to visitorEmailvisitorEmail
•String

If known, the visitor email. It will be used to fetch their Do Not Sell my Data opt out preferences if any.

Anchor to currentCookiescurrentCookies
•String!
non-null

For debugging purposes, decodes the cookies from _shopify_essential, _shopify_analytics etc and prints them in plain text.

Anchor to customerAccountUrlcustomerAccountUrl
•URL

URL to the customer accounts page.

Anchor to saleOfDataRegionssaleOfDataRegions
•[String!]!
non-null

List of ISO3166 2-character country codes where the sale of data is enabled.

Was this section helpful?