campaignを管理するにはMintegral tokenを使用する必要があります。詳細はTokenをご確認ください。
プロモーションしたい広告objectiveを作成します。appまたはwebsiteのいずれかを指定できます。
https://ss-api.mintegral.com/api/open/v1/campaign
POST
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"
}
Note:Default Valueが空の場合、下表では"—"として表示されます。
| Fields | Type | Explanations | Default Value | Examples |
|---|---|---|---|---|
| campaign_name | string | campaignの短い説明です。campaign nameは一意である必要があり、最大長は100です。 | — | "Test_campaign_name" |
| promotion_type | string | プロモーションしたいads objectiveのtypeです。"APP"または"WEBSITE"を指定できます。 |
— | "APP" |
| preview_url | string | ads objectのpreview linkです。 Note: 1.promotion_type="APP"かつ alive_in_store="YES"の場合、preview linkを使用してapplication informationを自動取得します。product_name、package_name、description、icon、platform、category、app_size、min_versionが含まれます。 2.入力された値よりも取得したapplication informationをpromotionに優先して使用します。preview linkから何も取得できない場合は、設定された値を使用します。 |
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 | campaignがchildren向けの場合、campaignがCOPPA要件を満たすかどうかを指定する必要があります。Optional value:"YES"、"NO"。 |
— | "YES" |
| alive_in_store | string | プロモーションしたいAPPがGoogle PlayまたはiOS App Storeですでに公開されているかを指定します。Optional value:"YES"、"NO"。 |
— | "YES" |
| icon | string | logoまたはiconのMD5です。creative upload APIでimageを正常にuploadした後にmd5を取得できます。 Note:jpg、png、jpeg、bmp fileのみ受け付け、dimensionは512x512、5M以内である必要があります。 |
— | "f7c970d0d24c71d84d15a78f29042323" |
| product_name | string | App nameまたはwebsite nameです。このfieldの最大長は100です。 | — | "product_name_test" |
| package_name | string | AppのBundle idまたはios application store idです。Note:platform="IOS"&&alive_in_store="YES"の場合、package nameはapplication store idである必要があります。 platform="ANDROID"の場合、package nameはbundle idである必要があります。 |
— | android: "com.tencent.mm" ios: "id414478124" |
| app_size | number | appのSizeです。単位はMBです。ads objectiveがwebsiteの場合、このfieldは空にしてください。 | — | 12.34 |
| platform | string | adsをpromoteするPlatformです。optional valueは"IOS"と"ANDROID"で、どちらか一方のみ選択できます。 |
— | "IOS" |
| category | string | ads objectiveのCategoryです。categoryはplatformによって異なります。以下を確認してください。 [ENUM-Category for iOS] [ENUM-Category for Android]。 |
— | "GAMES" |
| min_version | string | /^[0-9](\.[0-9]){0,2}$/形式で許可されるMinimum OS versionです。Note: ads objectiveがwebsiteの場合、このfieldは空にしてください。 |
— | "1.0.0" |
| description | string | ads objectiveのDescriptionです。このfieldの最大長は4000です。 | — | "Test" |
| Fields | Type | Explanations |
|---|---|---|
| code | int | 200 codeはsuccessです。その他はfailです。 |
| msg | string | successの場合は"success"を返します。failの場合は詳細なerror infoを返します。 |
| data | json | successの場合はcampaign dataを返します。failの場合は詳細なerror infoを返します。 |
| campaign_id | int | campaignのUnique ID |
| campaign_name | string | 追加したCampaign name |
| is_coppa | string | COPPA settingのvalue |
| promotion_type | string | 設定したPromotion type |
| alive_in_store | string | “alive in store”に設定したvalue |
| preview_url | string | campaignに追加したPreview link |
| product_name | string | Ads objective name |
| package_name | string | プロモーションしたいapplicationのIOS app store idまたはbundle id |
| description | string | ads objectiveのDescription |
| icon | string | iconまたはlogoのMd5 |
| platform | string | campaignのPlatform |
| category | string | campaignのCategory |
| app_size | string | applicationのSize |
| min_version | string | Minimum OS version |
{
"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"
}
}