开通广告展示
更新时间:2024.11.18此接口为特约商户的点金计划页面开通广告展示功能,可同时配置同业过滤标签,防止特约商户支付后出现同行业的广告内容。最多传入3个同业过滤标签值
接口说明
支持商户:【普通服务商】 【渠道商】
请求方式:【PATCH】/v3/goldplan/merchants/open-advertising-show
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Content-Type 必填 string
请设置为application/json
body 包体参数
sub_mchid 必填 string(32)
【特约商户号】需要开通广告展示的特约商户号,由微信支付生成并下发。
advertising_industry_filters 选填 array[IndustryType]
【同业过滤标签值】特约商户同业过滤的同业过滤标签值。如已设置同业过滤标签,再次请求传入,视为新增,将覆盖原有同业标签配置
可选取值:
E_COMMERCE
: 综合电商平台
LOVE_MARRIAGE
: 婚恋
POTOGRAPHY
: 摄影摄像机构及服务
EDUCATION
: 教育
FINANCE
: 金融
TOURISM
: 旅游
SKINCARE
: 护肤彩妆
FOOD
: 食品
SPORT
: 运动户外
JEWELRY_WATCH
: 珠宝钟表
HEALTHCARE
: 医疗健康
BUSSINESS
: 商务服务
PARENTING
: 亲子
CATERING
: 餐饮美食
RETAIL
: 零售百货
SERVICES
: 生活服务
LAW
: 法律服务
ESTATE
: 房地产
TRANSPORTATION
: 交通运输
ENERGY_SAVING
: 节能环保
SECURITY
: 安全安保
BUILDING_MATERIAL
: 家居装修建材
COMMUNICATION
: 通讯及IT服务
MERCHANDISE
: 日用百货
ASSOCIATION
: 机构协会
COMMUNITY
: 网络资讯及社区
ONLINE_AVR
: 在线视听与阅读
WE_MEDIA
: 自媒体
CAR
: 汽车
SOFTWARE
: 软件工具
GAME
: 游戏
CLOTHING
: 服饰鞋帽箱包
INDUSTY
: 工业工程
AGRICULTURE
: 农林牧渔
PUBLISHING_MEDIA
: 出版传媒
HOME_DIGITAL
: 数码家电
请求示例
PATCH
1curl -X PATCH \ 2 https://api.mch.weixin.qq.com/v3/goldplan/merchants/open-advertising-show \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "sub_mchid" : "1900000109", 8 "advertising_industry_filters" : [ 9 "E_COMMERCE" 10 ] 11 }' 12
需配合微信支付工具库 WXPayUtility 使用,请参考Java
1package com.java.demo; 2 3import com.java.utils.WXPayUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/v3/partner/4014985777 4 5import com.google.gson.annotations.SerializedName; 6import com.google.gson.annotations.Expose; 7import okhttp3.MediaType; 8import okhttp3.OkHttpClient; 9import okhttp3.Request; 10import okhttp3.RequestBody; 11import okhttp3.Response; 12 13import java.io.IOException; 14import java.io.UncheckedIOException; 15import java.security.PrivateKey; 16import java.security.PublicKey; 17import java.util.ArrayList; 18import java.util.HashMap; 19import java.util.List; 20import java.util.Map; 21 22/** 23 * 开通广告展示 24 */ 25public class OpenAdvertisingShow { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "PATCH"; 28 private static String PATH = "/v3/goldplan/merchants/open-advertising-show"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 OpenAdvertisingShow client = new OpenAdvertisingShow( 33 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 34 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 35 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 OpenAdvertisingShowRequest request = new OpenAdvertisingShowRequest(); 41 request.subMchid = "1900000109"; 42 request.advertisingIndustryFilters = new ArrayList<>(); 43 { 44 request.advertisingIndustryFilters.add(IndustryType.E_COMMERCE); 45 }; 46 try { 47 client.run(request); 48 } catch (WXPayUtility.ApiException e) { 49 // TODO: 请求失败,根据状态码执行不同的逻辑 50 e.printStackTrace(); 51 } 52 } 53 54 public void run(OpenAdvertisingShowRequest request) { 55 String uri = PATH; 56 String reqBody = WXPayUtility.toJson(request); 57 58 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 59 reqBuilder.addHeader("Accept", "application/json"); 60 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 61 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 62 reqBuilder.addHeader("Content-Type", "application/json"); 63 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 64 reqBuilder.method(METHOD, requestBody); 65 Request httpRequest = reqBuilder.build(); 66 67 // 发送HTTP请求 68 OkHttpClient client = new OkHttpClient.Builder().build(); 69 try (Response httpResponse = client.newCall(httpRequest).execute()) { 70 String respBody = WXPayUtility.extractBody(httpResponse); 71 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 72 // 2XX 成功,验证应答签名 73 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 74 httpResponse.headers(), respBody); 75 76 return; 77 } else { 78 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 79 } 80 } catch (IOException e) { 81 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 82 } 83 } 84 85 private final String mchid; 86 private final String certificateSerialNo; 87 private final PrivateKey privateKey; 88 private final String wechatPayPublicKeyId; 89 private final PublicKey wechatPayPublicKey; 90 91 public OpenAdvertisingShow(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 92 this.mchid = mchid; 93 this.certificateSerialNo = certificateSerialNo; 94 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 95 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 96 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 97 } 98 99 public static class OpenAdvertisingShowRequest { 100 @SerializedName("sub_mchid") 101 public String subMchid; 102 103 @SerializedName("advertising_industry_filters") 104 public List<IndustryType> advertisingIndustryFilters; 105 } 106 107 public enum IndustryType { 108 @SerializedName("E_COMMERCE") 109 E_COMMERCE, 110 @SerializedName("LOVE_MARRIAGE") 111 LOVE_MARRIAGE, 112 @SerializedName("POTOGRAPHY") 113 POTOGRAPHY, 114 @SerializedName("EDUCATION") 115 EDUCATION, 116 @SerializedName("FINANCE") 117 FINANCE, 118 @SerializedName("TOURISM") 119 TOURISM, 120 @SerializedName("SKINCARE") 121 SKINCARE, 122 @SerializedName("FOOD") 123 FOOD, 124 @SerializedName("SPORT") 125 SPORT, 126 @SerializedName("JEWELRY_WATCH") 127 JEWELRY_WATCH, 128 @SerializedName("HEALTHCARE") 129 HEALTHCARE, 130 @SerializedName("BUSSINESS") 131 BUSSINESS, 132 @SerializedName("PARENTING") 133 PARENTING, 134 @SerializedName("CATERING") 135 CATERING, 136 @SerializedName("RETAIL") 137 RETAIL, 138 @SerializedName("SERVICES") 139 SERVICES, 140 @SerializedName("LAW") 141 LAW, 142 @SerializedName("ESTATE") 143 ESTATE, 144 @SerializedName("TRANSPORTATION") 145 TRANSPORTATION, 146 @SerializedName("ENERGY_SAVING") 147 ENERGY_SAVING, 148 @SerializedName("SECURITY") 149 SECURITY, 150 @SerializedName("BUILDING_MATERIAL") 151 BUILDING_MATERIAL, 152 @SerializedName("COMMUNICATION") 153 COMMUNICATION, 154 @SerializedName("MERCHANDISE") 155 MERCHANDISE, 156 @SerializedName("ASSOCIATION") 157 ASSOCIATION, 158 @SerializedName("COMMUNITY") 159 COMMUNITY, 160 @SerializedName("ONLINE_AVR") 161 ONLINE_AVR, 162 @SerializedName("WE_MEDIA") 163 WE_MEDIA, 164 @SerializedName("CAR") 165 CAR, 166 @SerializedName("SOFTWARE") 167 SOFTWARE, 168 @SerializedName("GAME") 169 GAME, 170 @SerializedName("CLOTHING") 171 CLOTHING, 172 @SerializedName("INDUSTY") 173 INDUSTY, 174 @SerializedName("AGRICULTURE") 175 AGRICULTURE, 176 @SerializedName("PUBLISHING_MEDIA") 177 PUBLISHING_MEDIA, 178 @SerializedName("HOME_DIGITAL") 179 HOME_DIGITAL 180 } 181 182} 183
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "bytes" 5 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446 6 "encoding/json" 7 "fmt" 8 "net/http" 9 "net/url" 10) 11 12func main() { 13 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 14 config, err := wxpay_utility.CreateMchConfig( 15 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 16 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 17 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 18 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 19 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 20 ) 21 if err != nil { 22 fmt.Println(err) 23 return 24 } 25 26 request := &OpenAdvertisingShowRequest{ 27 SubMchid: wxpay_utility.String("1900000109"), 28 AdvertisingIndustryFilters: []IndustryType{INDUSTRYTYPE_E_COMMERCE}, 29 } 30 31 err = OpenAdvertisingShow(config, request) 32 if err != nil { 33 fmt.Printf("请求失败: %+v\n", err) 34 // TODO: 请求失败,根据状态码执行不同的处理 35 return 36 } 37 38 // TODO: 请求成功,继续业务逻辑 39 fmt.Println("请求成功") 40} 41 42func OpenAdvertisingShow(config *wxpay_utility.MchConfig, request *OpenAdvertisingShowRequest) (err error) { 43 const ( 44 host = "https://api.mch.weixin.qq.com" 45 method = "PATCH" 46 path = "/v3/goldplan/merchants/open-advertising-show" 47 ) 48 49 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 50 if err != nil { 51 return err 52 } 53 reqBody, err := json.Marshal(request) 54 if err != nil { 55 return err 56 } 57 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 58 if err != nil { 59 return err 60 } 61 httpRequest.Header.Set("Accept", "application/json") 62 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 63 httpRequest.Header.Set("Content-Type", "application/json") 64 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 65 if err != nil { 66 return err 67 } 68 httpRequest.Header.Set("Authorization", authorization) 69 70 client := &http.Client{} 71 httpResponse, err := client.Do(httpRequest) 72 if err != nil { 73 return err 74 } 75 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 76 if err != nil { 77 return err 78 } 79 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 80 // 2XX 成功,验证应答签名 81 err = wxpay_utility.ValidateResponse( 82 config.WechatPayPublicKeyId(), 83 config.WechatPayPublicKey(), 84 &httpResponse.Header, 85 respBody, 86 ) 87 if err != nil { 88 return err 89 } 90 return nil 91 } else { 92 return wxpay_utility.NewApiException( 93 httpResponse.StatusCode, 94 httpResponse.Header, 95 respBody, 96 ) 97 } 98} 99 100type OpenAdvertisingShowRequest struct { 101 SubMchid *string `json:"sub_mchid,omitempty"` 102 AdvertisingIndustryFilters []IndustryType `json:"advertising_industry_filters,omitempty"` 103} 104 105type IndustryType string 106 107func (e IndustryType) Ptr() *IndustryType { 108 return &e 109} 110 111const ( 112 INDUSTRYTYPE_E_COMMERCE IndustryType = "E_COMMERCE" 113 INDUSTRYTYPE_LOVE_MARRIAGE IndustryType = "LOVE_MARRIAGE" 114 INDUSTRYTYPE_POTOGRAPHY IndustryType = "POTOGRAPHY" 115 INDUSTRYTYPE_EDUCATION IndustryType = "EDUCATION" 116 INDUSTRYTYPE_FINANCE IndustryType = "FINANCE" 117 INDUSTRYTYPE_TOURISM IndustryType = "TOURISM" 118 INDUSTRYTYPE_SKINCARE IndustryType = "SKINCARE" 119 INDUSTRYTYPE_FOOD IndustryType = "FOOD" 120 INDUSTRYTYPE_SPORT IndustryType = "SPORT" 121 INDUSTRYTYPE_JEWELRY_WATCH IndustryType = "JEWELRY_WATCH" 122 INDUSTRYTYPE_HEALTHCARE IndustryType = "HEALTHCARE" 123 INDUSTRYTYPE_BUSSINESS IndustryType = "BUSSINESS" 124 INDUSTRYTYPE_PARENTING IndustryType = "PARENTING" 125 INDUSTRYTYPE_CATERING IndustryType = "CATERING" 126 INDUSTRYTYPE_RETAIL IndustryType = "RETAIL" 127 INDUSTRYTYPE_SERVICES IndustryType = "SERVICES" 128 INDUSTRYTYPE_LAW IndustryType = "LAW" 129 INDUSTRYTYPE_ESTATE IndustryType = "ESTATE" 130 INDUSTRYTYPE_TRANSPORTATION IndustryType = "TRANSPORTATION" 131 INDUSTRYTYPE_ENERGY_SAVING IndustryType = "ENERGY_SAVING" 132 INDUSTRYTYPE_SECURITY IndustryType = "SECURITY" 133 INDUSTRYTYPE_BUILDING_MATERIAL IndustryType = "BUILDING_MATERIAL" 134 INDUSTRYTYPE_COMMUNICATION IndustryType = "COMMUNICATION" 135 INDUSTRYTYPE_MERCHANDISE IndustryType = "MERCHANDISE" 136 INDUSTRYTYPE_ASSOCIATION IndustryType = "ASSOCIATION" 137 INDUSTRYTYPE_COMMUNITY IndustryType = "COMMUNITY" 138 INDUSTRYTYPE_ONLINE_AVR IndustryType = "ONLINE_AVR" 139 INDUSTRYTYPE_WE_MEDIA IndustryType = "WE_MEDIA" 140 INDUSTRYTYPE_CAR IndustryType = "CAR" 141 INDUSTRYTYPE_SOFTWARE IndustryType = "SOFTWARE" 142 INDUSTRYTYPE_GAME IndustryType = "GAME" 143 INDUSTRYTYPE_CLOTHING IndustryType = "CLOTHING" 144 INDUSTRYTYPE_INDUSTY IndustryType = "INDUSTY" 145 INDUSTRYTYPE_AGRICULTURE IndustryType = "AGRICULTURE" 146 INDUSTRYTYPE_PUBLISHING_MEDIA IndustryType = "PUBLISHING_MEDIA" 147 INDUSTRYTYPE_HOME_DIGITAL IndustryType = "HOME_DIGITAL" 148) 149
应答参数
无应答包体
应答示例
204 No Content
1'无应答包体' 2
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | INVALID_REQUEST | 调用方非普通服务商/渠道商 | 只有普通服务商和渠道商才能调用该接口 |
400 | INVALID_REQUEST | 服务商未开通点金计划 | 请在服务商平台先行开通点金计划后再试 |
400 | INVALID_REQUEST | 服务商被处罚中 | 请在服务商平台处理处罚后再试 |
400 | INVALID_REQUEST | 特约商户未开通点金计划 | 该商户暂未开通点金计划,请开通后配置 |
400 | INVALID_REQUEST | 特约商户被处罚中 | 请让特约商户在商户平台处理处罚后再试 |
400 | INVALID_REQUEST | 操作失败 | 操作失败,请稍后重试 |
400 | INVALID_REQUEST | 特约商户信息逻辑错误 | 特约商户号不存在或不是当前服务商的特约商户 |
400 | INVALID_REQUEST | 命中频率限制 | 接口调用速度过快,请降低频率调用该接口 |
400 | INVALID_REQUEST | 商户类型不合法 | 只有普通服务商和普通渠道商才能调用该接口 |
400 | INVALID_REQUEST | 商户关系错误 | 特约商户号不存在或不是当前服务商的特约商户 |
400 | INVALID_REQUEST | 服务商未开通点金计划 | 服务商未开通点金计划,请开通服务商后重试 |
400 | MCH_NOT_EXISTS | 特约商户号不存在 | 特约商户号不存在,请确认特约商户号准确性 |
500 | SYSTEM ERROR | 系统繁忙,请稍后重试 | 5开头错误码都为系统问题,请使用相同参数稍后重新调用 |