API开放平台

TIP

# 开放接口API说明-首页广告接口

# 新增广告

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/advert/v1/addMendianAdvert/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "advertSummary": "你好",
    "advertType": "1",
    "advertCover": "图片",
    "advertContent": "你好",
    "advertSkipUrlType": "4",
    "advertSkipUrlValue": "https://www.baidu.com/",
    "advertCmChooseType": "2",
    "advertState": "1",
    "advertStartTime": "2022-03-01",
    "advertEndTime": "2022-03-31",
    "productId": "商品id",
    "productCode": "商品code",
    "productSourceCode": "商品sourceCode",
    "promotionId": "促销id",
    "posterId": "微海报id",
    "activityId": "抽奖活动id",
    "cmTypesString": "客户类型s",
    "cmDistrictsString": "销售区域s",
    "customerIds": "客户ids",
    "customerCodes": "客户codes",
    "customerSourceCodes": "客户sourceCodes"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
advertSummary VARCHAR(200) 是 广告标题
advertType VARCHAR(32) 是 广告类型，值为1：轮播广告；2：弹窗广告
popType VARCHAR(1) 否 弹窗类型，0 仅首次展示，1 每天首次登录展示，2 每次登录都展示。默认1
advertCover VARCHAR(1000) 是 广告图片
advertContent VARCHAR(4000) 是 正文
advertSkipUrlType VARCHAR(32) 是 跳转地址，值为0：富文本；1：商品详情；2：促销详情；3：微海报；4：第三方地址；5：抽奖活动
advertSkipUrlValue TEXT 否 链接地址
advertCmChooseType VARCHAR (1) 是 发布范围，值为1：销售区域、客户类型；2：指定具体客户；3：全部客户
advertState CHAR(1) 是 发布状态，值为0：未发布(草稿)；1：已发布；2：终止
advertStartTime VARCHAR(32) 是 发布起始日期。格式：yyyy-MM-dd HH:mm
advertEndTime VARCHAR(32) 是 发布截止日期。格式：yyyy-MM-dd HH:mm
promotionType VARCHAR(32) 否 促销类型。跳转地址为促销详情时必传,ZHPROMOTION：组合促销；MZPROMOTION：买赠促销；MINPRICE：特价；FULLDISCOUNT：满折满减
productId VARCHAR(100) 否 商品ID
productCode VARCHAR(100) 否 商品编码CODE
productSourceCode VARCHAR(100) 否 商品第三方ID
promotionId VARCHAR(100) 否 促销ID
posterId VARCHAR(100) 否 微海报ID
activityId VARCHAR(100) 否 抽奖活动ID
cmTypesString VARCHAR(1000) 否 客户类型,范围按客户类型时传值，多值逗号分隔
cmDistrictsString VARCHAR(1000) 否 销售区域,范围按销售区域时传值，多值逗号分隔
customerIds VARCHAR(100) 否 客户ID,指定客户时ID、CODE、第三方ID至少一个传值，多值逗号分隔，客户信息优先级顺序由大到小为sourceCode、id、code
customerCodes VARCHAR(100) 否 客户编码CODE,指定客户时ID、CODE、第三方ID至少一个传值，多值逗号分隔，客户信息优先级顺序由大到小为sourceCode、id、code
customerSourceCodes VARCHAR(100) 否 客户第三方ID,指定客户时ID、CODE、第三方ID至少一个传值，多值逗号分隔，客户信息优先级顺序由大到小为sourceCode、id、code

响应示例：

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}

异常示例：

{
    "msg_id": "X000001",
    "return_code": 1,
    "return_msg": "广告标题不能为空！"
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

← 企业头条接口 →