1. What is segment?
TopOn supports grouping users in multiple dimensions. Different segments can be configured with different waterfalls to achieve the purpose of refined traffic monetization. Currently, TopOn supports the following segment dimensions: Area, City,Date, Week, Hour, Loading Time, Network type, App Version Name, App Version Code, SDK Version, OS Version, Device ID, Device Type, Device Brand, Installation Time, Channel, Sub-channel, IDFA Status, Installation Source, User Number, SDK Preset Strategy and Custom.
2. How to configure segment
(1) In the TopOn developer backend, to create a segment for the first time, you need to go to [Mediation]→[Add segment] to add it.
(2) The setting rules for each segment are as follows:
Rule | Condition | Number of rules | Description | Example |
---|---|---|---|---|
Area | Include, exclude | 1 | Multiple regions can be selected | Mainland China, Japan, South Korea |
City | Include, exclude | 1 | Multiple cities can be selected. You can select a city only after adding a rule after selecting a region | Guangzhou, Beijing, Shanghai |
Date | Include | 1 | You can select time period and time zone | 2023/01/01-2023/01/02 |
Hours | Including | Multiple | Select when selecting a date, select a week 00:00 to 23:59 | 10:00 to 23:59 |
Time Zone | Equal to | 1 | When selecting a date, you can select various time zones | UTC+8 Beijing |
Network Type | Include | 1 | You can choose 2G\3G\4G\WiFi only network. Multiple selections are allowed | 4G |
App Version Name | Include, exclude | Multiple | App Version Name, multiple app versions can be filled in, separated by English commas (You can check the App version dimension query in TopOn comprehensive report) |
2.2.1,2.2.2 |
App Version Code | Including, excluding, ≥, ≤ | 1 or more | Android: App version_code, you need to fill in an integer, it is recommended to consult App R&D technology to provide the app version number. iOS: The app version number is consistent with the app version name. (You can check the App Version dimension in the TopOn comprehensive report) |
Android: 112345; iOS: 1.1.1 |
SDK Version | Including, excluding, >, < | 1 | TopOn SDK version, when including or excluding, you can fill in multiple SDK version numbers, separated by English commas. > and <, only one can be filled in | 5.0.0 |
OS Version | Including, excluding, >, < | 1 | Mobile system version, when including and excluding, multiple system version numbers can be filled in, separated by English commas. > and <, only one can be filled in | 13.3.1 |
Device ID | Including | 1 | You can fill in multiple device IDs, separated by English commas. The device ID can be iOS (IDFA, IDFV), Android (GAID, Android ID, OAID, IMEI, IMEI is supported in Android 10 and below) | 28968E75-E7BE-4AA2-BFA0-C455DD74C111 |
Device Type | Include, exclude | 1 | You can choose iPhone or iPad. Multiple selections are allowed | iPad |
Device Brand | Include, exclude | 1 | Multiple brands can be selected | Xiaomi |
CPU Model | Include, exclude | 1 | Different CPU models can be selected, and it is only applicable to the Android version. | x86 |
Installation Time | >、< | Multiple | The installation time is calculated based on the time when TopOn SDK is initialized for the first time. Multiple installation time rules are in an AND relationship. segment must be met at the same time to take effect | < 1 day or < 24 hours |
Channel | include, exclude | 1 | support multiple channel numbers, separated by English commas, channel numbers must first be passed in through the SDK's customs | channel_1 |
Sub-channel | Include, exclude | 1 | Supports multiple sub-channel numbers, separated by English commas, and the sub-channel numbers must first be passed in through the SDK's customs | sub_channel_1 |
Loading Time | Only yes | / | The SDK will automatically determine whether to apply cold start, and this segment configuration will be used during cold start. It is recommended to configure fewer ad sources for cold start to reduce request time and increase display rate. | Yes |
User Number | Include, exclude, ≥, ≤, interval | Multiple | Match word rules after uploading user number | 11111 |
Installation Source | Include, exclude | Multiple | Can identify the installation source of each user Note: This rule is only effective for Android systems |
com.google.com |
SDK Preset Strategy | Only select yes | / | Android "SDK Preset Strategy Instructions" iOS "SDK Preset Strategy Instructions"SDK preset strategy can only be used alone | Yes |
Custom | Equal to use the = symbol, not equal to use the != symbol, and use the & symbol | 1 | Set through Key-Value conditions, the conditions of Key and Value can be equal to = or not equal to !=, a Key can correspond to multiple Values, separated by English commas. Use & between multiple conditions, that is, multiple conditions need to be met at the same time | For example, 18-year-old male users, and users brought by Toutiao or Tencent promotion are grouped together, and the custom to be filled in is age=18&sex=male&pnetwork=bytedance,tencent |
Custom(new) |
|
Multiple | Settings are made through Key-Value conditions. The custom rule character type supports strings, integers, and floating-point numbers. When it is a string type, multiple attribute values are supported for input, separated by an English comma. When selecting range operators for integer and floating-point types, it is fixed as open intervals on both sides. Multiple custom rule conditions need to be met simultaneously in order to hit the segment rules. |
|
When setting multiple rules in a single segment, each rule uses the AND condition for judgment. That is, when all conditions are met at the same time, the segment will be sent.
3.TopOn SDK sets customs for segment
Note: If you need to use the "channel", "sub-channel", and "custom" segment functions, follow the following instructions to pass the corresponding fields to TopOn when you need to integrate. You cannot directly configure and use them in the TopOn background. Before initializing the TopOn SDK, you need to call the interface of the TopOn SDk to complete the custom parameter input.
Android Method | iOS Method |
---|---|
initCustomMap | customData |
The following code examples are for users who are 18 years old, male, and brought in by Toutiao promotion
TopOn Android SDK code example:
Map<String, String> customMap = new HashMap<>();
customMap.put("age", "18"); //age=18
customMap.put("sex", "male"); //sex=male
customMap.put("pnetwork", "bytedance"); //promotion network is byte dance
ATSDK.initCustomMap(customMap); // The custom rules of the App are global settings and are valid for all Placements.
ATSDK.initPlacementCustomMap(customMap); // Supported by TopOn Android SDK V5.5.2 and above, it is only valid for the current Placement. You can add Placement-specific custom rules based on the App custom rules.
TopOn iOS SDK code example:
[ATAPI sharedInstance].customData = @{@"age":@"18", @"sex":@"male", @"pnetwork":@"bytedance"}; //age=18,sex=male and promotion network is byte dance, App’s custom rules are global settings and are valid for all Placements
[[ATAPI sharedInstance] setCustomData:@{@"test_key":@"test_val"} forPlacementID:@"placmentid"]; //Supported by TopOn iOS SDK V5.5.1 and above, it is only valid for the current Placement. You can add Placement-specific custom rules based on the App custom rules.
4. About segment priority setting
One TopOn ad slot can be configured with multiple segments. When multiple segments are configured, each segment will have a priority. The prefix number of the segment is the priority, 1 is the highest priority, and the priority decreases from left to right. When a request hits multiple segments at the same time, TopOn will return the segment advertising source configuration with the highest priority.
For example: segment A is the United States, and segment B is Europe and America (including the United States). At this time, the priority of segment A needs to be adjusted to be ahead of the priority of segment B to ensure the waterfall of segment A requested by US users.
You can use the [mediation]->[Add segment]->[set priority]-> drag and drop a single group to sort.
5. How to copy segments
5.1 Copy segment entry
When adding segments in mediation, you can select the copy segment function.
5.2 Select the content to be copied
The content that can be copied: Copy Segment Name & Rules (default), Copy Segment Setting (Advanced Settings), Copy Waterfalls (check to copy the waterfall configuration of the currently selected segment)
5.3 Choose placements and segments
(1) After selecting Copy the waterfall configuration of the segment, only placements with the same style will be displayed.
(2) If Copy waterfall configuration is not checked, the segment will be copied and created directly.
(3) Only supports copying non-default segments.
(4) If Copy waterfall configuration is selected, after selecting placements and segments, the page will jump to the waterfall configuration page, and all ad sources will be newly created.
6. How to perform batch modification
When you need to make unified adjustments to multiple segments under the ad slot, you can use the batch operation function to modify the settings in batches.
(1) First click [Setting]
(2) Check the segment that needs to adjust the policy
(3) Click the batch operation button to display the adjustment items
(4) Submit after modification
7. FAQ
(1) In what situations do you need to use customs for segment?
TopOn supports grouping users in multiple dimensions. Different segments can be configured with different waterfalls to achieve the purpose of refined traffic monetization.
Currently, TopOn supports the following segment dimensions: Area, City, Date, Hour, Zone Time, Network type, App Version Name, SDK Version, OS Version, Device ID, Device Type, Device Brand, Installation Time, Channel, Sub-channel and Custom.
segment dimensions that TopOn does not support by default can be handled by using customs segment. As long as the developer can label the user rules and pass the field to TopOn, all groupings can be achieved through customs.
Note: The three segment rules, including channels, sub-channels, and customs, all require developers to transfer fields and update the version before they can be used; other segment dimensions can be used directly in the TopOn background configuration.
To configure customs, please refer to our help document: >>Custom Configuration Guide
(2) How to distinguish the source of user channels?
After the developer returns the channel information to TopOn, the data of different channels can be distinguished in multiple reports and configurations.
① Before initializing TopOn SDK, follow the Custom Configuration Guide to pass in the channel field.
② Fill in the channel field passed in the code in the segment configuration.
③ Adjust the operation strategies of different channels according to segment.
Note:
- After completing Step 1, you can view data directly by channel for full reports, cohorts reports, user engagement, and hourly reports;
- If you need to adjust the operation strategy for different channels, you need to complete Step 1~Step 3.
(3) I set a segment for some devices in mediation. Why doesn’t the segment take effect?
Currently TopOn supports the following device IDs to set segments:
- Android: GAID, Android ID, OAID, IMEI. (Tips: TopOn recommends that you use Android ID in China and GAID overseas when setting)
- iOS: IDFA, IDFV