The following list contains the most frequently used expressions in Mobile Engage.

Contents

Application ID

The mobile application identifier used to identify the app. It is assigned to the application by our delivery partner upon its registration.

mobile-engage-application-id

Its format is ABCD1-234E6. This ID is the same for all supported application platforms (iOS, Android).

Application password

An Emarsys-generated token used to authenticate API requests. The Application Password is available on the App details page on the Apps tab.

Application version

The version number of the customer’s application. We store the version in the major/minor/patch format and these values are available for segmentation using the greater than option.

Emarsys contact field/custom field

A JSON object representing a pairing between Emarsys contact data fields and data provided by the mobile application.

Emarsys contact ID

A unique numeric identifier of a contact in the Emarsys databases.

Event

An event in Mobile Engage is a message, sent from the mobile application. It consists of information about the device, the application and a certain operation completed in the application.

Hardware ID

A unique string to identify the device. (IDFA/IDFV on iOS and ANDROID_ID on Android. We use IDFA as default, but when ad tracking is limited and IDFA is not available, we fall back on IDFV).

The hardware_id can be obtained using our delivery partner’s SDK.

For iOS, the getHWID task is used to get the unique device identifier that is used in API calls. For Android, the getPushwooshHWID method is called to get the same identifier.

The hardware IDs are stored in the Mobile Engage database, which means that they are not available in any contact fields of the Emarsys database. If the app_login API call contains the contact_field_id and contact_field_value keys, 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 feature.

Mobile Engage API route/endpoint

A unique URL, where you can point your HTTP clients to interact with Mobile Engage services.

Mobile Engage database

This stores Emarsys contacts’ application installs. 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

OS version

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.

Platform

The overall name of the device platform, currently iOS or Android. Please note that the values should be in lower case in the call.

Push provider

The name of the push services used to deliver messages to devices. Emarsys is not directly connected to Google or Apple, instead we are using the services of a third party to send the push messages. Our delivery partner should know the devices to be able to send the messages and, to this end, you have to provide the following device data to our partner:

  • hardware_id
  • push token
  • platform
  • language
  • timezone

We recommend integrating our delivery partner’s SDK beside the Mobile Engage API. (If you do not wish to integrate the delivery partner’s SDK, for the minimum-level service it is enough to call the registerDevice API at our delivery partner. Click here to read more about this.)

Push token

A unique token, often referred to as “device token”, generated by Google or Apple, linked to an application where push notifications have been accepted. Use getPushToken on both iOS and Android.

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 app_login API call contains the contact_field_id and contact_field_value keys, 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 feature.

Please note that push messages can only be sent if there is a valid push token for them.

Sid

A unique campaign number generated by Emarsys and automatically included in every message from the campaign, including the test messages. This parameter should be sent back to Emarsys in the message_open parameter, as this is used for message open statistics in Mobile Engage reporting. It can be obtained from our delivery partner’s SDK.

Merge by field

A set of rules, applied when an anonymous contact – an active user of an application – is replaced by an authenticated user. A field should be defined with the information used for identifying users. Our recommended best practice is to use a hashed version of the user_id in the customer’s own system. Please note that this process is not supported after October 19, 2016.