wechatpay-go/docs/goldplan/MerchantsApi.md

goldplan/MerchantsApi

所有URI均基于微信支付 API 地址： https://api.mch.weixin.qq.com

方法名	HTTP 请求	描述
CloseAdvertisingShow	Post /v3/goldplan/merchants/close-advertising-show	关闭广告展示
OpenAdvertisingShow	Patch /v3/goldplan/merchants/open-advertising-show	开通广告展示
SetAdvertisingIndustryFilter	Post /v3/goldplan/merchants/set-advertising-industry-filter	同业过滤标签管理

CloseAdvertisingShow

void CloseAdvertisingShow(CloseAdvertisingShowRequest)

关闭广告展示

调用示例

package main

import (
	"context"
	"log"

	"git.nanodreamtech.com/sg/wechatpay-go/core"
	"git.nanodreamtech.com/sg/wechatpay-go/services/goldplan"
	"git.nanodreamtech.com/sg/wechatpay-go/utils"
)

func main() {
	var (
		mchID                      string = "190000****"                               // 商户号
		mchCertificateSerialNumber string = "3775************************************" // 商户证书序列号
		mchAPIv3Key                string = "2ab9****************************"         // 商户APIv3密钥
	)

	// 使用 utils 提供的函数从本地文件中加载商户私钥，商户私钥会用来生成请求的签名
	mchPrivateKey, err := utils.LoadPrivateKeyWithPath("/path/to/merchant/apiclient_key.pem")
	if err != nil {
		log.Printf("load merchant private key error:%s", err)
		return
	}

	ctx := context.Background()
	// 使用商户私钥等初始化 client，并使它具有自动定时获取微信支付平台证书的能力
	opts := []core.ClientOption{
		option.WithWechatPayAutoAuthCipher(mchID, mchCertificateSerialNumber, mchPrivateKey, mchAPIv3Key),
	}
	client, err := core.NewClient(ctx, opts...)
	if err != nil {
		log.Printf("new wechat pay client err:%s", err)
		return
	}

	svc := goldplan.MerchantsApiService{Client: client}
	result, err := svc.CloseAdvertisingShow(ctx,
		goldplan.CloseAdvertisingShowRequest{
			SubMchid: core.String("1900000109"),
		},
	)

	if err != nil {
		// 处理错误
		log.Printf("call CloseAdvertisingShow err:%s", err)
	} else {
		// 处理返回结果
		log.Printf("status=%d", result.Response.StatusCode)
	}
}

参数列表

参数名	参数类型	参数描述
ctx	context.Context	Golang 上下文，可用于日志、请求取消、请求跟踪等功能
req	CloseAdvertisingShowRequest	API goldplan 所定义的本接口需要的所有参数，包括Path/Query/Body 3类参数

返回结果

Name	Type	Description
result	*core.APIResult	本次 API 访问的请求与应答信息
err	error	本次 API 访问中发生的错误，当且仅当 API 失败时存在

[返回顶部] [返回接口列表] [返回类型列表] [返回服务README]

OpenAdvertisingShow

void OpenAdvertisingShow(OpenAdvertisingShowRequest)

开通广告展示

调用示例

package main

import (
	"context"
	"log"

	"git.nanodreamtech.com/sg/wechatpay-go/core"
	"git.nanodreamtech.com/sg/wechatpay-go/services/goldplan"
	"git.nanodreamtech.com/sg/wechatpay-go/utils"
)

func main() {
	var (
		mchID                      string = "190000****"                               // 商户号
		mchCertificateSerialNumber string = "3775************************************" // 商户证书序列号
		mchAPIv3Key                string = "2ab9****************************"         // 商户APIv3密钥
	)

	// 使用 utils 提供的函数从本地文件中加载商户私钥，商户私钥会用来生成请求的签名
	mchPrivateKey, err := utils.LoadPrivateKeyWithPath("/path/to/merchant/apiclient_key.pem")
	if err != nil {
		log.Printf("load merchant private key error:%s", err)
		return
	}

	ctx := context.Background()
	// 使用商户私钥等初始化 client，并使它具有自动定时获取微信支付平台证书的能力
	opts := []core.ClientOption{
		option.WithWechatPayAutoAuthCipher(mchID, mchCertificateSerialNumber, mchPrivateKey, mchAPIv3Key),
	}
	client, err := core.NewClient(ctx, opts...)
	if err != nil {
		log.Printf("new wechat pay client err:%s", err)
		return
	}

	svc := goldplan.MerchantsApiService{Client: client}
	result, err := svc.OpenAdvertisingShow(ctx,
		goldplan.OpenAdvertisingShowRequest{
			SubMchid:                   core.String("1900000109"),
			AdvertisingIndustryFilters: []goldplan.IndustryType{goldplan.INDUSTRYTYPE_E_COMMERCE},
		},
	)

	if err != nil {
		// 处理错误
		log.Printf("call OpenAdvertisingShow err:%s", err)
	} else {
		// 处理返回结果
		log.Printf("status=%d", result.Response.StatusCode)
	}
}

参数列表

参数名	参数类型	参数描述
ctx	context.Context	Golang 上下文，可用于日志、请求取消、请求跟踪等功能
req	OpenAdvertisingShowRequest	API goldplan 所定义的本接口需要的所有参数，包括Path/Query/Body 3类参数

返回结果

Name	Type	Description
result	*core.APIResult	本次 API 访问的请求与应答信息
err	error	本次 API 访问中发生的错误，当且仅当 API 失败时存在

[返回顶部] [返回接口列表] [返回类型列表] [返回服务README]

SetAdvertisingIndustryFilter

void SetAdvertisingIndustryFilter(SetAdvertisingIndustryFilterRequest)

同业过滤标签管理

调用示例

package main

import (
	"context"
	"log"

	"git.nanodreamtech.com/sg/wechatpay-go/core"
	"git.nanodreamtech.com/sg/wechatpay-go/services/goldplan"
	"git.nanodreamtech.com/sg/wechatpay-go/utils"
)

func main() {
	var (
		mchID                      string = "190000****"                               // 商户号
		mchCertificateSerialNumber string = "3775************************************" // 商户证书序列号
		mchAPIv3Key                string = "2ab9****************************"         // 商户APIv3密钥
	)

	// 使用 utils 提供的函数从本地文件中加载商户私钥，商户私钥会用来生成请求的签名
	mchPrivateKey, err := utils.LoadPrivateKeyWithPath("/path/to/merchant/apiclient_key.pem")
	if err != nil {
		log.Printf("load merchant private key error:%s", err)
		return
	}

	ctx := context.Background()
	// 使用商户私钥等初始化 client，并使它具有自动定时获取微信支付平台证书的能力
	opts := []core.ClientOption{
		option.WithWechatPayAutoAuthCipher(mchID, mchCertificateSerialNumber, mchPrivateKey, mchAPIv3Key),
	}
	client, err := core.NewClient(ctx, opts...)
	if err != nil {
		log.Printf("new wechat pay client err:%s", err)
		return
	}

	svc := goldplan.MerchantsApiService{Client: client}
	result, err := svc.SetAdvertisingIndustryFilter(ctx,
		goldplan.SetAdvertisingIndustryFilterRequest{
			SubMchid:                   core.String("1900000109"),
			AdvertisingIndustryFilters: []goldplan.IndustryType{goldplan.INDUSTRYTYPE_E_COMMERCE},
		},
	)

	if err != nil {
		// 处理错误
		log.Printf("call SetAdvertisingIndustryFilter err:%s", err)
	} else {
		// 处理返回结果
		log.Printf("status=%d", result.Response.StatusCode)
	}
}

参数列表

参数名	参数类型	参数描述
ctx	context.Context	Golang 上下文，可用于日志、请求取消、请求跟踪等功能
req	SetAdvertisingIndustryFilterRequest	API goldplan 所定义的本接口需要的所有参数，包括Path/Query/Body 3类参数

返回结果

Name	Type	Description
result	*core.APIResult	本次 API 访问的请求与应答信息
err	error	本次 API 访问中发生的错误，当且仅当 API 失败时存在

[返回顶部] [返回接口列表] [返回类型列表] [返回服务README]