Available Context keys
As mentioned here, you can add a list of context keys to a given endpoint. Bellow you can find the list of available endpoints that come out of the box from the Zapp SDK.
info
Please note that a Quick Brick plugin can add extra context keys that can be added to an endpoint. To find out if a given plugin declared a new endpoint, please refer to the plugin API or manifest
Context Key | Description | Example |
---|---|---|
bundleIdentifier | The unique App identifier of an app as used in the store(aka as Package Name for Android) | com.yourapp |
advertisingIdentifier | The unique identifier of a specific device. Note that on Apple devices (iOS/tvOS) this might not be available based on user's permission to grant data collection. | 2b292db3-2f84-4a2c-aa08-0641730e5d06 |
uuid | Unique installation identifier of a specific device. Note that this value is not persistent across app reinstalls. | 2b292db3-2f84-4a2c-aa08-0641730e5d06 |
osVersion | The device OS version | 15.0 |
deviceModel | The device model | iPhone X |
deviceMake | The device make | iPhone |
deviceName | The device name | John's iPhone |
deviceType | The device type (mobile , tablet , tv , web , other ) | mobile |
userAgent | User agent (Note that user-agent value for tvOS is different from other platforms, as it is provided by the operating system itself, due to the absence of a built-in web browser on tvOS devices.) | Mozilla/5.0 (iPhone; CPU iPhone OS 150 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148 Example for tvOS: AppName/1 CFNetwork/758.1.2 Darwin/15.0.0 |
deviceWidth | The device screen width in pixels | 360 |
deviceHeight | The device screen height in pixels | 640 |
timeZoneOffset | The UTC offset of the device. the format corresponds to the Z offset | UTC+01:00 |
platform | The device platform SDK - ios , android , amazon_fire_tv , android_tv , tvos , roku , samsung_tv , lg_tv . | android |
sdk_version | The SDK version of the app | 1.0.0 |
version_name | The version number of the running app | 1.0.0 |
layoutId | The current layout id of the device | 497fe2c4-b773-4cac-896c-4a33da70b931 |
isDebug | If the current version running on the app is a debug version | true |
languageCode | ISO 639-1 representation of language code used by device | en |
languageLocale | Locale used by device | en_GB |
store | Default app store used by a device | google_play |
isDebug | If the current version running on the app is a debug version | true |
signedDeviceInfoToken | A signed JWT that holds user info (The country code) where the end user is located) | - |
browser | Only For Web - get the user's browser. This is used typically used if you need to set a different stream for Safari and iOS browsers (Note that all iOS broweser are considered safari ). | safari |