3rd party integrations
...
Purple Tracking
Tracking Configuration

Configuration: Enable or disable events or attributes

7min
summary this article shows you how to enable or disable individual events or attributes, all events of the same type or all attributes in the following figure, we first show a rough overview of the related properties and their relationships before we dive into the topic as you can see there are properties to enable or disable all events from the same type and one for all attributes in addition to that every single event or attribute can be enabled or disabled by overriding the global configuration enable or disable events or attributes complete parts the following properties are a global configuration for events or attributes of a tracking service property description eventsenabledbydefault eventsenabledbydefault this property enables or disables all action events values true true => enable all action events false false => disable all action events viewsenabledbydefault viewsenabledbydefault this property enables or disables all view events values true true => enable all view events false false => disable all view events purchasesenabledbydefault purchasesenabledbydefault this property enables or disables all purchase events values true true => enable all purchase events false false => disable all purchase events attributesenabledbydefault attributesenabledbydefault this property enables or disables all attributes values true true => enable all purchase events false false => disable all purchase events individual events or attributes using the following property you may enable or disable this event or attribute property description enabled enabled this property enables or disables this event or attribute values true true => enable this event or attribute false false => disable this event or attribute or omitted since this property is optional when omitted the app uses the fallback to " eventsenabledbydefault eventsenabledbydefault " " viewsenabledbydefault viewsenabledbydefault " " purchasesenabledbydefault purchasesenabledbydefault " " attributesenabledbydefault attributesenabledbydefault " example how is an event evaluated to being tracked or not? two use cases are described below, whether the triggered events are sent to the tracking service or not these use cases show the initial situation as well as the individual steps used for the evaluation in detail (1) use case " issue downloaded issue downloaded " the first use case is simple and the configuration is as follows airship is added and configured in the app as a tracking service events for airship are configured that all events are sent by setting " eventsenabledbydefault eventsenabledbydefault " to true true the event " issue downloaded issue downloaded " is configured, but the " enabled enabled " property is omitted order of evaluation the app user taps on the download button of an issue so that the download starts after the download completes, the app fires the " issue downloaded issue downloaded " event the app's internal tracking management searches for this event configuration the event configuration is available and the next step is to check for the “ enabled enabled ” property the " enabled enabled " property has been omitted the tracking management therefore searches for the “ eventsenabledbydefault eventsenabledbydefault ” property the property is available and the value is true true \=> the event is sent to airship (2) use case " storefront issue bookmark added storefront issue bookmark added " the second use case is simple and the configuration is as follows airship is added and configured in the app as a tracking service events for airship are configured that all events are sent by setting " eventsenabledbydefault eventsenabledbydefault " to true true the event " storefront issue bookmark added storefront issue bookmark added " is configured and the " enabled enabled " property is set to false false order of evaluation the app user taps on the bookmark button of an issue so that one bookmark gets created after the bookmark has been added, the app fires the " storefront issue bookmark added storefront issue bookmark added " event the app's internal tracking management searches for this event configuration the event configuration is available and the next step is to check for the “ enabled enabled ” property the property is available and the value is false false \=> the event is not sent to airship tracking config json example code { "default" { "eventsenabledbydefault" true, "viewsenabledbydefault" true, "purchasesenabledbydefault" false, "attributesenabledbydefault" false, "events" {}, "views" {}, "purchases" {}, "attributes" {} }, "airship" { "eventsenabledbydefault" true, "viewsenabledbydefault" true, "purchasesenabledbydefault" true, "attributesenabledbydefault" true, "events" { "storefront issue bookmark added" { "enabled" "false" // temporary disable that event to test an issue in your live app "templates" { "action" "issue bookmark added" }, "parameters" { "view" "{{view}}", "bookmark title" "{{bookmark title}}", "bookmark description" "{{bookmark description}}", "bookmark page label" "{{bookmark page label}}", "bookmark creation date" "{{bookmark creation date}}", "issue id" "{{issue id}}", "issue name" "{{issue name}}", "issue categories" "{{issue categories}}", "issue tags" "{{issue tags}}", "issue purchasable" "{{issue purchasable}}", "issue purchased" "{{issue purchased}}", "issue product id" "{{issue product id}}", "publication id" "{{publication id}}", "publication name" "{{publication name}}" } }, "issue downloaded" { "templates" { "action" "issue downloaded" }, "parameters" { "issue id" "{{issue id}}", "issue name" "{{issue name}}", "issue categories" "{{issue categories}}", "issue tags" "{{issue tags}}", "issue purchasable" "{{issue purchasable}}", "issue purchased" "{{issue purchased}}", "publication id" "{{publication id}}", "publication name" "{{publication name}}" } }, "storefront search performed" { "templates" { "action" "search performed" }, "parameters" { "view" "{{view}}", "phrase" "{{phrase}}" } } }, "views" { "app menu" { "templates" { "name" "app menu" } } }, "purchases" { "storefront subscription purchased" { "templates" { "action" "subscription purchased" }, "parameters" { "transaction id" "{{transaction id}}", "subscription product id" "{{product id}}", "subscription price" "{{price}}", "subscription price currency" "{{currency code}}", "subscription id" "{{subscription id}}", "subscription name" "{{subscription name}}", "subscription type" "{{subscription type}}", "subscription duration" "{{subscription duration}}", "subscription price formatted" "{{subscription price}}", "subscription purchased" "{{subscription purchased}}" } } }, "attributes" { "has active subscription" { "templates" { "name" "has active subscription" }, "parameters" { "tag group" "subscriptions" } } } }, "firebase analytics" { "eventsenabledbydefault" true, "viewsenabledbydefault" false, "purchasesenabledbydefault" false, "attributesenabledbydefault" true, "events" { "storefront issue bookmark added" { "templates" { "action" "issue bookmark added" }, "parameters" { "view" "{{view}}", "bookmark title" "{{bookmark title}}", "bookmark description" "{{bookmark description}}", "bookmark page label" "{{bookmark page label}}", "bookmark creation date" "{{bookmark creation date}}", "issue id" "{{issue id}}", "issue name" "{{issue name}}", "issue categories" "{{issue categories}}", "issue tags" "{{issue tags}}", "issue purchasable" "{{issue purchasable}}", "issue purchased" "{{issue purchased}}", "issue product id" "{{issue product id}}", "publication id" "{{publication id}}", "publication name" "{{publication name}}" } }, "issue downloaded" { "templates" { "action" "issue downloaded" }, "parameters" { "issue id" "{{issue id}}", "issue name" "{{issue name}}", "issue categories" "{{issue categories}}", "issue tags" "{{issue tags}}", "issue purchasable" "{{issue purchasable}}", "issue purchased" "{{issue purchased}}", "publication id" "{{publication id}}", "publication name" "{{publication name}}" } }, "storefront search performed" { "templates" { "action" "search performed" }, "parameters" { "view" "{{view}}", "phrase" "{{phrase}}" } } }, "views" { "app menu" { "templates" { "name" "app menu" } } }, "purchases" {}, "attributes" { "has active subscription" { "templates" { "name" "has active subscription" } } } } }