Ad & Creative Mapping API

1.Interface Instructions

Queries are only supported for ads created using the creative library and already have cost
Channels that do not currently support data query: Unity, Applovin, Vungle, Mintegral, ironSource
Update frequency: 1 hour
Limit the number of parallel queries to 5

2.Interface Path

POST https://xmp-open.nativex.com/v1/media/material_mapping/list

3.Request Parameters

Common request parameters: please refer to Open API Protocol

Parameter	Type	Required	Instruction
start_date	string	Y	Create start time, YYYY-MM-DD, The longest span does not exceed 30 days
end_date	string	Y	Create end time, YYYY-MM-DD
media	array	N	View Media Enumeration Value
page	int	N	current page, the default is 1
page_size	int	N	page size, the default is 200, 1~1000 is available

4.Request Example

{
  "client_id": "xxx",
  "timestamp": 1608776690,
  "sign": "05d481dc241a7a1daa5b2a7fa2b51dc5",
  "start_date":"2021-12-01", #required
  "end_date":"2021-12-27",  #required
  "media":["google"]
}

5.Return Parameters

First-level Parameter	Second-level Parameter	Type	Instruction
code	–	int	error code
msg	–	string	message
data	–	array	returned interface content
data.list	–	array	returned interface content
–	media	string	media
–	account_id	string	account_id
–	account_name	string	account_name
–	campaign_id	string	campaign_id
–	campaign_name	string	campaign_name
–	adset_id	string	adset_id
–	adset_name	string	adset_name
–	ad_id	string	ad_id
–	ad_name	string	ad_name
–	material_name	string	creative name
–	md5_file_id	string	creative md5
–	user_material_id	int	creative local_id
–	material_type	string	creative type（image，video，other）
–	material_width	int	creative width
–	material_height	int	creative height
–	material_shape	string	creative shape
–	designer_name	array	name of designer
–	customer_name	array	name of creative people
data.page	–	int	page
–	page	int	current page
–	page_size	int	page size
–	next_page	int	1 for there is a next page, 0 for there isn’t a next page

6.Return Example

{
    "code": 0,
    "msg": "success",
    "data": {
        "data": [
            {
                "media": "google",
                "account_id": "1710773817",
                "account_name": "兄弟一起冲-001",
                "campaign_id": "17179370156",
                "campaign_name": "test-1201-2",
                "adset_id": "1720320214546445",
                "adset_name": "test-1201-2_16043",
                "ad_id": "1720353067540507",
                "ad_name": "我们保证：你绝不会感到无聊！你来试试！",
                "material_name": "客户素材-紫",
                "md5_file_id": "05ee06e1846ce66e6de052dfd8ecb560",
                "user_material_id": 442143,
                "material_type": "video",
                "material_width": 1080,
                "material_height": 1920,
                "material_shape": "竖版",
                "designer_name": [],
                "customer_name": []
            }
        ],
        "page": {
            "page": 1,
            "page_size": 100,
            "next_page": 1 
        }
    }
}

Creative Report API

User Management API

Last modified: 2024-12-12Powered by

Outline