开通广告展示

更新时间:2024.12.25

此接口为特约商户的点金计划页面开通广告展示功能,可同时配置同业过滤标签,防止特约商户支付后出现同行业的广告内容。最多传入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
1package com.wechat.pay.java.service.goldplan;
2import com.wechat.pay.java.core.Config;
3import com.wechat.pay.java.core.RSAAutoCertificateConfig;
4import com.wechat.pay.java.service.goldplan.model.IndustryType;
5import com.wechat.pay.java.service.goldplan.model.OpenAdvertisingShowRequest;
6import java.util.ArrayList;
7import java.util.List;
8public class OpenAdvertisingShow { /** 商户号 */
9 public static String merchantId = "190000****"; /** 商户API私钥路径 */
10 public static String privateKeyPath =
11 "/Users/yourname/your/path/apiclient_key.pem"; /** 商户证书序列号 */
12 public static String merchantSerialNumber =
13 "5157F09EFDC096DE15EBE81A47057A72********"; /** 商户APIV3密钥 */
14 public static String apiV3Key = "...";
15 public static GoldPlanService service;
16 public static void main(String[] args) {
17 Config config = new RSAAutoCertificateConfig.Builder()
18 .merchantId(merchantId)
19 .privateKeyFromPath(privateKeyPath)
20 .merchantSerialNumber(merchantSerialNumber)
21 .apiV3Key(apiV3Key)
22 .build();
23 service = new GoldPlanService.Builder().config(config).build();
24 OpenAdvertisingShowRequest openAdvertisingShowRequest =
25 new OpenAdvertisingShowRequest();
26 openAdvertisingShowRequest.setSubMchid("1900000109");
27 {
28 List<IndustryType> advertisingIndustryFiltersList = new ArrayList<>();
29 advertisingIndustryFiltersList.add(IndustryType.E_COMMERCE);
30 openAdvertisingShowRequest.setAdvertisingIndustryFilters(
31 advertisingIndustryFiltersList);
32 }
33 service.openAdvertisingShow(openAdvertisingShowRequest);
34 }
35}
1package main
2
3import (
4 "context"
5 "log"
6
7 "github.com/wechatpay-apiv3/wechatpay-go/core"
8 "github.com/wechatpay-apiv3/wechatpay-go/services/goldplan"
9 "github.com/wechatpay-apiv3/wechatpay-go/utils"
10)
11
12func main() {
13 var (
14 mchID string = "190000****" // 商户号
15 mchCertificateSerialNumber string = "3775************************************" // 商户证书序列号
16 mchAPIv3Key string = "2ab9****************************" // 商户APIv3密钥
17 )
18
19 // 使用 utils 提供的函数从本地文件中加载商户私钥,商户私钥会用来生成请求的签名
20 mchPrivateKey, err := utils.LoadPrivateKeyWithPath("/path/to/merchant/apiclient_key.pem")
21 if err != nil {
22 log.Printf("load merchant private key error:%s", err)
23 return
24 }
25
26 ctx := context.Background()
27 // 使用商户私钥等初始化 client,并使它具有自动定时获取微信支付平台证书的能力
28 opts := []core.ClientOption{
29 option.WithWechatPayAutoAuthCipher(mchID, mchCertificateSerialNumber, mchPrivateKey, mchAPIv3Key),
30 }
31 client, err := core.NewClient(ctx, opts...)
32 if err != nil {
33 log.Printf("new wechat pay client err:%s", err)
34 return
35 }
36
37 svc := goldplan.MerchantsApiService{Client: client}
38 result, err := svc.OpenAdvertisingShow(ctx,
39 goldplan.OpenAdvertisingShowRequest{
40 SubMchid: core.String("1900000109"),
41 AdvertisingIndustryFilters: []goldplan.IndustryType{goldplan.INDUSTRYTYPE_E_COMMERCE},
42 },
43 )
44
45 if err != nil {
46 // 处理错误
47 log.Printf("call OpenAdvertisingShow err:%s", err)
48 } else {
49 // 处理返回结果
50 log.Printf("status=%d", result.Response.StatusCode)
51 }
52}
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 }'

# 应答参数

无应答包体

应答示例

204 No Content
1无应答包体

# 错误码

# 公共错误码

状态码 错误码 描述 解决方案
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开头错误码都为系统问题,请使用相同参数稍后重新调用
反馈
咨询
目录

微信支付文档中心已升级,你当前所查看的是旧文档中心的内容,旧文档中心将于 2025年 3 月 31日 下线,请移步 [新文档中心] 查看相应的内容