Contextual Tags¶
This document lists and describes pre-defined Contextual tags. Contextual tags can occur at the SDK or in the Contextual cloud. Typically tags that are prepended with "sh_" or "ctx_" are required to be used in the way specified here. Some "sh_" or "ctx" tags are automatically set by the SDK (application version, SDK version, preferred language used on the device etc), others such as "sh_first_name" can be set by your developers using the SDK's tagging methods.
Code snippets demonstrating tagging an install from the Contextual SDK's can be found in the tagging documentation of the development platform for your application. Please note that the tags highlighted in Bold parameters are recommended for making full use of the features provided by Contextual.
| Contextual Tag | Description | Example | |
|---|---|---|---|
| 1 | sh_cuid | Use sh_cuid to tag an install with a unique identifier. The sh_cuid tag is used to link users in your backend to our backend, it allows tagging via api call and it can be used to identify the same user across multiple installs. More info | tagUserId("sh_cuid",md5("john.smith@example.com")); |
| 2 | sh_email | For tagging user's email address. sh_email tag is mandatory to filter experiments based on email | tagString("sh_email","john.smith@example.com"); |
| 3 | sh_first_name | For tagging user's first name so as to send personalised messages with user's first name | tagString("sh_first_name","Alex"); |
| 4 | sh_last_name | For tagging user's last name so as to send personalised messages with user's last name | tagString("sh_last_name","Smith"); |
| 5 | sh_gender | For tagging user's gender. sh_gender is mandatory to filter experiments based on gender. | tagString("sh_gender","female"); |
| 6 | sh_date_of_birth | For tagging user's birth date. sh_date_of_birth is mandatory to target campaigns based on users birthdate. The string should be in ISO 8601 format. | tagString("sh_date_of_birth","2007-12-03T00:00:00+01:00"); |
| 7 | sh_country | The country tag is by default either identified by the SDK or guessed from the ip address if the value is not set. The value can be overridden using the tagging api. | |
| 8 | sh_language | The language tag is by device's default language identified by the SDK. Ensure it conforms with ISO 639-1(example: en-US). The value can be overridden using the tagging api. |