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﻿
This property enables or disables all action events. 
Values:
true => enable all action events 
false => disable all action events
﻿viewsEnabledByDefault﻿
This property enables or disables all view events. 
Values:
true => enable all view events 
false => disable all view events

﻿purchasesEnabledByDefault﻿
This property enables or disables all purchase events. 
Values:
true => enable all purchase events 
false => disable all purchase events
﻿attributesEnabledByDefault﻿
This property enables or disables all attributes. 
Values:
true => enable all purchase events 
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﻿
This property enables or disables this event or attribute.
Values:
true => enable this event or attribute
false => disable this event or attribute
or omitted since this property is optional.
When omitted the app uses the fallback to
"eventsEnabledByDefault"
"viewsEnabledByDefault"
"purchasesEnabledByDefault"
"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"
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" to true.
The event "ISSUE_DOWNLOADED" is configured, but the "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" 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” property.
The "enabled" property has been omitted.
The tracking management therefore searches for the “eventsEnabledByDefault” property.
The property is available and the value is true.
=> The event is sent to Airship.
(2) USE-CASE "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" to true.
The event "STOREFRONT_ISSUE_BOOKMARK_ADDED" is configured and the "enabled" property is set to 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" 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” property.
The property is available and the value is false.
=> The event is not sent to Airship.
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"
        }
      }
    }
  }
}
{
  "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"
        }
      }
    }
  }
}
﻿
﻿
Property	Description
eventsEnabledByDefault	This property enables or disables all action events. Values: true => enable all action events false => disable all action events
viewsEnabledByDefault	This property enables or disables all view events. Values: true => enable all view events false => disable all view events
purchasesEnabledByDefault	This property enables or disables all purchase events. Values: true => enable all purchase events false => disable all purchase events
attributesEnabledByDefault	This property enables or disables all attributes. Values: true => enable all purchase events false => disable all purchase events
Property	Description
enabled	This property enables or disables this event or attribute. Values: true => enable this event or attribute false => disable this event or attribute or omitted since this property is optional. When omitted the app uses the fallback to "eventsEnabledByDefault" "viewsEnabledByDefault" "purchasesEnabledByDefault" "attributesEnabledByDefault"
Updated 20 Oct 2023
Did this page help you?
Configuration: Enrich event data
Full example: How to configure your events
Configuration: Enable or disable events or attributes

Summary

Enable or disable events or attributes

Complete parts

Individual events or attributes

Example

How is an event evaluated to being tracked or not?

tracking_config.json
