API: Creating Campaigns (Technical Guide)

Label：API key ,API ,Create Campaign ,developer guide ,technical guide

You need to use your Mintegral token to manage your campaigns. For more details, please check Token.

Create ad objective you want to promote. It can be either an app or website.

Request address

https://ss-api.mintegral.com/api/open/v1/campaign

Request method

POST

Request example

json Copy

POST /api/open/v1/campaign
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json
{
  "campaign_name": "Test",
  "is_coppa": "YES",
  "promotion_type": "APP",
  "alive_in_store": "YES",
  "preview_url": "https://play.google.com/store/apps/details?id=xxxxxxx",
  "product_name": "Test",
  "package_name": "com.tencent.mm",
  "description": "Test",
  "icon": "f7c970d0d24c71d84d15a78f29042323",
  "platform": "ANDROID",
  "category": "BUSINESS",
  "app_size": 12.13,
  "min_version": "1.0.0"
}

Request Parameter

Note：If the default value is empty, the value in table below is shown as "—"

Fields	Type	Explanations	Default Value	Examples
campaign_name	string	Short description for campaign，campaign name must be unique and the max length is 100.	—	`"Test_campaign_name"`
promotion_type	string	Type of ads objective you want to promote. It can be either `"APP"` or `"WEBSITE"`.	—	`"APP"`
preview_url	string	The preview link of ads object. Note: 1.promotion_type="APP" and alive_in_store="YES", We will get application information automatically via using preview link， product_name、package_name、description、icon、platform、category、app_size、min_version included. 2.We prefer to use application information we captured for promotion than the value you added，and，if we get nothing from preview link, we’ll turn to use the value you set.	android: `"https://play.google.com/store/apps/details?id=com.tencent.mm&hl=zh"` ios: `"https://apps.apple.com/cn/app/%E6%94%AF%E4%BB%98%E5%AE%9D-%E8%AE%A9%E7%94%9F%E6%B4%BB%E6%9B%B4%E7%AE%80%E5%8D%95/id333206289"`
is_coppa	string	If campaign is directed to children, you should specify whether the campaign satisfy the requirement of COPPA. Optional value：`"YES"`、`"NO"`.	—	`"YES"`
alive_in_store	string	Specify whether the APP you want to promote is already alive in Google Play or iOS App Store. Optional value：`"YES"`、`"NO"`.	—	`"YES"`
icon	string	MD5 of the logo or icon. You can get md5 after upload image successfully through creative upload API. Note：Only jpg、png、 jpeg、 bmp file accepted and the dimension should be 512x512 within 5 M.	—	`"f7c970d0d24c71d84d15a78f29042323"`
product_name	string	App name or website name, the max length for this field is 100.	—	`"product_name_test"`
package_name	string	Bundle id or ios application store id of the App. Note：platform="IOS"&&alive_in_store="YES", package name must be application store id . platform="ANDROID", package name should be bundle id id.	—	android: `"com.tencent.mm"` ios: `"id414478124"`
app_size	number	Size of app，the unit is MB. If you ads objective is a website, leave this field empty.	—	`12.34`
platform	string	Platform to promote you ads，optional value is `"IOS"` and `"ANDROID"`, please note you can only choose one of them.	—	`"IOS"`
category	string	Category of ads objective. The category is different between different platform. Please check [ENUM-Category for iOS] [ENUM-Category for Android].	—	`"GAMES"`
min_version	string	Minimum OS version allowed in format of `/^[0-9](\.[0-9]){0,2}$/` . Note: if you ads objective is a website, please leave this field empty.	—	`"1.0.0"`
description	string	Description of ads objective, the maximum length of this field is 4000.	—	`"Test"`

Response

Fields	Type	Explanations
code	int	200 code, is success. Others, are fail.
msg	string	If success, return to "success". If fail, return to detailed wrong info.
data	json	If success, return to campaign data. If fail, return to detailed wrong info.
campaign_id	int	Unique ID for campaign
campaign_name	string	Campaign name you add
is_coppa	string	The value of COPPA setting
promotion_type	string	Promotion type you set
alive_in_store	string	The value you set of “alive in store”
preview_url	string	Preview link you add in campaign
product_name	string	Ads objective name
package_name	string	IOS app store id or buddle id of the application you want to promote
description	string	Description of ads objective
icon	string	Md5 of icon or logo
platform	string	Platform of campaign
category	string	Category of campaign
app_size	string	Size of application
min_version	string	Minimum OS version

Response Example

json Copy

{
  "msg": "success",
  "code": 200,
  "data": {
    "campaign_id": 1234,
    "is_coppa": "YES",
    "campaign_name": "Test",
    "promotion_type": "APP",
    "alive_in_store": "YES",
    "preview_url": "https://play.google.com/store/apps/details?id=xxxxxxx",
    "product_name": "Test",
    "package_name": "com.tencent.mm",
    "description": "Test",
    "icon": "f7c970d0d24c71d84d15a78f29042323",
    "platform": "ANDROID",
    "category": "BUSINESS",
    "app_size": "12.13",
    "min_version": "1.0.0"
  }
}

API: Retrieve Campaign List (Technical Guide)

API: Updating Campaigns (Technical Guide)

Last modified: 2025-08-28

Outline