Skip to main content

Develop Shopify App with Customer Privacy API Integration

Ticket: Shopify App

Title: Develop Shopify App with Customer Privacy API Integration

Description:

Overview

Create a Shopify App for Cookient that integrates with Shopify's Customer Privacy API, enabling Shopify merchants to easily install and manage cookie consent directly from their Shopify admin.

Background

As of 2025, Google requires all CMP Partner Program participants (Bronze, Silver, and Gold tiers) to provide Shopify Apps that integrate with Shopify's Customer Privacy API. This is a mandatory requirement for certification.

Requirements

Customer Privacy API Integration

  • Full integration with Shopify Customer Privacy API (https://shopify.dev/docs/api/customer-privacy)

  • Implement window.Shopify.customerPrivacy methods:

    • setTrackingConsent()

    • getTrackingConsent()

    • shouldShowGDPRBanner()

    • shouldShowCCPABanner()

  • Properly sync consent state between Cookient and Shopify's native privacy system

  • Support for Shopify's consent tracking preferences

App Features

  • Easy installation from Shopify App Store

  • Embedded app interface in Shopify admin:

    • Account connection / API key setup

    • Banner customization (colors, position, text)

    • Consent categories configuration

    • Region-specific settings (EU/GDPR, US/CCPA, etc.)

    • Google Consent Mode v2 settings

  • Automatic script injection via Shopify ScriptTag API or App Embed blocks

  • Live preview of banner in admin

Theme Compatibility

  • Works with Online Store 2.0 themes (App Embed blocks)

  • Backwards compatible with vintage themes (ScriptTag API)

  • No theme code editing required from merchant

  • Compatible with Shopify's native cookie banner (override or complement)

Consent Categories Mapping

  • Map Cookient categories to Shopify privacy preferences:

    • analytics → analytics

    • marketing → marketing

    • preferences → preferences

    • sale_of_data (CCPA specific)

Regional Compliance

  • GDPR support (EU visitors)

  • CCPA/CPRA support (California visitors)

  • Geo-targeting based on visitor location

  • Respect Shopify's market-specific privacy settings

Performance

  • Minimal impact on storefront speed

  • Async loading

  • Pass Shopify's Lighthouse performance requirements

  • CDN delivery of consent script

Documentation

  • Installation guide with screenshots

  • Configuration walkthrough

  • Integration with Shopify Analytics and Google channel

  • Troubleshooting guide

Acceptance Criteria

  • App approved and published on Shopify App Store

  • Customer Privacy API fully integrated

  • Works with Online Store 2.0 and vintage themes

  • Embedded admin interface complete

  • Geo-targeting functional for GDPR/CCPA regions

  • Tested with top 10 most popular Shopify themes

  • Documentation complete

  • Passes Shopify App Store review requirements

Technical Notes

  • Use Shopify App Bridge for embedded admin experience

  • Implement OAuth for secure merchant authentication

  • Follow Shopify's App Design Guidelines

  • Use Polaris components for admin UI

  • Consider using Remix template (Shopify's recommended stack)

Log in to comment and vote

No comments yet

Be the first to share your thoughts.