Properties are key/value pairs you can use to describe a user.
Built-in properties
WonderPush SDKs automatically collects some properties from user devices.
Custom properties
You can attach your own properties to a user. Common examples of properties are:
- the age of the user,
- the user's full name,
- a customer's all-time revenue.
Properties can be tested in segment criteria, and they can also be used to Personalize push notifications (like calling the user by his/her name in a notification).
There are many ways to add custom properties:
- Client-side, using one of our SDKs
- Server-side, by calling the REST API
- In response to a user click on a notification
Property names
Property names are subject to the following rules:
- they are prefixed according to their value type. For example, string properties have names that start with
string_. See available prefixes below. - they must only contains letters, numbers and the underscore
_character.
Available prefixes are:
byte_
An integer value between -128 and 127, inclusive.
short_
An integer value between -32,768 and 32,767, inclusive
int_
An integer value between -231 and 231-1, inclusive.
long_
An integer value between -263 and 263-1, inclusive.
float_
An single precision floating point number.
double_
An double precision floating point number.
bool_
A boolean value, either true of false.
string_
A string value. Values above 128 characters will be ignored.
date_
A UTC timestamp in milliseconds, a Date object, or a string in the following format: YYYY[-MM[-DD]][T[HH[:MM[:SS[.SSS]]]][Z|+HH[:MM[:SS[.SSS]]]]]
Here are valid examples: 2019, 2019-12, 2019-12-31, 2019-12-31T23, 2019-12-31T23:59, 2019-12-31T23:59:59, 2019-12-31T23:59:59.999.
Here are valid offsets you can also append: Z for UTC, -06, +02:00. In the absence of an offset, the date is taken as UTC. Don’t forget to write T before the offset if you gave no time-part.
Unless explicitly mentioned, any missing part is taken as January 1st for date-part and midnight for the time-part.
geoloc_
A geographic localisation given as latitude and longitude, or geohash.
Value as an object: {"lat": 48.85837, "lon": 2.294481}.
Value as a string: "48.85837,2.294481", latitude first, longitude next.
Value as an array: [2.294481, 48.85837], longitude first, latitude next. Note the reversed order, conforming to GeoJSON.
Value as a geohash: "u09tunqu9k31". See the Geohash article on Wikipedia.
Setting properties on the client side
All our SDKs allow you to set properties. The method/function is called putProperties. Here's a simple example where we set the user's name and age:
JSONObject properties = new JSONObject();
properties.put("string_name", "John Doe");
properties.put("int_age", 32);
WonderPush.putProperties(properties);
WonderPush.putProperties([
"string_name": "John Doe",
"int_age": 32
]);
[WonderPush putProperties:@{
@"string_name": @"John Doe",
@"int_age": @32
}];WonderPush.push(function () {
WonderPush.putProperties({
"string_name": "John Doe",
"int_age": 32
});
});cordova.plugins.WonderPush.putProperties({
"string_name": "John Doe",
"int_age": 32
});Setting properties on the server side
This is easily achieved using the PATCH /installation/{installationId} call of our REST API.
In the following example we set the user's full name and age. Adapt YOUR_ACCESS_TOKEN and YOUR_INSTALLATION_ID.
curl --request PATCH \
--url 'https://management-api.wonderpush.com/v1/applications/_/installations/YOUR_INSTALLATION_ID?accessToken=YOUR_ACCESS_TOKEN' \
--header 'content-type: application/json' \
--data '{"body":{"custom":{ \
"string_name":"John Doe", \
"int_age":32}}}'Setting properties in response to a user click on a notification
Just head over to the Compose tab of the Create/edit notification page and choose Add action and Update installation for the notification itself or for any button.
What's Next
| Geo-targeting |