Skip to main content

Creative

Auth: Brand API authentication

creative/list

KeyDescriptionRequiredType
statusStatusNoArray
privacyPermissionNoArray
keywordKeywordNostring
start_timeStart TimeNostring
end_timeEnd TimeNostring
typeTypeYesstring
page_numPage NumberNostring
page_sizePage SizeNostring

Request:

{
"type": "IMAGE",
"status": ["Active"],
"privacy": ["PUBLIC"],
"start_time": "1681282362",
"end_time": "1683874362",
"page_num": "1",
"page_size": "10"
}

creative/create

KeyDescriptionRequiredType
typeTypeNostring
linkLink (Required when type == TEXT)Nostring
contentContent (Required when type == TEXT)Nostring
imagesImages (Required when type == IMAGE)NoArray
alternateAlternate TextNostring
categoryCategoryNostring
start_timeStart TimeYesstring
end_timeEnd TimeYesstring
privacyPrivacyNostring
site_idsSite ids (Required when privacy == PRIVATE)NoArray
titleTitleNostring
highlighHigh lightNoArray

Request:

{
"title": "Summer banner",
"privacy": "PUBLIC",
"start_time": "1681282362",
"end_time": "1683874362",
"type": "TEXT",
"link": "https://example.com/sale",
"content": "20% off this week",
"alternate": "Summer sale",
"category": "Promotion",
"highligh": []
}

Response:

{ "code": 0, "data": [132508], "msg": "success" }

creative/modify

KeyDescriptionRequiredType
alternateAlternate TextNostring
categoryCategoryNostring
idIDYesstring
start_timeStart TimeNostring
end_timeEnd TimeNostring
privacyPrivacyNostring
typeTypeNostring
linkLink (Required when type == TEXT)Nostring
contentContent (Required when type == TEXT)Nostring
titleTitleNostring

Request:

{
"id": "132505",
"title": "Updated title",
"privacy": "PUBLIC",
"alternate": "Updated alt",
"category": "Promotion"
}