settings

Provides access to the settings JSON object as set by the GraphQL Admin API (Web pixel app extensions only). The structure of this object is a string keyed hash map: Record<string, any>.

Examples

App Pixel

// ONLY AVAILABLE IN APP PIXELS

import {register} from '@shopify/web-pixels-extension';

analytics.subscribe('page_viewed', (event) => {

console.log(settings);

/**

* {

* "accountID": 234

* }

});

Examples

App Pixel

// ONLY AVAILABLE IN APP PIXELS

import {register} from '@shopify/web-pixels-extension';

register(({analytics, settings}) => {
  analytics.subscribe('page_viewed', (event) => {
    console.log(settings);
    /**
     * {
     *   "accountID": 234
     * }
     */
  });
});

Was this page helpful?