InMobi DSP’s (Demand-side platform) Segment Creation API enables advertisers to transfer their audience to InMobi DSP with minimal manual intervention. Data ingestion significantly improves campaign targeting by leveraging the InMobi DSP Data Science models along with your audience.
You can configure the TTL (Time-to-Live) values, which determine how long your audience data remains in the DSP.You can use the integration to target your audience positively and negatively on the InMobi DSP.
The process starts with integrating your server with InMobi DSP and creating the audience segment on the DSP. After the segment creation, you have to ingest those audience data into the DSP. You can do the segment ingestion in two ways:
After completing the segment ingestion, you can target the audience through InMobi DSP. For any queries regarding the integration process, contact the InMobi team.
Ensure you have an active account with the InMobi DSP.
Before ingesting your audience segment in your InMobi DSP account, you must integrate the DSP Segment Creation API into your server. The integration automatically creates the audience segments on your DSP account.
Follow the steps to create an audience segment on InMobi DSP:
http://advertiser.inmobiapis.com/tpce/v1/segment?segmentName=&propertyId=&membershipTtl=<MEMBER_SHIP_TTL_IN_DAYS>
.Check the API response. The response should be as follows:
{
"status": "OK",
"message": "success",
"code": 200,
"segmentId": "64d9e0bb-ad9c-4235-8b6e-2d1e6ad40cb3"
}
Value | Data type | Description |
---|---|---|
OK |
String | The API call was processed without any error. |
success |
String | Message for successful integration. |
200 |
Number | Refers to the https status code. |
64d9e0bb-ad9c-4235-8b6e-2d1e6ad40cb3 |
String | The ID of the segment created in the InMobi DSP |
Confirm with your InMobi Account Manager if the audience segment is visible on the DSP dashboard.
After you create the audience segment on the InMobi DSP, you can ingest your audience data to the DSP in two ways:
Single-user ingestion uses a GET endpoint to create a single user on InMobi DSP. Follow the steps to implement the Real-time DSP Ingestion:
http://advertiser.inmobiapis.com/tpce/v1/usersegment?propertyId=&gpId=&segmentIds=&action=&ida=<ios_device_id></ios_device_id>
{
"status": "OK",
"message": "success",
"code": 200,
}
Key | Value | Data type | Description |
---|---|---|---|
status |
OK |
String | The API call was processed without any error. |
message |
success |
String | Message for successful API call. |
code |
200 |
Number | Refers to the https status code. |
Batch ingestion uses a POST endpoint to transfer the data stored in a compressed CSV file (.csv.gz) with a maximum file size of 10 MB. The file name format is filename.csv.gz, with no space between the words if the filename has more than one word. Follow the steps to implement the CSV file Ingestion:
curl -X POST -H 'Content-Type: multipart/form-data' -H 'Accept-Encoding: gzip' -H 'Content-Disposition: attachment; filename="@sample.csv.gz"' -H 'Content-Transfer-Encoding: binary' -F "file=@sample.csv.gz" -H 'User-Agent: python-requests/2.14.2' https://advertiser-content.inmobiapis.com/tpce/v1/upload/usersegment?propertyId=<inmobi_advertiser_id>&segmentNames=<segment_names>&segmentIds=<segment_ids>&action=<action> </action></segment_ids></segment_names></inmobi_advertiser_id>
Check the file ingestion API response. The response should be as follows:
{
"status": "OK",
"message": "check the jobStatus via GET call of given jobUrl",
"code": 200,
"jobUrl": "https://advertiser-content.inmobiapis.com/tpce/v1/upload/jobs/file?job_id=sample.csv.gz_j2358cd64-63c0-4d8d-8104-5812dc09a5f2"
}
Key | Value | Data type | Description |
---|---|---|---|
status |
OK |
String | The API call was processed without any error. |
message |
check the jobStatus via GET call of given jobUrl |
String | Message for checking the status of the ingestion. |
code |
200 |
Number | Refers to the https status code. |
jobUrl |
https://advertiser-content.inmobiapis.com/tpce/v1/upload/jobs/file?job_id=sample.csv.gz_j2358cd64-63c0-4d8d-8104-5812dc09a5f2 |
String | The URL to check the status of a job |
{
"status": "OK",
"message": "File processed successfully",
"code": 200,
}
Key | Value | Data type | Description |
---|---|---|---|
status |
OK |
String | The API call was processed without any error. |
message |
File processed successfully |
String | Message for successful job status check. |
code |
200 |
Number | Refers to the https status code. |
If the propertyId or advertiserId used in the segment creation or segment ingestion is not InMobi DSP compliant, you may see the following error:
{
"status": "BAD_REQUEST",
"message": "Invalid parameter(s) : Rejected due to error: CVM-X",
"code": 1001,
"segmentId": "-1"
}
Confirm with the InMobi team if the audience segment data are visible on the DSP dashboard. It takes at least 24 hours to reflect the audience data on the DSP after execution.
By installing this SDK update, you agree that your Children Privacy Compliance setting remains accurate or that you will update that setting, whenever there is a change in your app's audience. You may update the app's Children Privacy Compliance settings at https://publisher.inmobi.com/my-inventory/app-and-placements.