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

iOS

Android

The goal of defining a segment could be either positive targeting or suppression (i.e., negative targeting).

Example:

1. In remarketing, a common use case is to target users who have not opened the app for 30 days or more (“Dormant Users”), or users who are high-purchasing users (“High Value Users”). For these cases, a targeting list is required.
2. Advertisers can share a suppression list to exclude those users from a campaign’s targeting. These are primarily used for user acquisition campaigns to negatively target users who have already downloaded the advertiser’s app.

Note: The same user can be tagged to more than one segment

Segmenting for User Acquisition and Remarketing

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:

1. Creating a segment
2. Adding and deleting users from a segment
3. Refreshing a segment

To serve ads based on user segments, a segment needs to be created first. The parameters for creating a segment are listed below:

Format for sending requests: GET Method

{
    "status":"error_status",
    "message":"error_message",
    "code":"error_code"
}
				

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:

Note: Refer to the Installs document before tagging an user to a segment.

Format for sending requests

Adding and deleting a single user: GET Method

{
    "status":"OK",
    "message":"success",
    "code":"200"
}
				

 {
    "status":"error_status",
    "message":"error_message",
    "code":"error_code"
 }
				

Notes:

• Device IDs are sent independently in the query parameters
• Double quotes are not required around any parameter
• Segment IDs need to be semicolon-separated, and within a curly bracket

Adding and deleting multiple users: POST Method

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.

Note: You can submit a list of user ids via file upload. The file should have the predefined headers.

{
    "status":"OK",
    "message":"success_message xxxxxx",
    "code":"200",
    "jobUrl":"job url to check status of file upload"
}
				

{
    "status": "BAD_REQUEST",
    "message": "Invalid file Content found : Internal errors encountered..java.util.NoSuchElementException: No value present",
    "code":"1004"
}
				

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:

Format for sending request: POST Method

{
    "status":"OK",
    "message":"success_message xxxxxx",
    "code":"200",
    "jobUrl":"job url to check status of file upload"
}
				

{
    "status": "BAD_REQUEST",
    "message": "Invalid file Content found : Internal errors encountered..java.util.NoSuchElementException: No value present",
    "code":"1004"
}
				

Notes:

• A maximum of 50 MB of data can be uploaded in .CSV format. The .CSV file must be zipped
• The .CSV file can contain upto two columns (ida and gpid)
• Of the two columns, only one can be "non-blank" in each row
• The first row should contain one or more of following headers - ida or gpId. The corresponding rows may contain the deviceIds

File Compression Command: gzip file.csv

This would create a gzipped file called file.csv.gz