Advanced settings for iOS

Set UserID

[IronSource setUserId:YOUR_USERID];

IronSource.setUserId(userID)

Define Segments

• Device Properties: the ironSource SDK collects certain standard parameters that pertain to the users' device automatically such as device model, device manufacturer, app version, and OS. You do not need to convey this data to us
• User Properties: user data which is not collected by our SDK (for example, age, gender, or creation date) must be relayed through the API. (See a full list of supported segment properties with descriptions in the following section). Follow the instructions to send us these details so our SDK can apply the relevant ad settings to the segments you defined on the ironSource platform
• Custom Segments: you can create a custom segment with predefined conditions without conveying user details to our servers and tailor ad settings for that user segment on the ironSource platform

Pass User Properties

ISSegment *segment = [[ISSegment alloc]init];

let segment: ISSegment = ISSegment()

1. If you are familiar with the segment that the user belongs to, enter the segment name:

   [segment setSegmentName:YOUR_SEGMENT_NAME];

   segment.segmentName = "YOUR_SEGMENT_NAME"

2. Send us the user details. ironSource provides a range of standard user properties that you can set to attribute a user to a segment in the API. See table below for descriptions.

   // Set user age
   [segment setAge:USER_AGE]; 
   // Set user gender
   [segment setGender:USER_GENDER];
   // Set user level
   [segment setLevel:USER_LEVEL];
   // Set user's paying status
   [segment setPaying:USER_PAYING];
   // Set user's total in-app purchase history
   [segment setIapTotal:YOUR_IAP_TOTAL];
   // Set user creation date
   [segment setUserCreationDate:YOUR_DATE];

   // Set user age
   segment.age = USER_AGE
   // Set user gender
   segment.gender = ISGender.IRONSOURCE_USER_FEMALE
   // Set user's total in-app purchases
   segment.iapTotal = USER_IAP_TOTAL
   // Set user's level
   segment.level = USER_LEVEL
   // Set user's paying status
   segment.paying = USER_PAYING_STATUS
   // Set user creation date
   segment.userCreationDate = NSDate() as Date!

   In addition, you can set up to 5 custom user properties per segment:

   [segment setCustomValue:YOUR_CUSTOM_VALUE forKey:YOUR_CUSTOM_KEY];

   segment.setCustomValue("CUSTOM_VALUE", forKey: "CUSTOM_KEY")

   Next, to serve your ad units based on segments, call the following function complete with either the segment name or user properties:

   [IronSource setSegment:YOUR_SEGMENT];

   IronSource.setSegment(YOUR_SEGMENT);

Supported Segment Properties

Obtain the User's Segment Name

1. Adopt this interface in your class to conform to the Segment Name protocol and enable the receipt of the segment name [icode]ISSegmentDelegate[/icode]
2. Register to the following delegate to receive the segment name that your user belongs to. The SDK will then notify your delegate of the event.

   [IronSource setSegmentDelegate:self];
   
   IronSource.setSegmentDelegate(self)
   
   (void)didReceiveSegement:(NSString *)segment
   
   func didReceiveSegement(_ segment: String!)

Custom Parameters for iOS

• Custom parameters work in conjunction with server-to-server completion callbacks only. You will receive the parameter as part of the callback string.
• You may insert more than one custom parameter in the init request.

Implementation Code

• Custom Parameters can be set several times per session.
• To reset the value, use clearRewardedVideoServerParameters, and then set the new value.

[IronSource setRewardedVideoServerParameters:(NSDictionary *)parameters];
[IronSource clearRewardedVideoServerParameters];

Price limitations using waterfall configuration (beta)

Create a waterfall configuration

// define a WaterallConfigurationBuilder
ISWaterfallConfigurationBuilder *builder = [ISWaterfallConfiguration builder];
// Build the WaterfallConfiguration and add data to constrain or control a waterfall
[builder setCeiling:@ceiling];
[builder setFloor:@floor];
ISWaterfallConfiguration *configuration = [builder build];
//set a configuration for an ad unit
[IronSource setWaterfallConfiguration:configuration forAdUnit:[ISAdUnit IS_AD_UNIT_REWARDED_VIDEO]];

Clearing a Waterfall Configuration

ISWaterfallConfiguration *clearConfiguration = [ISWaterfallConfiguration clear];
[IronSource setWaterfallConfiguration:clearConfiguration forAdUnit:[ISAdUnit IS_AD_UNIT_REWARDED_VIDEO]];

Overwriting a Waterfall Configuration

...
[IronSource setWaterfallConfiguration:configuration forAdUnit:[ISAdUnit IS_AD_UNIT_REWARDED_VIDEO]];
ISWaterfallConfigurationBuilder *builder2 = [ISWaterfallConfiguration builder];
[builder2 setCeiling:@ceiling];
[builder2 setFloor:@floor];
ISWaterfallConfiguration *configuration2 = [builder build];
[IronSource setWaterfallConfiguration:configuration2 forAdUnit:[ISAdUnit IS_AD_UNIT_REWARDED_VIDEO]];

ironSource SDK Error Codes