The InMobi Segments API allows advertisers to customise ad experiences based on user segments. Using the Segments API, advertisers can customise ads for a specific audience helping improve ad relevance and thus generate more revenue for the promoted app.
Segments are defined through device IDs, namely, Apple’s IDFA (ida) or Google’s Advertising ID (gpId). See table below for details
Parameter Name | Parameter Type | Description |
ida |
String | Identifier for advertiser without hashing. For iOS 6 and above. For more information, click here. |
Parameter Name | Parameter Type | Description |
gpId |
String | Google Play Advertising ID, without hashing. Please see here for more information. |
The goal of defining a segment could be either positive targeting or suppression (i.e., negative targeting).
Example:
The same user can be tagged to more than one segment
Once segment is created, it will be available for targeting at account level. A campaign manager can use this segment to include or exclude the property at Adgroup level.
The Segments API has 3 components:
To serve ads based on user segments, a segment needs to be created first. The parameters for creating a segment are listed below:
Parameter |
Data Type |
Required (Yes/No) |
Description |
|
String |
Yes |
Property ID as registered with InMobi. Click here for details on registering a property with InMobi. |
|
String |
Yes |
Segment name (unique for a property ID), lower-case unique check applied, max 2000 utf-8 characters |
|
String |
Yes |
To indicate the various campaign types the advertiser would like to share the segment with. The acceptable values for dst currently are:
|
|
String |
Yes |
Name of the Tracking Partner registered on InMobi. If not registered, please get it registered. |
URL Format |
|
URL Example |
|
JSON Response for Success |
|
JSON Response for Failure |
For User Acquisition and Remarketing:
|
Advertisers can add or remove a list of devices from an existing segment using this API. The parameters for adding or deleting devices from a segment are listed below:
Refer to the Installs document before tagging an user to a segment.
Parameter |
Data Type |
Required (Yes/No) |
Description |
|
String |
Yes |
The property ID as registered with InMobi. Click here for details on registering a property with InMobi. |
|
String |
Yes |
List of segment IDs (separated by semicolons) that the user is present in. |
|
String | Yes |
List of segment names (separated by semicolons) that the user is present in. Note: This will be used for Remarketing. |
|
String |
Yes |
Device identifier adhering to the guidelines in the device ID section. This one is mandatory for iOS. |
|
String |
Yes |
Device identifier adhering to the guidelines in the device ID section. It is mandatory for Android. |
|
String |
Yes |
Possible values are These are actions to be performed for a user on given property and segment IDs. Use this parameter to:
|
|
String |
Yes |
The currently acceptable values for dst are:
Multiple values can be separated using a semicolon. Example: …&dstList={ua; ifc}&... |
URL Format |
|
URL Example |
|
JSON Response for Success |
|
JSON Response for Failure |
|
Advertisers can upload bulk segment data to add or delete multiple users from a segment. A maximum of 10 MB of data can be uploaded in .CSV format. The .CSV file must be zipped.
You can submit a list of user ids via file upload. The file should have the predefined headers.
URL Format |
http://advertiser-content.inmobiapis.com/tpce/v1/upload/usersegment?propertyId=propertyId&segmentNames=segmentNames&segmentIds=segmentIds&dstList=dstList&action=add/delete |
URL Example |
http://advertiser-content.inmobiapis.com/tpce/v1/upload/usersegment?propertyId=propertyId&segmentNames=segmentName1&segmentIds=segmentId2&dstList={ua,ifc}&action=add |
CSV File Headers |
|
Example |
|
Response Content Headers |
|
JSON Response for Success |
Note: The |
JSON Response for Failure |
|
Advertisers can refresh a segment to update the list of users added to it. The parameters for refreshing the list of devices in a segment are listed below:
Parameter |
Data Type |
Required (Yes/No) |
Description |
|
String |
Yes |
gpmId of the app (provided by InMobi team) |
|
String |
Yes |
Segment id of the segment to be added/refreshed (received from createSegment API) |
|
String | Yes |
Name of the segment to be added/refreshed (received from createSegment API) Note: This is used for Remarketing. |
|
String |
Yes |
The currently acceptable value is ifc (for Remarketing). |
|
String |
Yes |
The source for this segment data |
URL Format |
http://advertiser-content.inmobiapis.com/tpce/v1/upload/segment/refresh |
URL Example |
https://advertiser-content.inmobiapis.com/tpce/v1/upload/segment/refresh?propertyId=sampleGpmId&segmentName=sampleSegmentName&dstList=ifc |
Response Content Headers |
|
JSON Response for Success |
|
JSON Response for Failure |
|
Notes:
ida
and gpid
)ida
or gpId
. The corresponding rows may contain the deviceIdsFile Compression Command: gzip file.csv
This would create a gzipped file called file.csv.gz
Thank you for voting!