Skip to content

Get Creative Sets

PS: You need to use Token to change the status, for more details, please check Token

Get creative set information and support conditional paginated query

Request method

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

Request method

GET

Request example

json
GET /api/open/v1/creative_sets
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json
{ "offer_id": 3028 }

Request Params

fielddataTypeisRequireddescdefaultValueexample
offer_idintNoffer ID123
creative_set_idintNcreative set id123
creative_set_namestringNcreative set nameset_name1
combination_methodintNthe combination method of creative_set:1: programmatic creative set 2: customized creative set-set_name1
pageintNpage, starting with 111
limitintNlimit, max:501020

Response

fielddataTypedesc
codeint200 code, is success. Others, are fail
msgstringIf success, return to "success". If fail, return to detailed wrong info
datajsonIf success, return to "success". If fail, return to detailed wrong info
  limitintlimit
  pageintpage
  totalinttotal row
  listarray<object>/
    offer_idintofferID
    creative_set_namestringcreative set name
    combination_methodintthe combination method of creative_set:1: programmatic creative set 2: customized creative set
    ad_outputsarray<int>The types of ideas the creative set expects to assemble are listed below [enum - ad_output]
    geosarray<string>Countries/regions where creative sets are used
    creativesarray<object>List of creatives bound to the creative set
      creative_namestringcreative_name
      creative_md5stringcreative_md5
      creative_typestringcreative_type
      dimensionstringdimension
      created_atintThe time when the creative is bound to the creative group
      audit_statusintCreative review status: 0 for initialized, 1 for approved, 2 for rejected, 3 for under review
      audit_reasonstringReason for material rejection

Response Example

json
{
  "msg": "success",
  "code": 200,
  "data": {
    "limit": 10,
    "page": 1,
    "total": 1,
    "list": [
      {
        "offer_id": 100,
        "creative_set_name": "test_group_1",
        "combination_method": 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": ""
          }
        ]
      }
    ]
  }
}