Device property tags

This page describes the device propertiesInformation about a channel, such as language and time zone settings, OS and browser versions, and notification opt-in status. Values come from the user’s device when an SDK is present, or are set via the API for channels without one. Each property is automatically made available as an attribute, a tag, or both for audience segmentation. available as tagsMetadata that you can associate with a channel or named user for audience segmentation. Generally, a tag is a descriptive term indicating a user preference or other categorization, such as wine_enthusiast or weather_alerts_los_angeles. Tags are case-sensitive..

Tags by device property

In the table, the name is the tag group’s name in the Airship dashboard, the tag group ID is its identifier in the API, valid tags are the values allowed for the group, and channels are the supported channel types for the tag. If Airship can’t determine a real tag value for a device, the sentinel value applies instead. See Unknown values.

The following table lists the tags available for each device property:

1. The Application Version tag group accepts any sanitized string. A push only reaches devices whose tag matches a real app version.

2. When pushing to these tags via the API, you use a string that represents a boolean value, not an actual boolean. In other words, the valid tags are "true" and "false" rather than true and false.

{ "group": "ua_background_enabled", "tag": "true" }

Unknown values

When Airship can’t determine a real value for a device, the system applies the sentinel value of Unknown for a tag in both the dashboard and API. For example, if Airship is unable to determine a device’s language settings, the ua_locale_language tag group gets the Unknown tag. To target those devices, push to the Unknown tag directly:

{ "group": "ua_locale_language", "tag": "Unknown" }

The Time Zone tag group’s sentinel is Unknown in the UI and NO_TIME_ZONE in the API.

Tags with "true" or "false" values only do not have sentinel values: Background Enabled, Location Enabled, Notification Opt-in, and RCS Enabled. The Email Domain tag is omitted from a channel when not applicable, so it does not have a sentinel either.

Browser Version

The ua_browser_version tag combines one of the Browser Name tag values and a version number in the format <browsername>-<version>, such as chrome-56 or firefox-69. Airship accepts any string in this format, but a push only reaches devices whose tag matches a real browser version.

Device Model

The ua_ios_model tag is for iOS only and uses Apple’s device identifier rather than the marketing name. For example, the tag value iPhone13,3 is iPhone 12 Pro.

For Android, use the Device Model attribute ua_device_model. See Default attributes in the Attributes Reference.

Device OS Version

The ua_os_version tag stores the OS version in one of these formats:

• Major version: 1, 123
• Full version: 1.2.3
• Major.minor with wildcard patch: 1.2.X — matches any patch of that minor version

Email Domain

The ua_email_domain tag is the portion of the email address after the @ symbol, such as airship.com. Use this tag to exclude problem domains from bulk sends for reputation management, or to target users by email provider.

The tag isn’t set when a user is opted in by default, such as for transactional messages.

Locale

The ua_locale_language and ua_locale_country tag values reflect the language and region settings on the device. Language tags use ISO 639-1  codes, and country tags use ISO 3166-1 alpha-2  codes. For example, a device set to English and United States has the language tag en and country tag US.

These tags reflect device settings, not the user, so use locale as an approximation only. For example, an English-only speaker in the US who has their phone language set to Arabic and region set to China gets the Arabic and China tags, which is not a reliable signal of who the user is or where they are.

NDC

The ua_ndc tag stores the national destination code, commonly known in the US as the area code, derived from an SMS channel’s MSISDNThe mobile phone number, including country code, of a device in your Airship audience. Each MSISDN represents an individual mobile device.. The value is a 2- or 3-digit numeric string, such as 503. The tag is country-specific and is only set when the MSISDN has a discernible code.

RCS Enabled

The ua_rcs_enabled tag is true when an SMS channel can receive RCS messages. See RCS branded senders.

SDK Version

The ua_sdk_version tag stores the version of the Airship SDK in one of these formats:

• Major version: 1, 123
• Full version: 1.2.3
• Major.minor with wildcard patch: 1.2.X — matches any patch of that minor version

Subdivision

The ua_subdivision tag stores the ISO 3166-2  subdivision code derived from the SMS channel’s MSISDNThe mobile phone number, including country code, of a device in your Airship audience. Each MSISDN represents an individual mobile device., such as US-OR for Oregon, United States. ISO 3166-2 codes consist of a country code and a subdivision code separated by a hyphen.

Time Zone

The timezone tag uses IANA  time zone identifiers, such as America/Los_Angeles. Airship maps unsupported time zones to the nearest supported tag.