Guides

User Properties

Suggest Edits

You can use user properties to capture attributes such as demographic information or interests.

The demographic information may contain age, gender, etc. Interests are usually derived attributes. If you already have this data against your users, you can onboard it on iZooto using user properties.

Capturing User Properties

User properties follow a key-value format, where key denotes the name of the user property and value refers to the value for an individual subscriber.

<script>
   window._izq.push(["userProfile",{"add":{
                "Gender":"Male" //Key - Value can be customized as per your requirements
            }
        }]);
</script>

HashMap<String, Object> data = new HashMap<>();

data.put("Gender","Male");
// Key: Value can be customized as per your requirement.

iZooto.addUserProperty(data);

let data = ["Gender": "Male"] as [String : Any]

iZooto.addUserProperties( data: data)

// For Android
iZooto.addUserProperty({"Gender": "Male"});

// For iOS
iZooto.addUserProperties("Gender","Male");

// For Android
iZooto.addUserProperty({"Gender": "Male"});

// For iOS
const obj = {"Gender": "Male"};
const myJSON = JSON.stringify(obj);
iZooto.addUserProperty(myJSON);

It is important to note that, if a new value("FEMALE") is passed corresponding to the same key ("Gender", in this case), the value gets overwritten for the user from the previously categorized property("MALE") and would become part of the new value passed("FEMALE").

For app setup, make sure the token is set and the SDK is properly initialized before passing user properties.

If you want to target users by the latest page that they visit, user properties would be the correct choice.


Example - You can add the following code to your website/app to capture the category of the last page visited for a user.

<script>
   window._izq.push(["userProfile",{"add":{
                "Category":"Sports"
            }
        }]);
</script>

HashMap<String, Object> data = new HashMap<>();

data.put("Category","Sports");

iZooto.addUserProperty(data);

let data = ["Category": "Sports"] as [String : Any]

iZooto.addUserProperties( data: data)

// For Android
iZooto.addUserProperty({"Category": "Sports"});

// For iOS
iZooto.addUserProperties("Category","Sports");

// For Android
iZooto.addUserProperty({"Category": "Sports"});

// For iOS
const obj = {"Category": "Sports"};
const myJSON = JSON.stringify(obj);
iZooto.addUserProperty(myJSON);

System Restrictions

  1. The maximum no. of string properties that you can pass is 16 unique values.

  2. Values for the String type User-Properties support a maximum of 64 characters.

  3. Data types supported are String, Numeric, Date, and Boolean.

  4. IMPORTANT The data type for the existing User-Property will be modified as per the last entry. For instance, if you define a User-Property as 'Numeric' and pass a 'String' value to it, the data type will be changed to 'String', and the operation filters in Audience Builder will be updated accordingly. You won't be able to see older data sent with the previous data type in 'Audience Builder' anymore.

❗️

The system properties mentioned below are reserved for internal use only. Please refrain from using these properties while defining user-properties at your end:

  1. _id
  2. btype
  3. pid
  4. country
  5. state
  6. city
  7. device
  8. os
  9. ip
  10. request_ip
  11. url
  12. created_on
  13. updated_on
  14. timezone
  15. unique_id
  16. auth_status
  17. auth_key
  18. public_key
  19. country_id
  20. state_id
  21. city_id
  22. useragent
  23. status
  24. bver
  25. last_notification_viewed
  26. last_notification_clicked
  27. sw_version
  28. as_version
  29. ge
  30. keywords
  31. last_website_visit
  32. fcm_enabled
  33. fcm_token
  34. pte
  35. endpoint
  36. ga_cookie
  37. taboola_cookie
  38. outbrain_cookie
  39. mgid_cookie
  40. sa_key
  41. vapid_private_key
  42. vapid_public_key
  43. safari_token
  44. mg
  45. ms
  46. android_token
  47. mi_token
  48. mi_sa_key
  49. mi_package_name
  50. ad_id
  51. hms_token
  52. _email
  53. _fn
  54. _ln
  55. _email_events
  56. nlo

Available Data Types

iZooto supports the following data types for User Properties

1. String

This is the most commonly used Data type and comprises a set of characters that can also contain spaces and numbers. 

<script>
   window._izq.push(["userProfile",{"add":{
                "Subscription Type":"Premium_User"   
            }
        }]);
</script>

HashMap<String, Object> data = new HashMap<>();

data.put( "Subscription Type","Premium_User" );

iZooto.addUserProperty(data);

let data = [ "Subscription Type":"Premium_User" ] as [String : Any]

iZooto.addUserProperties( data: data)

// For Android
iZooto.addUserProperty({"Subscription Type": "Premium User"});

// For iOS
iZooto.addUserProperties("Subscription Type","Premium User");

// For Android
iZooto.addUserProperty({"Subscription Type": "Premium User"});

// For iOS
const obj = {"Subscription Type": "Premium User"};
const myJSON = JSON.stringify(obj);
iZooto.addUserProperty(myJSON);

The filters available corresponding to the String Data Type are:

  • Equals
  • Not Equals
822

2. Number

This data type can be made use of if you wish to capture any numeric data against the user activity.

<script>
   window._izq.push(["userProfile",{"add":{
                "PinCode":10001  
            }
        }]);
</script>

HashMap<String, Object> data = new HashMap<>();

data.put("Pincode",10001);

iZooto.addUserProperty(data);

let data = ["Pincode": 10001] as [String : Any]

iZooto.addUserProperties( data: data)

// For Android
iZooto.addUserProperty({"Pincode": 10001});

// For iOS
iZooto.addUserProperties("Pincode",10001);

// For Android
iZooto.addUserProperty({"Pincode": 10001});

// For iOS
const obj = {"Pincode": 10001};
const myJSON = JSON.stringify(obj);
iZooto.addUserProperty(myJSON);

The filters available corresponding to the Number Data Type are:

  • Greater Than
  • Less Than
  • Equals
  • Not Equals
816

3. Boolean

Boolean accepts True or False as input and populates the relative filters based on that.

<script>
   window._izq.push(["userProfile",{"add":{
                "Sports_Visited": true   
            }
        }]);
</script>

HashMap<String, Object> data = new HashMap<>();

data.put("Sports_Visited",true);

iZooto.addUserProperty(data);

let data = ["Sports_Visited": true] as [String : Any]

iZooto.addUserProperties( data: data)

// For Android
iZooto.addUserProperty({"Sports_Visited": true});

// For iOS
iZooto.addUserProperties("Sports_Visited",true);

// For Android
iZooto.addUserProperty({"Sports_Visited": true});

// For iOS
const obj = {"Sports_Visited": true};
const myJSON = JSON.stringify(obj);
iZooto.addUserProperty(myJSON);

The filters available corresponding to the Boolean Data Type are:

  • Equals
  • Not Equals
733

4. Date

The Date data type is useful if you want to capture and store certain date values against subscribers.

<script>
   window._izq.push(["userProfile",{"add":{
                "Date":"2018-08-23 03:04:05"   
            }
        }]);
</script>

HashMap<String, Object> data = new HashMap<>();

data.put("Date","2018-08-23 3:04:05");

iZooto.addUserProperty(data);

let data = ["Date": "2018-08-23 3:04:05"] as [String : Any]

iZooto.addUserProperties( data: data)

// For Android
iZooto.addUserProperty({"Date": "2018-08-23 03:04:05"});

// For iOS
iZooto.addUserProperties("Date","2018-08-23 03:04:05");

// For Android
iZooto.addUserProperty({"Date": "2018-08-23 03:04:05"});

// For iOS
const obj = {"Date": "2018-08-23 03:04:05"};
const myJSON = JSON.stringify(obj);
iZooto.addUserProperty(myJSON);

The filters available corresponding to Date Data Type are:

Absolute:

  • Before
  • After
  • On
  • Between

Relative

  • In The Past
  • Was Exactly
  • Today
  • In The Future
  • Will be exactly
  • Within
810

Predefined Properties

iZooto also captures a few additional properties by default that give us some basic information about the subscribers. Here are the properties:

Device:
The devices they have subscribed to - Desktop, Mobile, and Tablet

❗️

Device as a property is only available for Web Push Notifications.

Location:
The location of the device they have subscribed to. This can be used to send location-specific campaigns.
You will be able to drill down to the exact city of the subscriber.

800

Subscription Date:
The date on which the subscription was captured.

804

Capturing User Properties at the time of subscription

For Web Push Only

Often marketers want to capture specific attributes about the user, such as language preference, country, website page from which the user subscribed, and more.

While some of these attributes, such as Subscription Date and Location, are captured by default, other specific attributes can be collected by using iZooto's callback function.

The properties can be captured at the time of subscription by using the register callback method

Here is how this works

  • Language Preference
  • Webpage from where the user subscribed
// Initializing iZooto
<script> window._izq = window._izq || []; window._izq.push(["init" ]); </script> 

<script>
window._izq.push(["registerSubscriptionCallback",function(obj){  

    //These codes can be defined as per your needs. Refer to below table
    if(obj.statuscode==1) 
    {
       /*
            Your code comes here
            Extract language here, your javascript
            var language =
        */

         window._izq.push(["userProfile",{"add":{
                "language":"en"    /*whatever language you wish to pass*/
                                }
        }]);
        
    }
  
}]); </script>

//Domain specific JS.
<script src="https://cdn.izooto.com/scripts/83600dbdd34d91e3b153aaf01a445e32dc49e63b.js"></script>

After you successfully extract the language using iZooto’s Callback API as per the above example, segments basis different languages can be created.

Now, when you are going to push a campaign, select the audience to which you want the notification to be pushed.

Updated 17 days ago

What’s Next