Get Ads

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

Get AD information and support conditional paginated query

Request Address

https://ss-api.mintegral.com/api/open/v1/creative-ad/list

Request method

GET

Request example

GET /api/open/v1/creative-ad/list
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json
{ "ad_ids": [2131252991, 2131252990] }

Request Params

field	dataType	isRequired	desc	defaultValue	example
ad_ids	array<int64>	Y	ad_id	—	2131252991
demand_package_name	string	N	Promotion package name	—	com.xxx.xx
page	int	N	page, starting with 1	1	1
limit	int	N	limit，max:100	20	20

We recommend using ad_ids instead of demand_package_name, as the latter will return all creatives associated with the package, rather than only retrieving the specific ones you have access to.

Response

Field	Data Type	Description
code	int	200 indicates success. Other values indicate failure.
message	string	Returns "success" if successful. Returns detailed error info if failed.
data	json	Response payload. Returns nested data if successful.
limit	int	Pagination limit.
page	int	Current page number.
total	int	Total number of records.
list	array<object>	List of detailed items.
ad_id	int	Unique identifier for the ad.
ad_name	string	Name of the ad.
offer_id	int64	Unique identifier for the offer.
offer_uuid	string	UUID of the offer.
creative_set_id	int64	Unique identifier for the creative set.
combination_method	int	Creative assembly method: 1 (Programmatic), 2 (Custom).
ad_output	int	Expected output type of the creative set. See [enum - ad_output].
creatives	array<object>	List of creative details.
creative_id	int64	Unique identifier for the creative.
creative_name	string	Name of the creative.
creative_md5	string	MD5 hash of the creative file.
creative_type	string	Type of creative: IMAGE, VIDEO, PLAYABLE.
creative_url	string	URL to access the creative asset.

Response Example

{
  "code": 200,
  "message": "success",
  "data": {
    "limit": 1,
    "page": 1,
    "total": 13,
    "list": [
      {
        "creative_set_id": 1317,
        "ad_id": 2131252991,
        "ad_name": "lixiantest_ss_custom_20240726_111_6699150e1321a_lixiantest_ss_url_20240725",
        "combination_method": 2,
        "ad_output": 212,
        "offer_id": 190511,
        "offer_uuid": "ss_uuid123",
        "creatives": [
          {
            "creative_id": 2705156619,
            "creative_name": "lixiantest_ss_url_20240725",
            "creative_md5": "9c3ee4b0b39a5ee0606aca40ad7f9262",
            "creative_type": "PLAYABLE",
            "creative_url": "https://playable.dspunion.com/playable_test/dsp_zh-cn_98_VFNZYl667_an/dsp_zh-cn_98_VFNZYl667_an.html"
          },
          {
            "creative_id": 2705156616,
            "creative_name": "6699150e1321a.mp4",
            "creative_md5": "05e23f9241f9abb0742f646f8c16da35",
            "creative_type": "VIDEO",
            "creative_url": "http://cdn-adn.rayjump.com/cdn-adn/v2/portal/24/07/19/11/20/6699db7883bd7.mp4"
          }
        ]
      }
    ]
  }
}