User Information API
ironSource App Analytics provides analysis of the users usage of the application, including all their activities, progression & purchasing from application activation. To better understand who are the users, and what kind of users spend the most or perform any other activity – App Analytics allows full users’ drill down according to their characteristics.
These characteristics (Such as their age, their gender, how they logged in and others) should be provided (If available) prior to the SDK initialization, using the user information API as detailed below
using System.Collections.Generic;
// User Information settings API
IronSourceanalytics.setUserInfo(HashSet<ISAnalyticsMetaData> metaDataList);
Note:
In order to use this API make sure you added “System.Collections.Generic” library to your code
Parameters
- HashSet<ISAnalyticsMetadata> metadataList – a HashSet of all ISAnalyticsMetaData objects
- ISAnalyticsMetadata – object that contains predefined user information key (enumeration) and value. ISAnalyticsMetaData object can be created in 2 forms:
- Using only enumerated values
- ISAnalyticsMetadata.GENDER – The gender of the user. Available values:
- MALE
- FEMALE
- OTHER
- ISAnalyticsMetadata.LOGIN_TYPE_VALUE – The login method of the user. Available values:
- APP
- OTHER
- ISAnalyticsMetadata.GENDER – The gender of the user. Available values:
- Using ISAnalyticsMetadataKey enumerated options along with the value itself. Options:
- ISAnalyticsMetadataKey.AGE – The age of the user. Value should be between 0 and 120 (Integer value)
- ISAnalyticsMetadataKey.IAP_USER – True if the user ever purchased anything within the app (boolean value)
- ISAnalyticsMetadataKey.IS_SUBSCRIBED – True if the user is a licensed user – paid for playing the game (boolean value)
- ISAnalyticsMetadataKey.FIRST_LOGIN – The first login date of the user to the application in this device (dateTime value)
- ISAnalyticsMetadataKey.CREATION_DATE – The creation date of the user (dateTime value)
- ISAnalyticsMetadataKey.ACHIEVEMENT – Represent an achievement of the gamer (string value)
- Using only enumerated values
Note:
All parameters are mandatory
Example of User information API
using System.Collections.Generic;
...
// Example of using the user information settings API, prior to sdk initialization
HashSet<ISAnalyticsMetaData> metaDataSet = new HashSet<ISAnalyticsMetaData>
{
new ISAnalyticsMetaData(ISAnalyticsMetaDataKey.ACHIEVEMENT, "success"),
new ISAnalyticsMetaData(ISAnalyticsMetaDataKey.FIRST_LOGIN, DateTime.Now),
new ISAnalyticsMetaData(ISAnalyticsMetaDataKey.CREATION_DATE, DateTime.Now),
new ISAnalyticsMetaData(ISAnalyticsMetaData.GENDER.FEMALE),
new ISAnalyticsMetaData(ISAnalyticsMetaData.LOGIN_TYPE_VALUE.FACEBOOK),
new ISAnalyticsMetaData(ISAnalyticsMetaDataKey.IAP_USER, true),
new ISAnalyticsMetaData(ISAnalyticsMetaDataKey.IS_SUBSCRIBED, true),
new ISAnalyticsMetaData(ISAnalyticsMetaDataKey.AGE, 30)
};
IronSourceAnalytics.setUserInfo(metaDataSet);