Tags

Tags are a data construct used in several entities in the Air platform. These data points are not pre-configured and can be added by a retailer at any time to their data.

The below data objects are examples of where tags can be added:

• Campaigns
• Programmes
• Schemes
• Units (Outlets, Companies, suppliers etc)
• Product Ingestions

Tags are intended to be used for arbitary and ad-hoc grouping of objects using a common identifier. For example, a client may wish to tag all their campaigns that are used for initial offers given to customers when the sign-up to the loyalty scheme.

For data objects created in Air via ingestions or via API, both the products and the store ingestions support tags in the input files. The Campaigns API supports adding tags to campaign directly in the API.

Tag Formats

Tags are arbitrary fields and are entered manually upon creating/editing the relevant data object. The characters entered to create the tag can be from the below groupings of characters:

• Letters (upper and lower case)
• Numbers
• : (Colon)
• _ and - (underscore and hyphens)

Although other characters can be used it is advised to avoid using them as it can make later querying of the data more difficult to achieve. For example to query a tag with an & character in it, you would need to url encode the character to & so be able to use it.

Character length on tags is restricted to 255 characters.

Tag Quantity

Although tags are free form entry and there is no hard limitation on the number of tags, the advice is to keep the number of tags on items to ~10. Although this can be pushed higher there is an increased risk of adverse performance implications of doing so.

Campaign Tags

Campaign Incompatibility

Campaign tags can be used to restrict certain campaigns from running together. For example, if a campaign is tagged as "Flyer", it can be set to be incompatible with any campaign tagged as "Loyalty". This is particularly useful for clients who wish to ensure that high-value promotions do not clash with other offers.

Retailers can tag any campaigns they want to be involved in these incompatibility rules. However, there’s no automatic reversal of tags, meaning each incompatible rule must be explicitly set for both campaigns involved.

General Tagging Rules

Flexibility

Tags are not pre-configured and can be freely created by retailers. They allow for ad-hoc grouping of various objects (like campaigns, products, and outlets) using identifiers that make it easier to manage and categorize items.

Additional Campaign Management Functions

Tags can also be used in the ordering rules that determine the order in which campaigns are processed during a transaction. Different tags can dictate priority, affecting which discounts or offers a customer can receive.