Manage Tag Groups

Tags are metadata that you can associate with channels or named users to help you organize and target your audience. Tag groups categorize your tags.

Learn more in Tags: Tag Groups. See Targeting Your Audience and the API tutorial Create and push to a tag group to learn more about using tag groups.

Create a Tag Group

 Warning

You cannot delete tag groups, nor can you edit the Group Key field or Allow these tags to be set only from your server security setting. Check that your Group Key and security setting are correct before saving your tag group.

 Note

Airship reserves tag groups prefixed with "ua_". Any tag groups you might create with that prefix will not function.

You can create up to 100 custom tag groups.

  1. Go to Settings » APIs & Integrations » Tag Groups.

  2. Click Create Tag Group and enter:

    • Name: A friendly name for the tag group that will help you recognize the tag group in other places. Pick something easily understandable that describes the associated database, e.g., “Loyalty Database Tags.”
    • Description: Additional information about the tag group, describing the source and purpose for the tag group, if necessary.
    • Group Key: The unique ID for the tag group, and how you will reference the tag group in API calls. It is strongly recommended that you exclusively use lowercase ASCII characters. Spaces are not allowed in a group key. Example: pos-database.
  3. (Optional) Enable Allow these tags to be set only from your server. This increases security by requiring tag read-write operations to be authenticated with your master secret key.

     Note

    If you do not enable this setting, tags can be read and written from an app using only the application secret, potentially allowing attackers to use your app secret to read or set their own tags. Whether or not your app will benefit from added security depends on the use case. If preventing attackers from reading or setting their own device tags is absolutely critical, enable this setting.

  4. Click Save.

Enable or Disable a Tag Group

  1. Go to Settings » APIs & Integrations » Tag Groups. Disabled tag groups are greyed-out.
  2. Click the pane of a custom tag group, and check or uncheck the box for Enable this Tag Group.
  3. Click Save.

Edit a Tag Group

  1. Go to Settings » APIs & Integrations » Tag Groups. Disabled tag groups are greyed-out.
  2. Click the pane of a custom tag group and make your changes. Only Name and Description are editable fields.
  3. Click Save.