推广位管理接口

接口名称 说明
添加推广位 支持联盟开发者通过接口添加推广位
删除推广位 支持联盟开发者通过接口删除推广位
编辑推广位 支持联盟开发者通过接口编辑推广位名称
获取推广位列表 支持联盟开发者通过接口获取推广位列表

1.添加推广位

接口说明

支持联盟开发者调用接口添加推广位

请求地址

POST https://api.weixin.qq.com/union/promoter/promotion/add?access_token=ACCESS_TOKEN

请求参数

属性 类型 默认值 必填 说明
access_token string 接口调用凭证
promotionSourceName string 推广位名称(最长20个字,名称不可重复)

POST示例

{
  "promotionSourceName": "推广位名称"
}

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
pid string 推广位ID,PID

返回示例

{
    "errcode": 0,
    "errmsg": "ok",
    "pid": "oUkIc71zinc2mtlfC7K-NfGJxxNE_328751529"
}

错误码

说明
14005 推广位数量达到上限
14007 推广位名称重复

2.删除推广位

接口说明

删除某个推广位

请求地址

POST https://api.weixin.qq.com/union/promoter/promotion/del?access_token=ACCESS_TOKEN

请求参数

属性 类型 默认值 必填 说明
access_token string 接口调用凭证
promotionSourcePid string 推广位PID
promotionSourceName string 推广位名称

POST示例

{
  "promotionSourcePid": "oUnIc49z",
  "promotionSourceName": "推广位名称"
}

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errcode number 错误码
errmsg string 错误信息

3.编辑推广位

接口说明

修改指定的推广位名称

请求地址

POST https://api.weixin.qq.com/union/promoter/promotion/upd?access_token=ACCESS_TOKEN

请求参数

属性 类型 默认值 必填 说明
access_token string 接口调用凭证
previousPromotionInfo Object
previousPromotionInfo.promotionSourcePid string 要修改的推广位PID
previousPromotionInfo.promotionSourceName string 修改前名称
promotionInfo Object
promotionInfo.promotionSourceName string 修改后名称

POST示例

{
  "previousPromotionInfo": {
    "promotionSourcePid": "oUnIc49z",
    "promotionSourceName": "delete"
  },
  "promotionInfo": {
    "promotionSourceName": "upd after22"
  }
}

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errcode number 错误码
errmsg string 错误信息

4.获取推广位列表

接口说明

获取推广位列表

请求地址

GET https://api.weixin.qq.com/union/promoter/promotion/list?access_token=ACCESS_TOKEN

请求参数

属性 类型 默认值 必填 说明
access_token string 接口调用凭证
start number 0 偏移
limit number 20 每页条数

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
total number 推广位总数
promotionMaxCnt number 允许创建的推广位最大数量
promotionSourceList Array.<Object> 推广位数据

promotionSourceList 的结构

属性 类型 说明
promotionSourceName string 推广位名称
promotionSourcePid string 推广位ID,PID

返回示例

{
    "errcode": 0,
    "errmsg": "",
    "promotionSourceList": [
        {
            "promotionSourceName": "23444444444",
            "promotionSourcePid": "oqt8u5MV-nX9iyrzARrq-QFsxI28_648499549",
            "status": "1",
            "pidId": "3457"
        },
        {
            "promotionSourceName": "123",
            "promotionSourcePid": "oqt8u5MV-nX9iyrzARrq-QFsxI28_1515204302",
            "status": "1",
            "pidId": "3452"
        }
    ],
    "total": 91,
    "promotionMaxCnt": 100
}