Mintegral Developer Interface Documentation

Document Description

Module Descriptions

Interface Details

API Request

Request Protocol
Request Method
Request General Parameters

Below are general parameters that are applicable for all interfaces:

Name Type Description
skey string Developer’s skey on Mintegral platform.
time string The unix timestamp for when the request is initiated, valid time is ±300 seconds.
sign string Signature. Signature generation guidelines can be found in appendix 1.

API Response

Name Type Description
code int Returned value.0 indicates success. More values can be found in appendix 7.
msg string Returned message. Detailed error message will be displayed in this field.
data json array or json object Returned data.

Media Module

Create media

Request parameters:

Name Type Required Description

app_name

string

Required

Media name intended to be unique among all media names in the same publisher account.

os

string

Required

Operating system. Enumeration values refer to appendix 3.

package

string

Required

Media’s respective package name intended to be unique among all package names in the same account.

iOS sample: id1364356863

Android sample: com.talkingtom

is_live_in_store

int

Required

Whether live in app store(s). Enumeration values are as below:

1-yes;

0-no;

if value equals 1, store url must be presented in the store_url field.

store_url

string

Required for applications live in app store(s)

App store link.

coppa

int

Required

Whether abides to COPPA. Enumeration values are as below:

1-yes;

0-no;

campaign_black_rule

int

Optional;default value equals 2;

Ad blacklist rule. Enumeration values are as below:

0—not setting up blacklist

1-inherit publisher level blacklist

2—set up individually

If value equals 2, either black_category or black_packagename field must be filled out.

black_category

string

Optional

Blacklist based on market category. Enumeration values can be found in the appendix.

Separate category IDs with commas; e.g.: black_category=11,12,13

If campaign_black_rule equals 2, either black_category or black_packagename field must be filled out

black_packagename

string

Optional

Blacklists based on package name. Separate package names by commas;

iOS sample: id1364356863,id1364356865,id1364356867

Android sample: com.talkingtom,com.talkinglily,com.talkinglucy

If campaign_black_rule equals 2, either black_category or black_packagename field must be filled out

auto_storekit

int

Optional

Whether automatic display of storekit is permitted. Enumeration values are as below:

1-yes(Default);

0-no;

mediation_platform

int

Optional

Mediation Platform. Enumeration values can be found in the appendix 5.

Default: 0 (Others)

video_orientation

string

Optional

Orientation of returned video. Enumeration values include "portrait", "landscape", "both".

Default: "both"

store

string

Optional

App Store Name. Enumeration values can be found in the appendix 8.

Default iOS App Store: app_store

Default Android App Store: google_play

Response parameters:

Name Type Description

code

int

Returned value. 200 indicates success.

msg

string

Returned message. Detailed error message will be displayed in this field.

data

json array or json object

Returned data.

publisher_id

int

Developer ID.

app_name

int

Media name.

app_id

int

App ID for respective media created on Mintegral platform.

warning

string

This field will be present if blacklist setup fails.

Response sample:

 
{
    "code": 200,
    "data": {
        "app_id": 209,
        "publisher_id": 123,
        "app_name": "App Name"
    }
}

Edit Media

Request parameters:

Name Type Required Description

app_id

int

Required

Media ID on Mintegral platform

app_name

string

Optional

Media name will only be updated when this field is presented.

package

string

Optional

Media’s respective package name intended to be unique among all package names in the same account.

iOS sample: id1364356863

Android sample: com.talkingtom

is_live_in_store

int

Optional

Information on whether live in app store(s) will only be updated when this field is presented.

If value equals 1, store_url must be provided

1-yes;

0-no;

store_url

string

Required for applications live in app store(s)

Appstore link

coppa

int

Required

Information on whether abides to COPPA will only be updated if this filled is presented.

1-yes;

0-no;

campaign_black_rule

int

Optional

Ad blacklist rule will only be updated if this field is presented.

Enumeration values are as below:

0—not setting up blacklist

1-inherit publisher level blacklist

2—set up individually

If value equals 2, either black_category or black_packagename field must be filled out.

black_category

string

Optional

Blacklist based on market category. Enumeration values can be found in the appendix 2.

Separate category IDs with commas; e.g.: black_category=11,12,13

If campaign_black_rule equals 2, either black_category or black_packagename field must be filled out.

black_packagename

string

Optional

Blacklists based on package name. Separate package names by commas;

iOS sample: id1364356863,id1364356865,id1364356867

Android sample: com.talkingtom,com.talkinglily,com.talkinglucy

If campaign_black_rule equals 2, either black_category or black_packagename field must be filled out

auto_storekit

int

Optional

Whether automatic display of storekit is permitted. Enumeration values are as below:

1-yes(Default);

0-no;

mediation_platform

int

Optional

Mediation Platform. Enumeration values can be found in the appendix 5.

video_orientation

string

Optional

Orientation of returned video. Enumeration values include "portrait", "landscape", "both".

Default: "both"

store

string

Optional

App Store Name. Enumeration values can be found in the appendix 8.

Response parameters:

Name Type Description

code

int

Returned value. 200 indicates success.

msg

string

Returned message. Detailed error message will be displayed in this field.

data

json array or json object

Returned data.

publisher_id

int

Developer ID.

app_id

int

Media name.

app_name

int

App ID for respective media created on Mintegral platform.

is_live_in_store

int

Whether live in app store(s) .

1-yes;

0-no;

store_url

string

Appstore link.

coppa

int

Whether abides to COPPA.

1-yes;

0-no;

campaign_black_rule

int

Ad blacklist rules.

black_category

string

Blacklist based on market category.

black_packagename

string

Blacklist based on package name.

warning

string

This field will be present if blacklist setup fails.

Response sample:

    
{
    "code": 200,
    "data": {
        "app_id": 209,
        "app_name": "App Name",
        "is_live_in_store": 0,
        "store_url": "https://play.google.com/store/apps/details?id=com.live.live4d",
        "coppa": 0,
        "campaign_black_rule": 0,
        "black_category": "",
        "black_packagename": "",
        "publisher_id": 5059
    }
}

Media List

Request parameters:

Name Type Required Description

package

string

Optional

Media Package name.

os

string

Optional

Operating system. Enumeration values refer to appendix 3.

Response parameters:

Name Type Description

code

int

Returned value. 200 indicates success.

msg

string

Returned message. Detailed error message will be displayed in this field.

data

json array or json object

Returned data.

total

int

Total Number of Apps.

lists

json array or json object

Media List.

app_id

int

App ID for respective media created on Mintegral platform.

app_name

string

App Name for respective media created on Mintegral platform.

package

string

Media Package name.

os

string

Operating system. Enumeration values refer to appendix 3.

Response sample:

    
{
    "code": 200,
    "data": {
        "total": 1,
        "page": 1,
        "per_page": 5000,
        "lists": [
            {
                "app_id": 18111,
                "app_name": "app_namexxxx",
                "package": "com.xxx.gp",
                "os": "ANDROID"
            }
        ]
    }
}

Placement

Create Ad Placement

Request Parameters:

Name Type Required Description

app_id

int

Required

Media ID.

placement_name

string

Required

Ad Placement name.

ad_type

string

Required

Ad unit ad format. Enumeration values include "rewarded_video", "new_interstitial", "native", "static_interstitial", "banner", "automatic_rendering_native", "splash_ad".

integrate_type

string

Required

Integration type. Value only supports "sdk", which means integrate via SDK;

content_type

string

If ad_type = "native" or "automatic_rendering_native" or "new_interstitial", it is optional.

Content type. Enumeration values include "image", "video", "both".

Default: "both"

video_orientation

string

If ad_type = "native", it is optional.

Orientation of returned video. Enumeration values include "portrait", "landscape", "both".

Default: "landscape"

show_close_button

int

If ad_type = "banner", it is optional.

Whether show the close button:

1-yes;

0-no;(Default)

auto_fresh

int

If ad_type = "banner", it is optional.

When Auto Refresh is turned on, new ads are automatically requested and displayed to users at intervals.

1-turn on;

0-turn off;(Default)

ad_space_type

int

If ad_type = "new_interstitial", it is optional.

Ad Size.

1-Full Screen Interstitial;(Default)

2-Half Screen Interstitial;

unit_names

string

One of "unit_names" and "hb_unit_name" is Required.

“unit_names" are used for traditional units (non-bidding units)

Separate unit_names with commas; e.g.: unit_names=unit_name1,unit_name2

This does not provide ad unit names with commas

hb_unit_name

string

One of "unit_names" and "hb_unit_name" is Required.

"hb_unit_name" is the unit which is used for header bidding.

skip_time

int

Optional

This setting only displays when there is a "video resource" in the ad. (Rewarded Video, New Interstitial with the setting of fullscreen video, etc.)

-1 - Non Skippable;

0~30 - Close button will appear after `skip_time` seconds.

Response parameters:

Name Type Description

code

int

Returned value. 200 indicates success.

msg

string

Returned message. Detailed error message will be displayed in this field.

data

json array or json object

Returned data.

publisher_id

int

Developer ID.

app_id

int

Media ID.

placement_id

int

Ad Placement Id.

placement_name

string

Ad placement name.

unit_ids

array

Ad Unit ID.

Response sample:

    
{
    "code": 200,
    "data": {
        "placement_id": 4888,
        "unit_ids": [
            1238888,
            1238889
        ],
        "publisher_id": 1999,
        "app_id": 8888,
        "placement_name": "native_plm"
    }
}

Edit Ad Placement

Request Parameters:

Name Type Required Description

app_id

int

Required

Media ID.

placement_id

int

Required

Ad Placement ID.

placement_name

string

Optional

Ad Placement name.

content_type

string

If ad_type = "native" or "new_interstitial", it is optional.

Content type. Enumeration values include "image", "video", "both".

video_orientation

string

If ad_type = "native", it is optional.

Orientation of returned video. Enumeration values include "portrait", "landscape", "both".

show_close_button

int

If ad_type = "banner", it is optional.

Whether show the close button:

1-yes;

0-no;

auto_fresh

int

If ad_type = "banner", it is optional.

When Auto Refresh is turned on, new ads are automatically requested and displayed to users at intervals.

1-turn on;

0-turn off;

ad_space_type

int

If ad_type = "new_interstitial", it is optional.

Ad Size.

1-Full Screen Interstitial;

2-Half Screen Interstitial;

skip_time

int

Optional

This setting only displays when there is a "video resource" in the ad. (Rewarded Video, New Interstitial with the setting of fullscreen video, etc.)

-1 - Non Skippable;

0~30 - Close button will appear after `skip_time` seconds.

Response parameters:

Name Type Description

code

int

Returned value. 200 indicates success.

msg

string

Returned message. Detailed error message will be displayed in this field.

data

json array or json object

Returned data.

publisher_id

int

Developer ID.

app_id

int

Media ID.

placement_id

int

Ad Placement ID.

placement_name

string

Ad placement name.

Response sample:

    
{
    "code": 200,
    "data": {
        "placement_id": 128888,
        "publisher_id": 5888,
        "app_id": 288,
        "placement_name": "Placement Name"
    }
}

Delete Ad Placement

Request parameters:

Name Type Required Description

placement_ids

string

Required

Ad placement IDs.

Separate Ad Placement IDs with commas; e.g.: placement_ids=1,2,3

Response parameters:

Name Type Description

code

int

Returned value.0 indicates success. More values can be found in appendix 7.

msg

string

Returned message. In case of error, this field displays the detailed error message

data

json array or json object

Returned data. Returns the ID of corresponding action

publisher_id

int

Developer ID.

Response sample:

 
{
    "code": 200,
    "data": {
        "publisher_id": 123
    }
}

Ad Placement List

Request parameters:

Name Type Required Description

app_id

int

Optional

Media ID

Response parameters:

Name Type Description

code

int

Returned value. 200 indicates success.

msg

string

Returned message. Detailed error message will be displayed in this field.

data

json array or json object

Returned data.

total

int

Total Number of Ad Placements.

lists

json array or json object

Ad Placement List.

placement_id

int

Ad Placement ID created on Mintegral platform.

placement_name

string

Ad Placement Name created on Mintegral platform.

app_id

int

App ID created on Mintegral platform.

ad_type

string

Ad unit ad format.

Response sample:

    
{
    "code": 200,
    "data": {
        "total": 2,
        "page": 1,
        "per_page": 5000,
        "lists": [
            {
                "placement_id": 574096,
                "placement_name": "原生max",
                "app_id": 176359,
                "ad_type": "native"
            },
            {
                "placement_id": 559486,
                "placement_name": "原生分层",
                "app_id": 176359,
                "ad_type": "automatic_rendering_native"
            }
        ]
    }
}

Ad Unit Module

Create Ad Unit

Create Placement Unit

Request Parameters:

Name Type Required Description

app_id

int

Required

Media ID.

placement_id

int

Required

Placement ID.

bidding_type

int

Optional

Biddinig Type, access needs to be applied for separately.

1-Header Bidding;

0-Traditional(Default);

unit_name

string

Required

Ad unit name.

ecpm_floor

array

Optional

Ecpm Floor, access needs to be applied for separately. Format: the keys are country codes, Uppercase only, Enumeration keys include "ALL" and country codes, such as "US","CN". For all country codes, please refer to Country, and values should be numerical. For Example:

ecpm_floor[AL] = 1

ecpm_floor[AX] = 1

ecpm_floor[ALL] = 2

target_ecpm

array

Optional

Target Ecpm, access needs to be applied for separately. Format: the keys are country codes, Uppercase only, Enumeration keys include "ALL" and country codes, such as "US","CN". For all country codes, please refer to Country, and values should be numerical. For Example:

target_ecpm[AL] = 1

target_ecpm[AX] = 1

target_ecpm[ALL] = 2

Response parameters:

Name Type Description

code

int

Returned value. 200 indicates success.

msg

string

Returned message. Detailed error message will be displayed in this field.

data

json array or json object

Returned data.

publisher_id

int

Developer ID.

app_id

int

Media ID.

placement_id

int

Placement ID.

unit_id

int

Unit ID for respective ad placements created on Mintegral platform.

unit_name

string

Ad unit name.

Response sample:

    
{
    "code": 200,
    "data": {
        "placement_id": 5000,
        "unit_id": 1314361,
        "publisher_id": 1234,
        "app_id": 9001039,
        "unit_name": "fullscreen_test"
    }
}

Edit Ad Unit

Edit Placement Unit

Request Parameters:

Name Type Required Description

app_id

int

Required

Media ID.

placement_id

int

Required

Placement ID.

unit_id

int

Required

Ad Unit ID.

unit_name

string

Optional

Ad Unit name.

At least one of unit_name,ecpm_floor,clear_ecpm_floor,target_ecpm,clear_target_ecpm is required.

ecpm_floor

array

Optional

Ecpm Floor, access needs to be applied for separately. Format: the keys are country codes, Uppercase only, Enumeration keys include "ALL" and country codes, such as "US","CN". For all country codes, please refer to Country, and values should be numerical. For Example:

ecpm_floor[AL] = 1

ecpm_floor[AX] = 1

ecpm_floor[ALL] = 2

At least one of unit_name,ecpm_floor,clear_ecpm_floor,target_ecpm,clear_target_ecpm is required.

clear_ecpm_floor

int

Optional

If clear all ecpm floor setting or not

1 - clear

0 or other values - not do anyting

At least one of unit_name,ecpm_floor,clear_ecpm_floor,target_ecpm,clear_target_ecpm is required.

target_ecpm

array

Optional

Target Ecpm, access needs to be applied for separately. Format: the keys are country codes, Uppercase only, Enumeration keys include "ALL" and country codes, such as "US","CN". For all country codes, please refer to Country, and values should be numerical. For Example:

target_ecpm[AL] = 1

target_ecpm[AX] = 1

target_ecpm[ALL] = 2

At least one of unit_name,ecpm_floor,clear_ecpm_floor,target_ecpm,clear_target_ecpm is required.

clear_target_ecpm

int

Optional

If clear all target ecpm setting or not

1 - clear

0 or other values - not do anyting

At least one of unit_name,ecpm_floor,clear_ecpm_floor,target_ecpm,clear_target_ecpm is required.

Response parameters:

Name Type Description

code

int

Returned value. 200 indicates success.

msg

string

Returned message. Detailed error message will be displayed in this field.

data

json array or json object

Returned data.

publisher_id

int

Developer ID.

app_id

int

Media ID.

placement_id

int

Placement ID.

unit_id

int

Unit ID for respective ad placements created on Mintegral platform.

unit_name

string

Ad unit name.

Response sample:

    
{
    "code": 200,
    "data": {
        "placement_id": 5000,
        "unit_id": 134148,
        "publisher_id": 1234,
        "app_id": 9001039,
        "unit_name": "fullscreen_test"
    }
}

Delete Ad Unit

Request parameters:

Name Type Required Description

unit_ids

string

Required

Ad unit IDs.

Separate Ad Unit IDs with commas; e.g.: unit_ids=1,2,3

Response parameters:

Name Type Description

code

int

Returned value.0 indicates success. More values can be found in appendix 7.

msg

string

Returned message. In case of error, this field displays the detailed error message

data

json array or json object

Returned data. Returns the ID of corresponding action

publisher_id

int

Developer ID.

Response sample:

 
{
    "code": 200,
    "data": {
        "publisher_id": 123
    }
}

Ad Unit List

Request parameters:

Name Type Required Description

placement_id

int

Optional

Ad Placement ID.

Response parameters:

Name Type Description

code

int

Returned value. 200 indicates success.

msg

string

Returned message. Detailed error message will be displayed in this field.

data

json array or json object

Returned data.

total

int

Total Number of Ad Units.

lists

json array or json object

Ad Unit List.

unit_id

int

Ad Unit ID created on Mintegral platform.

unit_name

string

Ad Unit Name created on Mintegral platform.

placement_id

int

Ad placement ID created on Mintegral platform.

app_id

int

App ID created on Mintegral platform.

target_ecpm

json array or json object

Target cpm list, For example:

target_ecpm[AL] = 1

target_ecpm[AX] = 1

target_ecpm[ALL] = 2

Response sample:

    
{
    "code": 200,
    "data": {
        "total": 2,
        "page": 1,
        "per_page": 5000,
        "lists": [
            {
                "unit_id": 11111,
                "unit_name": "native",
                "placement_id": 22222,
                "app_id": 33333,
                "target_ecpm": []
            },
            {
                "unit_id": 11112,
                "unit_name": "test",
                "placement_id": 22222,
                "app_id": 33333,
                "target_ecpm": {
                    "CN": 0.01,
                    "HK": 0.01,
                    "MO": 0.01,
                    "TW": 0.01
                }
            }
        ]
    }
}

Appendix

Appendix1:Sign Generation

The signature string is an important identifier for integration. Developers are required to verify the use of tokens. The generation rule is: md5(SECRETmd5(time))

Example

1. Request parameters:

$parameters = [
    'skey'=> 'm79hZT3XYukEI05rWtcU',
    'app_name'=> 'set_app_test_a18DF',
    'coppa'=> '1',
    'package'=> 'test123',
    'store_url'=> '',
    'publisher_id'=> 12792,
    'is_live_in_store'=> 0,
    'time'=> '1563181040',
    'os'=> 'ANDROID'
];
$secret = '99b50cfa3e2ae9ebb276f4e16e26f04b';

2. Sign generation:

md5(SECRETmd5(time)), the generated sign:

f9dc2e2e928be342892e4e823c021777

The SECRET of the above example is: 99b50cfa3e2ae9ebb276f4e16e26f04b

Appendix2: Blacklist Category List

1. Android Apps Blacklist Category List
ID Blacklist Category List
44
45
5
56
38
6
7
8
46
9
10
40
47
41
11
12
13
14
48
15
16
49
17
18
19
20
37
21
22
23
24
50
25
1
26
27
28
29
39
42
51
30
52
31
43
32
53
33
34
54
35
36
55
Action
Adventure
Allgames
AndroidWear
Arcade
Art & Design
Auto & Vehicles
Beauty
Board
Books & Reference
Business
Cards
Casino
Casual
Comics
Communication
Dating
Education
Educational
Entertainment
Events
Family
Finance
Food & Drink
Health & Fitness
House & Home
Libraries & Demo
Lifestyle
Maps & Navigation
Medical
Music & Audio
MusicGames
News & Magazines
Others
Parenting
Personalization
Photography
Productivity
Puzzle
Racing
RolePlaying
Shopping
Simulation
Social
SportGames
Sports
Strategy
Tools
Travel & Local
Trivia
VideoPlayers & Editors
Weather
WordGames
2. iOS Apps Blacklist category list
ID Blacklist name
94
77
96
93
92
91
97
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
90
89
95
88
87
86
99
106
105
107
108
109
110
111
112
113
114
101
115
116
102
117
118
119
100
103
120
121
122
123
124
104
125
126
127
2
85
84
83
98
82
81
80
79
78
Book
Business
Catalogs
Education
Entertainment
Finance
Food & Drink
Games
Games -> Action
Games -> Adventure
Games -> Arcade
Games -> Board
Games -> Card
Games -> Casino
Games -> Dice
Games -> Educational
Games -> Family
Games -> Music
Games -> Puzzle
Games -> Racing
Games -> RolePlaying
Games -> Simulation
Games -> Sports
Games -> Strategy
Games -> Trivia
Games -> Word
Health & Fitness
Lifestyle
Medical
Music
Navigation
News
Newsstand
Newsstand -> Arts & Photography
Newsstand -> Automotive
Newsstand -> Brides & Weddings
Newsstand -> Business & Investing
Newsstand -> Children's Magazines
Newsstand -> Computers & Internet
Newsstand -> Cooking,Food & Drink
Newsstand -> Crafts & Hobbies
Newsstand -> Electronics & Audio
Newsstand -> Entertainment
Newsstand -> Fashion & Style
Newsstand -> Health,Mind & Body
Newsstand -> History
Newsstand -> Home & Garden
Newsstand -> LiteraryMagazines & Journals
Newsstand -> Men's Interest
Newsstand -> Movies & Music
Newsstand -> News & Politics
Newsstand -> Outdoors & Nature
Newsstand -> Parenting & Family
Newsstand -> Pets
Newsstand -> Professional & Trade
Newsstand -> RegionalNews
Newsstand -> Science
Newsstand -> Sports & Leisure
Newsstand -> Teens
Newsstand -> Travel & Regional
Newsstand -> Women's Interest
Others
Photo & Video
Productivity
Reference
Shopping
SocialNetworking
Sports
Travel
Utilities
Weather

Appendix3: Operating System

Value Description
ANDROID Google Android
IOS Apple iOS

Appendix4: Country

Appendix5: Mediation Platform

Value Description
1 MAX
4 DT FairBid
6 TopOn
7 TradPlus
8 GroMore
9 Helium
11 Unity
12 IronSource
13 Yandex
14 Google AdMob/AdManager
15 ToBid
0 Others

Appendix6: AD Format

AD Format(For query) AD Format Name(For display) Traffic type
app_wallApp WallNative SDK
nativeNativeNative SDK & Online api
rewarded_videoRewarded VideoNative SDK
offerwallOffer WallNative SDK
static_interstitialStatic InterstitialNative SDK
new_interstitial New InterstitialNative SDK
interactive_adsInteractive AdsNative SDK
bannerBannerNative SDK
splash_adSplash ADNative SDK
automatic_rendering_nativeNative(Auto Rendering)Native SDK
online_api_interstitialInterstitial(Online API)Online api
online_api_bannerBanner(Online API)Online api
online_api_videoOnline VideoOnline api

Appendix7: Returned Value

Returned Value Message Notes
200 Success Success
-2004 No Access Verification unsuccessful
-2006 Permission denied No permission to proceed
-2007 Invalid Params Invalid parameters
-10016 Invalid APP Name Invalid APP name
-10017 Invalid APP Platform Invalid operating system
-11004 Invalid Unit Name Invalid Unit name
-11010 Invalid Unit Name Invalid ad unit name
-11011 Invalid Unit AdType Invalid Unit Ad Type
-15001 Invalid Placement name Invalid Placement name
-15002 Invalid Placement id Invalid Placement id

Appendix8: Store

Value Description
google_play Google Play
app_store Apple App Store
amazon Amazon Appstore
other Others