-
Notifications
You must be signed in to change notification settings - Fork 19
Glossary
- Application version
- Emarsys contact field/custom field
- Emarsys contact ID
- Event
- HardwareID
- Mobile Engage database
- OS version
- Platform
- Push provider
- Push token
- Sid
The following list contains the most frequently used expressions in Mobile Engage.
The version number of your app. We store the version in the major/minor/patch format and these values are available for segmentation using the greater than option.
A JSON object representing a pairing between Emarsys contact data fields and data provided by the mobile app.
A unique numeric identifier of a contact in the Emarsys database.
An event in Mobile Engage is a message, sent from the mobile app. It consists of information about the device, the app and a certain operation completed in the app.
We will be renaming the hardwareID parameter in our SDK to clientID. The hardwareID, to be renamed clientID, is an 8-character alphanumeric string generated when the SDK is first initialised.
It does not contain any personal information, it does not identify individuals and is used only to provide SDK functionalities and session management.
iOS:
- The hardwareID is stored in the Keychain as a local value and does not sync with iCloud.
- Different apps using our SDK generate a distinct hardwareID on the same device.
- Stays consistent between sessions unless the device is reset to factory settings, or the OS is reinstalled.
Android:
- A new hardwareID is generated each time the app is downloaded.
If the setContact call contains the contact_field_value key, Mobile Engage connects the Emarsys contacts to the devices. Also, if the clientId is known, the individual push tokens can be searched for at the Users menu item on the Apps tab of the Mobile Engage interface.
This stores the app installs of Emarsys contacts. It consists of the Emarsys contact_id, the application_id, the hardware_id and the push_token.
We also store device-level information in this database, such as:
- platform
- language
- timezone
- device_model
- application_version
- os_version
- notification_settings
The operating system version reported by the platform. We store the version in the major/minor/patch format and these values are available for segmentation using the greater than option.
The overall name of the device platform, currently iOS or Android. Please note that the values should be in lower case in the call.
The name of the push services provider used to deliver messages to devices. Previously, Emarsys used a third-party provider to deliver push messages, but now it is directly connected to Google or Apple.
A unique token, often referred to as “device token”, generated by Google or Apple, linked to an app where push notifications have been accepted.
The push tokens are stored in the Mobile Engage database, which means that they are not available in any contact fields of the Emarsys database. If the setContact call contains the contact_field_id and contact_field_value key, Mobile Engage connects the Emarsys contacts to the devices.
Also, if the hardware_id is known, the individual push tokens can be searched for at the Users menu item on the Apps tab of the Mobile Engage interface.
Please note that push messages can only be sent if there is a valid push token for them.
A unique campaign number generated by Emarsys and automatically included in every message from the campaign, including the test messages. This parameter is automatically extracted from the push message and sent to Mobile Engage once the user opens the message and our SDK is integrated.