SDK User Metadata Pass-through

1. Introduction
2. Revision History
3. Parameters Reference
4. Implementation

1. Introduction

The SDK version 2.0 includes new APIs to enable user and context metadata targeting by advertisers. This document describes how to do this, the benefits to both publishers and advertisers of doing so, and privacy implications.

— What is meta-data?
Some publishers ask their users for specific registration information, such as age, gender, marital status, income and other demographic and psychographic data. This information is called metadata, and if you collect it and are permitted to share it with AdColony, you can submit it to our system from within your application.

— Why should i provide meta-data?
Advertisers often want to reach particular audiences, and user metadata affords a way to precisely target those audiences. When you provide AdColony with metadata, you have the opportunity to earn additional revenue by unlocking ad campaigns that require metatargeting. Your users are also exposed to ads that are more relevant to them, which provides for a better overall user experience.

— What about user privacy?
All metadata variables and values that AdColony encourages the publisher to pass through are non-personally identifiable. We will not accept any metadata that contains personally identifiable information, like names or emails. Also, we will not store the data you pass; it will be used by our ad server, at the moment the request arrives, to properly serve ads for campaigns that require metatargeting.
Back to Top

2. Revision History

Back to top

3. Parameters Reference

Back to top

4. Implementation

— iOS Header File Definitions

extern NSStringconst ADC_SET_USER_AGE; //set the users age
extern NSStringconst ADC_SET_USER_INTERESTS; //set the users interests
extern NSStringconst ADC_SET_USER_GENDER; //set the users gender
extern NSStringconst ADC_SET_USER_LATITUDE; //set the users current latitude
extern NSStringconst ADC_SET_USER_LONGITUDE; //set the users current longitude
extern NSStringconst ADC_SET_USER_ANNUAL_HOUSE_HOLD_INCOME; //set the users annual house hold income in United States Dollars
extern NSStringconst ADC_SET_USER_MARITAL_STATUS; //set the users marital status
extern NSStringconst ADC_SET_USER_EDUCATION; //set the users education level
extern NSStringconst ADC_SET_USER_ZIPCODE; //set the users known zip code
extern NSStringconst ADC_USER_MALE; //user is male
extern NSStringconst ADC_USER_FEMALE; //user is female
extern NSStringconst ADC_USER_SINGLE; //user is single
extern NSStringconst ADC_USER_MARRIED; //user is married
extern NSStringconst ADC_USER_EDUCATION_GRADE_SCHOOL; //user has a basic grade school education and has not attended high school
extern NSStringconst ADC_USER_EDUCATION_SOME_HIGH_SCHOOL; //user has completed at least some high school but has not received a diploma
extern NSStringconst ADC_USER_EDUCATION_HIGH_SCHOOL_DIPLOMA; //user has received a high school diploma but has not completed any college
extern NSStringconst ADC_USER_EDUCATION_SOME_COLLEGE; //user has completed at least some college but doesn’t have a college degree
extern NSStringconst ADC_USER_EDUCATION_ASSOCIATES_DEGREE; //user has been awarded at least 1 associates degree, but doesn’t have any higher level degrees
extern NSStringconst ADC_USER_EDUCATION_BACHELORS_DEGREE; //user has been awarded at least 1 bachelors degree, but does not have a graduate level degree
extern NSStringconst ADC_USER_EDUCATION_GRADUATE_DEGREE; //user has been awarded at least 1 masters or doctorate level degree


— iOS Basic Metadata Setting Examples

//Developers should set user information (if accurate information is available) for improved ad targeting and improved ad earnings
//Usage Example: [AdColonyPublic setUserMetadata: ADC_SET_USER_AGE withValue:@”25″];
//Usage Example: [AdColonyPublic setUserMetadata: ADC_SET_USER_MARITAL_STATUS withValue: ADC_USER_MARRIED];
//Usage Example: [AdColonyPublic setUserMetadata: ADC_SET_USER_GENDER withValue: ADC_USER_FEMALE];
//Usage Example: [AdColonyPublic setUserMetadata: ADC_SET_USER_EDUCATION withValue: ADC_USER_EDUCATION_SOME_COLLEGE];
//Usage Example: [AdColonyPublic setUserMetadata: ADC_SET_USER_ZIPCODE withValue: @”12345″];
//Usage Example: [AdColonyPublic setUserMetadata: ADC_SET_USER_ANNUAL_HOUSE_HOLDINCOME withValue: @”85000″];
//Usage Example: [AdColonyPublic setUserMetadata: ADC_SET_USER_LATITUDE withValue: @”85.316″];
+ ( void ) setUserMetadata:(NSString*)meta_data_type withValue:(NSString*)value;
//Call this to give the SDK real time feedback about what a user is interested in.
//For example, if the user has started browsing the finance section of a news app, a developer should call: [AdColonyPublic userInterestedIn:@”finance”]
//This will improve targeting and consequently improve earnings for your app.
//You can call this as often as you want with various topics that the user has engaged in within your app, or as the user engages in them.
//Other Usage Examples:
// [AdColonyPublic userInterestedIn:@”facebook”]; //The user has posted a comment to Facebook for their friends to see
// [AdColonyPublic userInterestedIn:@”dating”]; //The user has clicked on a dating app within your ‘more apps’ section.
// [AdColonyPublic userInterestedIn:@”puzzles”]; //The user is playing a puzzle mini game within your app
+ ( void ) userInterestedIn:(NSString*)topic;

Back to top