ConverlayConverlay

Gerenciamento de Consentimento

O SDK fornece um método setConsent() para atualizar o estado de consentimento a qualquer momento. Os sinais de consentimento são mapeados para o formato Google Consent Mode v2 e incluídos em cada payload de evento.

API setConsent()

setConsent()
// Grant both analytics and marketing
converlay.setConsent({ analytics: true, marketing: true })

// Deny marketing (e.g., user declines cookie banner)
converlay.setConsent({ analytics: true, marketing: false })

// Update a single signal without affecting the other
converlay.setConsent({ marketing: false })

Campos de ConsentInput

CampoTipoPadrãoDescrição
analyticsbooleantruePermitir rastreamento analítico
marketingbooleantruePermitir rastreamento de marketing/anúncios

Mapeamento GCM v2

O SDK mapeia sua entrada de consentimento para sinais do Google Consent Mode v2:

ConsentInputSinal GCM v2
analyticsanalytics_storage
marketingad_storage
marketingad_user_data
marketingad_personalization

Consentimento padrão (negar por padrão)

Por padrão, tanto analytics quanto marketing são true. Para regiões em conformidade com o GDPR, inicialize com consentimento negado:

Deny by default
const converlay = createConverlay({
  shopDomain: 'my-store.myshopify.com',
  consent: {
    analytics: false,
    marketing: false,
  },
})

Os eventos continuam sendo disparados

O SDK envia eventos independentemente do estado de consentimento. Os sinais de consentimento são incluídos no payload, e o servidor do Converlay os utiliza para decidir quais destinos recebem cada evento. Isso garante que os eventos possam ser armazenados em buffer e encaminhados assim que o consentimento for concedido.

Shopify Customer Privacy API

Se o seu storefront headless usa a Customer Privacy API da Shopify, você pode sincronizar as alterações de consentimento diretamente:

Shopify integration
// Listen for Shopify Customer Privacy API consent changes
if (window.Shopify?.customerPrivacy) {
  window.Shopify.customerPrivacy.subscribe(
    'visitorConsentCollected',
    (event) => {
      converlay.setConsent({
        analytics: event.analyticsAllowed,
        marketing: event.marketingAllowed,
      })
    }
  )
}

Gerenciadores de consentimento de terceiros

Para gerenciadores de consentimento como OneTrust, Cookiebot ou similares:

OneTrust example
// OneTrust example
window.OptanonWrapper = () => {
  const groups = window.OnetrustActiveGroups || ''
  converlay.setConsent({
    analytics: groups.includes('C0002'),
    marketing: groups.includes('C0004'),
  })
}