Airship

summary official websites site url website https //www airship com https //www airship com documentation https //docs airship com https //docs airship com/ developer integrations platform url android https //github com/urbanairship/android library https //github com/urbanairship/android library ios https //github com/urbanairship/ios library https //github com/urbanairship/ios library web \<font color="#ff6900">not supported by purple\</font> tracking service event support matrix overview of the supported events and their configuration templates parameter \<font color="#2166ae">actions\</font> \<font color="#9900ef"> \</font> \<font color="#3b9f0f">action\</font> \<font color="#3b9f0f">supported\</font> \<font color="#2166ae">views\</font> \<font color="#9900ef"> \</font> \<font color="#3b9f0f">name\</font> \<font color="#ff6900">not supported\</font> \<font color="#2166ae">purchases\</font> \<font color="#3b9f0f">action\</font> \<font color="#3b9f0f">supported\</font> \<font color="#2166ae">attributes\</font> \<font color="#3b9f0f">name\</font> \<font color="#ff6900">not supported\</font> \<font color="#9900ef">( )\</font> \<font color="#2166ae">actions\</font> and \<font color="#2166ae">views\</font> contains special handling regarding view tracking more detailed information can be found below in the description of the event configuration for actions and views general structure in tracking config json tracking service key name in " tracking config json " is " \<font color="#2166ae">airship\</font> " general structure { "airship" { "eventsenabledbydefault" true, "viewsenabledbydefault" true, "purchasesenabledbydefault" true, "attributesenabledbydefault" true, "events" { // your configured list of events }, "views" { // your configured list of events }, "purchases" { // your configured list of events }, "attributes" { // your configured list of attributes } } } event configuration actions airship supports action events action event "action event key" { "templates" { "action" "value of template" }, "parameters" { "parameter key 1" "value of parameter", // your configured list of parameters } } example "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}}" } } airships special behavior for view tracking on each action event the last memorized view name is put as an additional property as follows property key property value \<font color="#3b9f0f">view\</font> the last memorized view name if no view event was tracked yet, this additional property is omitted views airship supports view events view event "view event key" { "templates" { "name" "value of template" } } example "storefront feed" { "templates" { "name" "feed" } } airships special behavior for view tracking view tracking needs to be supported in a special way compared to other tracking systems this special behavior consists of three points (1) each view event needs to be tracked as regular view event (2) together with the view event an aditional custom event must be sent this custom event has the following structure custom event \<font color="#3b9f0f">"view entered"\</font> the value can not be changed by any configuration the view itself is tracked as a property property key property value \<font color="#3b9f0f">view\</font> name of the current view, the same name as the regular view event (3) memorize the last tracked view purchases airship supports purchase events purchase event "purchase event key" { "templates" { "name" "value of template" }, "parameters" { "parameter key 1" "value of parameter", // your configured list of parameters } } example "storefront issue purchased" { "templates" { "action" "issue purchased" }, "parameters" { "transaction id" "{{transaction id}}", "issue product id" "{{product id}}", "issue price" "{{price}}", "issue price currency" "{{currency code}}", "issue id" "{{issue id}}", "issue name" "{{issue name}}", "issue type" "{{issue type}}", "issue categories" "{{issue categories}}", "issue tags" "{{issue tags}}", "issue price formatted" "{{issue price}}", "issue latest" "{{issue latest}}", "publication id" "{{publication id}}", "publication name" "{{publication name}}", "publication type" "{{publication type}}" } } attributes airship supports attributes attribute "attribute key" { "templates" { "name" "value of template" }, // for boolean attributes a "tag group" is needed "parameters" { "tag group" "name of tag group" } } example "has active subscription" { "templates" { "name" "has active subscription" }, "parameters" { "tag group" "subscriptions" } } boolean value attributes attributes with boolean values are mapped to tags on the contact in airship the tracking config needs to have a parameter " \<font color="#2166ae">tag group\</font> " setting the value to \<font color="#3b9f0f">false\</font> causes the tag to be removed other value attributes other value types (string, number, etc ) are mapped to attributes on the contact additional supported functionality audience management (contact) https //docs airship com/platform/mobile/audience/#contacts https //docs airship com/platform/mobile/audience/#contacts a contact is initialized during app start purple's generated device id is used for that in app automation https //docs airship com/platform/mobile/in app/getting started https //docs airship com/platform/mobile/in app/getting started/ this feature is enabled as provided by airship message center https //docs airship com/platform/mobile/message center/message center https //docs airship com/platform/mobile/message center/message center/ airship can display in app messages purple implements this feature by using the default message center ui provided by airship to enhance this feature two action urls are provided by purple action url description \<font color="#2166ae">purple //app/airship/messages/all\</font> open the message center \<font color="#2166ae">purple //app/airship/messages/\</font> \<font color="#3b9f0f">\&lt;id\&gt;\</font> open a specific message \<font color="#3b9f0f">id \</font> the message id value these action urls are filtered from the app menu when airship is not enabled push https //docs airship com/platform/mobile/push/getting started https //docs airship com/platform/mobile/push/getting started/ this feature is enabled as provided by airship how to configure native purple app any native tracking service is configured in the \<font color="#2166ae">purple manager \</font> enable sdk settings location " \<font color="#2166ae">your app\</font> " => " \<font color="#2166ae">consent/push/analytics\</font> " => " \<font color="#2166ae">analytics (general/ios/android/web)\</font> " setting description enable airship to enable the airship sdk in your app, activate this checkbox app key the app key provided by airship app secret the app secret provided by airship site the site location selectable values are \<font color="#3b9f0f">us\</font> \<font color="#3b9f0f">eu\</font> apple privacy / att settings location " \<font color="#2166ae">your app\</font> " => " \<font color="#2166ae">consent/push/analytics\</font> " => " \<font color="#2166ae">privacy\</font> " consent management settings location " \<font color="#2166ae">your app\</font> " => " \<font color="#2166ae">consent/push/analytics\</font> " => " \<font color="#2166ae">consent management\</font> " setting description vendor id for airship the vendor id is provided by the consent management platform web integration purple does not support airship web integration