advertiser-api-guides | Installs API Guide

This document provides information on how to use the InMobi Install API endpoint for negative targeting during new-user acquisition, and segment retargeting during user re-engagement campaigns.

Note: This document is intended for advertisers who are directly sharing installs and segments data to InMobi.

Install Endpoint

Advertisers can provide install information to InMobi at the install endpoint.

Parameters

The following parameters are required:

Parameter

Required (Yes/No)

Description

eventTime

No

Time of install in long-UTC. If empty, it will be the time when InMobi received the ping.

propertyId

Yes

Property ID as registered with InMobi. Click here for details on registering a property with InMobi.

u-id-map

Yes

Device identifiers adhering to the guidelines in the device ID section.

  • ida is mandatory for iOS.
  • gpId is mandatory for Android.

Format for Sending Requests

Sending request to a single user: GET method

URL Format

http://advertiser-content.inmobiapis.com/tpce/v1/upload/events/download?propertyId=propertyId&country=country&trackingPartner=trackingPartner

Notes:

  • Device IDs are sent independently in the query parameters.
  • Double quotes are not required around any parameters.

URL Example

http://advertiser-content.inmobiapis.com/tpce/v1/upload/events/download?propertyId=propertyId&country=USA&trackingPartner=appsflyer&o1=40bd001563085fc35165329ea1ff5c5ecbdbbeef&um5=202cb962ac59075b964b07152d234b70&gpId=bd1e2264-382d-4980-9e50-ff5bcc954d50

JSON Response for Success 

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

JSON Response for Failure 

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

Sending requests to multiple users: POST method

An advertiser can send up to 10 MB of bulk-install data in CSV format. The file must be zipped.

Note: The CSV file needs to have at least one of the following headings based on the device ID type: 

ida, gpId

Example:

gpId

bd1e2264-382d-4980-9e50-ff5bcc954d50

Please see below for the request structure of a multipart file upload.

URL Format

http://advertiser-content.inmobiapis.com/tpce/v1/upload/events/download?propertyId=propertyId&country=country&trackingPartner=trackingPartner

URL Example

http://advertiser-content.inmobiapis.com/tpce/v1/upload/events/download?propertyId=43abm044c&country=USA&trackingPartner=TP4

Response Content Headers

  • Content Type: multipart/form-data
  • Accept-Encoding: gzip
  • Content-Disposition: attachment; filename="xyzfilename"
  • Content-Type: text/csv
  • Content-Transfer-Encoding: binary

JSON Response for Success 

{
"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_Supp2.csv.gz_ja3c34d8a-3c43-4baa-8ca9-d3ea88d39c34"
}

Note: The JobUrl will give a JSON response indicating whether the job has succeeded, failed, or is in progress.

JSON Response for Failure 

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

Device ID Guidelines

iOS

Parameter Name

Parameter Type

Description

ida

String

Identifier for advertiser without hashing. For iOS 6 and above, only. For more information, click here.

Android

Parameter Name

Parameter Type

Description

gpId

String

Google Play advertiser ID without hashing. Please see here for more information.