拖拽图片以调整位置
The Use of Open Api for Mintegral Creative Set
Contents
Interface Design
1. Create a new offer and bind a creative set to the offer
2. Binding creatives for Offer / Modifying Unbound creatives
3. Get the offer's bound creative/creative set info
4. Create creative set
5. Edit creative set
6. Delete creative set
7. Get creative set details 
Interface Design
Overall design of creative set configuration function interface
host：https://ss-api.mintegral.com﻿
Signature verification method: consistent with other original interfaces
Number        Function
     method
           path
    Whether it is a new interface
1
Create a new offer and bind to a creative set
POST
/api/open/v1/offer
N
2
Bind creatives for offer/modify bound creative information
PUT
/api/open/v1/offer/apply_creative
N
3
Get the offer's bound creative/creative set information
GET
/api/open/v1/offers
N
4
Create  creative set
POST
/api/open/v1/creative_set
Y
5
Editorial creative set
PUT
/api/open/v1/creative_set
Y
6
Delete creative set/unbind creative set offer
DELETE
/api/open/v1/creative_set
Y
7
Get creative set details
GET
/api/open/v1/creative_set
Y
﻿
1. Create a new offer and bind a creative set to the offer
              path
  method
                desc
/api/open/v1/offer
POST
Create a new offer, inherit existing interfaces and protocols, and adjust protocol fields。
The agreement changes as follows
request field
meaning
compatible manner
                creatives
Original creative information will be abandoned after this issue is launched
This field is allowed to be used for submission, and the order creation and creative processing logic is consistent with the old version. The creative_sets field is recommended
creative_sets
New creative set dimensional information, new in this issue
During the switching period, one of the alternatives and creations is required
Note: When both the creations and creative_sets fields are submitted, creative_sets will prevail. 
﻿
a.Request parameters (only for newly added creative_sets, other fields keep the original logic)
             field
 dataType
       required
            desc
creative_sets
array<object>
Y
creative set information
creative_sets.*.creative_set_name
string
Y
creative set name
creative_sets.*.geos
array<string>
Y
Countries/regions where creative sets are used
creative_sets.*.ad_outputs
array<int32>
Y
The types of ideas the creative set expects to assemble are listed below
creative_sets.*.creatives
array<object>
Y
List of creatives bound to the creative set
creative_sets.*.creatives.*.creative_name
string
Y
The name of the creative in the creative set
creative_sets.*.creatives.*.creative_md5
string
Y
creative content md5, which is creative_md5 of the open/v1/creations/upload interface
b.demo
  type
      sample
request
 
111
POST /api/open/v1/offer
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json

{
    "campaign_id": "25",
    "offer_name": "cqf_testtttt",
    "promote_timezone": 7,
    "start_time": 1578455012,
    "target_geo": "ALL",
    "billing_type": "CPI",
    "bid_rate": 5,
    "daily_cap_type": "BUDGET",
    "daily_cap": "50",
    "total_budget": "50",
    "settlement_event": "",
    "os_version_min": "8.8",
    "custom_ad_schedule": {
        "1": "0,1,23",
        "2": "3,4,5",
        "3": "3,6,5"
    },
    "custom_ad_schedule_timezone": 0,
    "network": "WIFI",
    "target_ad_type": "BANNER",
    "creative_sets": [
        {
          "creative_set_name": "test_group_1",
            "ad_outputs": [
                111,
                121,
                131
            ],
            "geos": [
                "ALL"
            ],
            "creatives": [
                {
                    "creative_name": "image_1.jpg",
                    "creative_md5": "4066f7e9738eb0cfe87f59e752f8d64f",
                    "creative_type": "IMAGE",
                    "dimension": "1200x627",
                    "created_at": 1714124002,
                    "audit_status": 1,
                    "audit_reason": ""
                },
                {
                    "creative_name": "image_2.jpg",
                    "creative_md5": "9d4af767418b5e20a936c7c07f017e39",
                    "creative_type": "IMAGE",
                    "dimension": "1200x627",
                    "created_at": 1714124002,
                    "audit_status": 1,
                    "audit_reason": ""
                },
                {
                    "creative_name": "video_1.jpg",
                    "creative_md5": "9d4af767418b5e20a936c7c07f017e39",
                    "creative_type": "VIDEO",
                    "dimension": "1280x720",
                    "created_at": 1714124002,
                    "audit_status": 1,
                    "audit_reason": ""
                }
            ]
        },
        {
          "creative_set_name": "test_group_2",
            "ad_outputs": [
                111,
                121,
                131,
                132
            ],
            "geos": [
                "ALL"
            ],
            "creatives": [
                {
                    "creative_name": "image_1.jpg",
                    "creative_md5": "4066f7e9738eb0cfe87f59e752f8d64f",
                    "creative_type": "IMAGE",
                    "dimension": "1200x627",
                    "created_at": 1714124002,
                    "audit_status": 1,
                    "audit_reason": ""
                },
                {
                    "creative_name": "image_2.jpg",
                    "creative_md5": "9d4af767418b5e20a936c7c07f017e39",
                    "creative_type": "IMAGE",
                    "dimension": "1200x627",
                    "created_at": 1714124002,
                    "audit_status": 1,
                    "audit_reason": ""
                },
                {
                    "creative_name": "video_1.jpg",
                    "creative_md5": "9d4af767418b5e20a936c7c07f017e39",
                    "creative_type": "VIDEO",
                    "dimension": "1280x720",
                    "created_at": 1714124002,
                    "audit_status": 1,
                    "audit_reason": ""
                }
            ]
        }
    ],
    "target_device": "PHONE"
}
 
2. Binding creatives for Offer / Modifying Unbound creatives
              path
  method
                desc
/api/open/v1/offer/apply_creative
PUT
Binding creatives for offer/modifying binding creative information
Processing method: Keep the existing interface and perform compatible logic processing.
The following situations are divided into:
Edited offer type
Meaning
Compatible Manner
An offer for a creative set has not been created manually
That is, an offer that has not yet created a new programmatic or customized creative set
That is, it is regarded as an offer that has not been switched to the new function, allowing compatible processing and creative dimension operation
Manually create offers for creative sets
That is, an offer that has manually established a programmatic, customized creative set on the offer
That is, it is regarded as an offer that has been switched to a new function, and compatible processing is not allowed. The interface prompts the customer to use the new interface to operate, and the prompt text is as follows
Please operate your creative in the creative group, or contact us
"
﻿
3. Get the offer's bound creative/creative set info
              path
  method
                desc
/api/open/v1/offers
GET
Get offer information
Processing method: Keep the existing interface, add a new ext_fields enumeration, and support returning creative set information.
Add a new creative_sets enumeration in the ext_fields field. Add the following return content
                           fields
      sample
creative_sets
82
[
    {
        "offer_id": 100,
        "creative_set_name": "test_group_1",
        "ad_outputs": [111,121,131],
        "geos": [
            "ALL"
        ],
        "creatives": [
            {
                "creative_name": "image_1.jpg",
                "creative_md5": "4066f7e9738eb0cfe87f59e752f8d64f",
                "creative_type": "IMAGE",
                "dimension": "1200x627",
                "created_at": 1714124002,
                "audit_status": 1,
                "audit_reason": ""
            },
            {
                "creative_name": "image_2.jpg",
                "creative_md5": "9d4af767418b5e20a936c7c07f017e39",
                "creative_type": "IMAGE",
                "dimension": "1200x627",
                "created_at": 1714124002,
                "audit_status": 1,
                "audit_reason": ""
            },
            {
                "creative_name": "video_1.jpg",
                "creative_md5": "9d4af767418b5e20a936c7c07f017e39",
                "creative_type": "VIDEO",
                "dimension": "1280x720",
                "created_at": 1714124002,
                "audit_status": 1,
                "audit_reason": ""
            }
        ]
    },
    {
        "offer_id": 100,
        "creative_set_name": "test_group_2",
        "ad_outputs": [
            111,
            121,
            131,
            132
        ],
        "geos": [
            "ALL"
        ],
        "creatives": [
            {
                "creative_name": "image_1.jpg",
                "creative_md5": "4066f7e9738eb0cfe87f59e752f8d64f",
                "creative_type": "IMAGE",
                "dimension": "1200x627",
                "created_at": 1714124002,
                "audit_status": 1,
                "audit_reason": ""
            },
            {
                "creative_name": "image_2.jpg",
                "creative_md5": "9d4af767418b5e20a936c7c07f017e39",
                "creative_type": "IMAGE",
                "dimension": "1200x627",
                "created_at": 1714124002,
                "audit_status": 1,
                "audit_reason": ""
            },
            {
                "creative_name": "video_1.jpg",
                "creative_md5": "9d4af767418b5e20a936c7c07f017e39",
                "creative_type": "VIDEO",
                "dimension": "1280x720",
                "created_at": 1714124002,
                "audit_status": 1,
                "audit_reason": ""
            }
        ]
    }
]
﻿
﻿
4. Create creative set
              path
  method
                desc
/api/open/v1/creative_set
POST
Create creative set
a.request params
             field
 dataType
       required
            desc
creative_set_name
string
Y
creative_set_name
combination_method
int
Y
the combination method of creative_set_name:
1: programmatic creative set
2: customized creative set
offer_id
int64
Y
The offer you expect to bind after a creative set is created
geos
array<string>
Y
Countries/regions where creative sets are used
ad_outputs
array<int32>
Y
The types of ideas the creative set expects to assemble are listed below
creatives
array<object>
Y
List of creatives bound to the creative set
creatives
.*.creative_name
string
Y
The name of the creative in the creative set
creatives
.*.creative_md5
string
Y
creative content md5, which is creative_md5 of the open/v1/creations/upload interface
b.ad_output enumeration
      ad_output
           desc
111
Full Screen Image
121
Native Image Banner
131
Basic Banner
132
Image Banner
211
Video&Image Endcard
212
Video&Playable
213
Full Screen Video
221
Native Video Banner
231
Video Banner
311
Playable
c.demo
type
 sample
request
23
POST /api/open/v1/creative_set HTTP/1.1
Host: ss-api.mintegral.com
Content-Type: application/json

{
    "creative_set_name": "test_create_group_1",
    "offer_id": 100,
    "geos": [
        "ALL"
    ],
    "ad_outputs": [211, 212, 213],
    "creatives": [
        {
            "creative_name": "test_creative_1",
            "creative_md5": "abcd"
        },
        {
            "creative_name": "test_creative_2",
            "creative_md5": "cdfg"
        }
    ]
}
response
9
{
    "msg": "success",
    "code": 200,
    "data": {
        "creative_set_name": "test_create_group_1",
        "offer_id": 100
    }
}
﻿
5. Edit creative set
              path
  method
                desc
/api/open/v1/creative_set
PUT
Editorial creative set
a.request params
             field
 dataType
       required
            desc
offer_id
int64
Y
offer_id
creative_set_name
string
Y
creative set name
geos
array<string>
N
creative set targeted areas expected to be revised
ad_outputs
array<int32>
N
creative set creative types expected to be modified
creatives
array<object>
N
creative set creative expected to be revised
creatives
.*.option
string
Y
The editing method for this creative in this creative set is ENABLE for adding and DISABLE for deleting
creatives
.*.creative_name
string
N
When adding a new creative, this item is required, that is, the name of the creative in the creative set
creatives
.*.creative_md5
string
Y
creative md5, which is creative_md5 returned by the open/v1/creations/upload interface
b.demo
type
 sample
request
31
PUT /api/open/v1/creative_set HTTP/1.1
Host: ss-api.mintegral.com
Content-Type: application/json

{
    "offer_id": 100,
    "creative_set_name": "test_group_1",
    "geos": [
        "US",
        "CN"
    ],
    "ad_outputs": [
        111,
        121,
        131,
        132
    ],
    "creatives": [
        {
            "creative_name": "test_creative_1",
            "creative_md5": "abcd",
            "option": "ENABLE"
        },
        {
            "creative_name": "test_creative_1",
            "creative_md5": "abcd",
            "option": "DISABLE"
        }
    ]
}
﻿
response
5
{
    "msg": "success",
    "code": 200
}
﻿
6. Delete creative set
              path
  method
                desc
/api/open/v1/creative_set
DELETE
Delete a creative set. When a creative set is deleted, the offer will automatically disassociate it with the offer
a.request params
             field
 dataType
       required
            desc
offer_id
int64
Y
offer_id
creative_set_name
string
Y
creative_set_name
b.demo
type
 sample
request
9
DELETE /api/open/v1/creative_set HTTP/1.1
Host:ss-api.mintegral.com
Content-Type: application/json

{
    "offer_id": 100,
    "creative_set_name": "test_group_1"
}
response
5
{
    "msg": "success",
    "code": 200
}
﻿
7. Get creative set details 
              path
  method
                desc
/api/open/v1/creative_set
GET
Get creative set details
a.request params
             field
 dataType
       required
            desc
offer_id
int64
Y
offer_id
creative_set_id
int64
Y
the id of creative set
creative_set_name
int64
Y
the name of creative set
combination_method
int64
Y
the combination method of creative_set_name:
1: programmatic creative set
2: customized creative set
page
int64
Y
Page, current page number. Default page is 1
limit
int64
Y
Page, number of records per page. Default is 10, maximum is 50
b.demo
type
 sample
request
3
GET /api/open/v1/creative_sets?creative_set_name=test_group_1&offer_id=100,200 HTTP/1.1
Host: ss-api.mintegral.com
response
47
{
    "msg": "success",
    "code": 200,
    "data": {
        "limit": 10,
        "page": 1,
        "total": 1,
        "list": [
            {
                "offer_id": 100,
                "creative_set_name": "test_group_1",
                "ad_outputs": [111, 121, 131],
                "geos": ["ALL"],
                "creatives": [
                    {
                        "creative_name": "image_1.jpg",
                        "creative_md5": "4066f7e9738eb0cfe87f59e752f8d64f",
                        "creative_type": "IMAGE",
                        "dimension": "1200x627",
                        "created_at": 1714124002,
                        "audit_status": 1,
                        "audit_reason": ""
                    },
                    {
                        "creative_name": "image_2.jpg",
                        "creative_md5": "9d4af767418b5e20a936c7c07f017e39",
                        "creative_type": "IMAGE",
                        "dimension": "1200x627",
                        "created_at": 1714124002,
                        "audit_status": 1,
                        "audit_reason": ""
                    },
                    {
                        "creative_name": "video_1.jpg",
                        "creative_md5": "9d4af767418b5e20a936c7c07f017e39",
                        "creative_type": "VIDEO",
                        "dimension": "1280x720",
                        "created_at": 1714124002,
                        "audit_status": 1,
                        "audit_reason": ""
                    }
                ]
            }
        ]
    }
}
﻿
﻿
 