Documentation
¶
Overview ¶
Package wechat 微信小程序/小游戏管理
Index ¶
- type Anchor
- type AppletCreateRequest
- type AppletCreateResponse
- type AppletListFilter
- type AppletListRequest
- type AppletListResponse
- type AppletListResult
- type AppletUpdateRequest
- type AppletUpdateResponse
- type AppletUpdateResult
- type GameCreateRequest
- type GameCreateResponse
- type GameListFilter
- type GameListRequest
- type GameListResponse
- type GameListResult
- type ListTimeRange
- type WechatApplet
- type WechatGame
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Anchor ¶ added in v1.17.3
type Anchor struct { // IconImageURL 小游戏icon图片的url地址,图片尺寸60*60px,大小不超2MB IconImageURL string `json:"icon_image_url,omitempty"` // HeaderImageURL 顶部头图的url地址,大小不超过5MB的图片,推荐尺寸2:1 HeaderImageURL string `json:"header_image_url,omitempty"` // Labels 小游戏标签,每个标签长度不超过6,最多支持6个标签 Labels []string `json:"labels,omitempty"` // GuideText 引导文案,最大长度不超过14 GuideText string `json:"guide_text,omitempty"` // ImagesVerticalURL 小游戏竖图的url地址,要求尺寸必须为3:5,否则报错。 // 仅支持竖图和横图择其一类型上传,若同时上传两种类型的图片则报错 // 小游戏横图或竖图上传最少3张,最多8张,大小不超过5MB ImagesVerticalURL []string `json:"images_vertical_url,omitempty"` // ImagesHorizontalURL 小游戏竖图的url地址,要求尺寸必须为3:5,否则报错。 // 仅支持竖图和横图择其一类型上传,若同时上传两种类型的图片则报错 // 小游戏横图或竖图上传最少3张,最多8张,大小不超过5MB ImagesHorizontalURL []string `json:"images_horizontal_url,omitempty"` // Introduction 小游戏简介,最大长度不超过45 Introduction string `json:"introduction,omitempty"` }
Anchor 锚点组件信息
type AppletCreateRequest ¶ added in v1.17.3
type AppletCreateRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // Name 小程序名称, 须与小程序实际名称保持一致,最大长度不超过50 Name string `json:"name,omitempty"` // UserName 小程序原始ID,获取方式:小程序后台>设置>基本设置>账号信息>原始ID,例如“gh_”,最大长度不超过20 UserName string `json:"user_name,omitempty"` // Path 小程序路径参数,如有跳转指定页面或自定义参数监测广告效果数据诉求,需填写。获取方式:登录关联的公众号后台>素材管理>新建图文素材>小程序>选择小程序>获取更多路径 Path string `json:"path,omitempty"` // RemarkMessage 资产备注信息,最大长度不超过15 RemarkMessage string `json:"remark_message,omitempty"` // IconImageURL 小程序icon图片的url,尺寸60*60px,大小不超2MB IconImageURL string `json:"icon_image_url,omitempty"` // HeadImageURL 顶部头图的url,大小不超过5MB的图片,推荐尺寸2:1 HeadImageURL string `json:"head_image_url,omitempty"` // Labels 小程序标签,每个标签长度不超过6,最多支持6个标签 Labels []string `json:"labels,omitempty"` // GuideText 引导文案,最大长度不超过14 GuideText string `json:"guide_text,omitempty"` // ImagesVerticalURL 小程序竖图的url地址,要求尺寸必须为3:5,否则报错。 // 仅支持竖图和横图择其一类型上传,若同时上传两种类型的图片则报错 // 小程序横图或竖图上传最少3张,最多8张,大小不超过5MB ImagesVerticalURL []string `json:"images_vertical_url,omitempty"` // ImagesHorizontalURL 小程序竖图的url地址,要求尺寸必须为3:5,否则报错。 // 仅支持竖图和横图择其一类型上传,若同时上传两种类型的图片则报错 // 小程序横图或竖图上传最少3张,最多8张,大小不超过5MB ImagesHorizontalURL []string `json:"images_horizontal_url,omitempty"` // Introduction 小程序简介,最大长度不超过50 Introduction string `json:"introduction,omitempty"` }
AppletCreateRequest 创建微信小程序 API Request
func (AppletCreateRequest) Encode ¶ added in v1.17.3
func (r AppletCreateRequest) Encode() []byte
Encode implements PostRequest interface
type AppletCreateResponse ¶ added in v1.17.3
type AppletCreateResponse struct { model.BaseResponse Data struct { Data struct { // InstanceID 微信小程序资产ID InstanceID uint64 `json:"instance_id,omitempty"` } `json:"data,omitempty"` } `json:"data,omitempty"` }
AppletCreateResponse 创建微信小程序 API Response
type AppletListFilter ¶
type AppletListFilter struct { // Name 小程序名称或备注的模糊匹配 Name string `json:"name,omitempty"` // AuditStatus 审核状态 允许值: AUDIT_ACCEPTED 审核通过、AUDITING 审核中、AUDIT_REJECTED 审核不通过。不传表示全部状态 AuditStatus enum.WechatAuditStatus `json:"audit_status,omitempty"` // SearchType 搜索类型 // 允许值: CREATE_ONLY 只查询该账户创建的应用(默认值)、SHARE_ONLY 只查询被共享的应用 SearchType enum.WechatSearchType `json:"search_type,omitempty"` // CreateTime 按创建时间查询的时间范围 CreateTime *ListTimeRange `json:"create_time,omitempty"` }
AppletListFilter 过滤条件
type AppletListRequest ¶
type AppletListRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // Filtering 过滤条件 Filtering *AppletListFilter `json:"filtering,omitempty"` // Page 页码,默认值为1 Page int `json:"page,omitempty"` // PageSize 页面大小,默认值为10,最大值100 PageSize int `json:"page_size,omitempty"` }
AppletListRequest 获取微信小程序列表 API Request
func (AppletListRequest) Encode ¶
func (r AppletListRequest) Encode() string
Encode implement GetRequest interface
type AppletListResponse ¶
type AppletListResponse struct { model.BaseResponse Data *AppletListResult `json:"data,omitempty"` }
AppletListResponse 获取微信小程序列表 API Response
type AppletListResult ¶
type AppletListResult struct { // PageInfo 分页信息 PageInfo *model.PageInfo `json:"page_info,omitempty"` // List 微信小程序列表 List []WechatApplet `json:"list,omitempty"` }
type AppletUpdateRequest ¶ added in v1.17.3
type AppletUpdateRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // InstanceID 小程序资产ID InstanceID uint64 `json:"instance_id,omitempty"` // RemarkMessage 资产备注信息,最大长度不超过15 RemarkMessage string `json:"remark_message,omitempty"` // IconImageURL 小程序icon图片的url,尺寸60*60px,大小不超2MB IconImageURL string `json:"icon_image_url,omitempty"` // HeadImageURL 顶部头图的url,大小不超过5MB的图片,推荐尺寸2:1 HeadImageURL string `json:"head_image_url,omitempty"` // Labels 小程序标签,每个标签长度不超过6,最多支持6个标签 Labels []string `json:"labels,omitempty"` // GuideText 引导文案,最大长度不超过14 GuideText string `json:"guide_text,omitempty"` // ImagesVerticalURL 小程序竖图的url地址,要求尺寸必须为3:5,否则报错。 // 仅支持竖图和横图择其一类型上传,若同时上传两种类型的图片则报错 // 小程序横图或竖图上传最少3张,最多8张,大小不超过5MB ImagesVerticalURL []string `json:"images_vertical_url,omitempty"` // ImagesHorizontalURL 小程序竖图的url地址,要求尺寸必须为3:5,否则报错。 // 仅支持竖图和横图择其一类型上传,若同时上传两种类型的图片则报错 // 小程序横图或竖图上传最少3张,最多8张,大小不超过5MB ImagesHorizontalURL []string `json:"images_horizontal_url,omitempty"` // Introduction 小程序简介,最大长度不超过50 Introduction string `json:"introduction,omitempty"` }
AppletUpdateRequest 更新微信小程序 API Request
func (AppletUpdateRequest) Encode ¶ added in v1.17.3
func (r AppletUpdateRequest) Encode() []byte
Encode implements PostRequest interface
type AppletUpdateResponse ¶ added in v1.17.3
type AppletUpdateResponse struct { model.BaseResponse Data struct { Data *AppletUpdateResult `json:"data,omitempty"` } `json:"data,omitempty"` }
AppletUpdateResponse 更新微信小程序 API Response
type AppletUpdateResult ¶ added in v1.17.3
type GameCreateRequest ¶ added in v1.17.3
type GameCreateRequest struct { // AccountID 账户id,accout_type类型对应账户ID AccountID uint64 `json:"account_id,omitempty"` // AccountType 账户类型 // 允许值:BP 巨量纵横组织、 AD 广告主账号 AccountType enum.AccountType `json:"account_type,omitempty"` // CompanyID 公司主体id,通过【获取纵横组织下所有主体信息】接口获取,应用资质审核环节将以该主体作为拥有应用投放相关权利的主体进行审核,account_type=BP时必填 CompanyID uint64 `json:"company_id,omitempty"` // UserName 小游戏原始ID,获取方式:小程序后台>设置>基本设置>账号信息>原始ID,例如“gh_” UserName string `json:"user_name,omitempty"` // Name 小游戏名称,最大长度不超过50 Name string `json:"name,omitempty"` // Path 小游戏路径参数,如有跳转指定页面或自定义参数监测广告效果数据诉求,需填写。 Path string `json:"path,omitempty"` // QuantificationID 资质id,account_type=AD时,资质id通过【获取投放资质信息】接口查询且必填;account_type=BP时,系统将自动审核投放资质,无需上传资质id // 注:account_type=BP时,请您确保您已经上传了投放资质,且您上传投放资质的广告主账户认证的公司主体,需与资产创建流程中选择的公司主体一致,以用于资质审核。若未提交投放资质,请通过【投放资质提交接口】提交资质,否则资产审核将不通过 QuantificationID string `json:"quantification_id,omitempty"` // AnchorList 锚点组件信息 AnchorList []Anchor `json:"anchor_list,omitempty"` // AntiAddictionURL 防沉迷提示URL,请上传游戏内包含限制游戏时间或建议合理安排游戏相关内容的截图。如防沉迷提示、防沉迷公共、健康系统相关内容。常见形式(包括不限于):进入青少年模式,青少年防沉迷公告弹窗/提示,健康系统提示,强制休息提醒等 AntiAddictionURL string `json:"anti_addiction_url,omitempty"` // ScreenRecordURL 游戏内容视频URL,请上传3分钟的游戏内实际画面操作录屏视频,要求MP4格式文件,最大不超过100M。横版16:9,分辨率不低于960540。竖版9:16,分辨率不低于540960 ScreenRecordURL string `json:"screen_record_url,omitempty"` // RealNameURL 实名认证URL,请上传游戏内包含实名注册功能的截图链接 RealNameURL string `json:"real_name_url,omitempty"` // AgeRemindURL 适龄提醒URL,请上传包含适龄提示图标的游戏界面截图,图标样式需与中国音像数字出版协会官方网站下载保持一致 AgeRemindURL string `json:"age_remind_url,omitempty"` }
GameCreateRequest 创建微信小游戏 API Request
func (GameCreateRequest) Encode ¶ added in v1.17.3
func (r GameCreateRequest) Encode() []byte
Encode implement PostRequest Interface
type GameCreateResponse ¶ added in v1.17.3
type GameCreateResponse struct { model.BaseResponse Data struct { Data *WechatGame `json:"data,omitempty"` } `json:"data,omitempty"` }
GameCreateResponse 创建微信小游戏 API Response
type GameListFilter ¶
type GameListFilter struct { // Name 小程序名称或备注的模糊匹配 Name string `json:"name,omitempty"` // AssetStatus 资产状态 允许值:升级版UPGRADED、 原版ORIGINAL AssetStatus enum.WechatAssetStatus `json:"asset_status,omitempty"` // AuditStatus 审核状态 允许值: AUDIT_ACCEPTED 审核通过、AUDITING 审核中、AUDIT_REJECTED 审核不通过。不传表示全部状态 AuditStatus enum.WechatAuditStatus `json:"audit_status,omitempty"` // SearchType 搜索类型 // 允许值: CREATE_ONLY 只查询该账户创建的应用(默认值)、SHARE_ONLY 只查询被共享的应用 SearchType enum.WechatSearchType `json:"search_type,omitempty"` // CreateTime 按创建时间查询的时间范围 CreateTime *ListTimeRange `json:"create_time,omitempty"` }
GameListFilter 过滤条件
type GameListRequest ¶
type GameListRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // AccountType 账户类型 // 允许值:BP 巨量纵横组织账号、AD 广告主账号 AccountType enum.AccountType `json:"account_type,omitempty"` // Filtering 过滤条件 Filtering *AppletListFilter `json:"filtering,omitempty"` // Page 页码,默认值为1 Page int `json:"page,omitempty"` // PageSize 页面大小,默认值为10,最大值100 PageSize int `json:"page_size,omitempty"` }
GameListRequest 获取微信小游戏列表 API Request
func (GameListRequest) Encode ¶
func (r GameListRequest) Encode() string
Encode implement GetRequest interface
type GameListResponse ¶
type GameListResponse struct { model.BaseResponse Data *GameListResult `json:"data,omitempty"` }
GameListResponse 获取微信小游戏列表 API Response
type GameListResult ¶
type GameListResult struct { // PageInfo 分页信息 PageInfo *model.PageInfo `json:"page_info,omitempty"` // List 微信小游戏列表 List []WechatGame `json:"list,omitempty"` }
type ListTimeRange ¶
type ListTimeRange struct { // StartTime 创建起始时间,格式:%Y-%m-%d StartTime string `json:"start_time,omitempty"` // EndTime 创建结束时间,格式:%Y-%m-%d EndTime string `json:"end_time,omitempty"` }
ListTimeRange 按创建时间查询的时间范围
type WechatApplet ¶
type WechatApplet struct { // Name 小程序名称 Name string `json:"name,omitempty"` // UserName 小程序原始ID UserName string `json:"user_name,omitempty"` // InstanceID 小程序资产ID InstanceID uint64 `json:"instance_id,omitempty"` // Path 小程序路径 Path string `json:"path,omitempty"` // RemarkMessage 资产备注信息,最大长度不超过15 RemarkMessage string `json:"remark_message,omitempty"` // IconImageURL 小程序icon图片的url IconImageURL string `json:"icon_image_url,omitempty"` // HeaderImageURL 顶部头图的url HeaderImageURL string `json:"header_image_url,omitempty"` // Labels 小程序标签 Labels []string `json:"labels,omitempty"` // GuideText 引导文案 GuideText string `json:"guide_text,omitempty"` // ImagesVerticalURL 小程序竖图的url ImagesVerticalURL []string `json:"images_vertical_url,omitempty"` // ImagesHorizontalURL 小程序横图的url ImagesHorizontalURL []string `json:"images_horizontal_url,omitempty"` // Introduction 小程序简介 Introduction string `json:"introduction,omitempty"` // AuditStatus 审核状态: // AUDIT_ACCEPTED 审核成功 // AUDITING 审核中 // AUDIT_REJECTED 审核失败 AuditStatus enum.WechatAuditStatus `json:"audit_status,omitempty"` // Reason 审核拒绝原因 Reason string `json:"reason,omitempty"` // AdvertiserID 所属广告主账户ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // CreateTime 创建时间 CreateTime string `json:"create_time,omitempty"` // ModifyTIme 修改时间 ModifyTime string `json:"modify_time,omitempty"` }
WechatApplet 微信小程序
type WechatGame ¶
type WechatGame struct { // Name 小程序名称 Name string `json:"name,omitempty"` // UserName 小程序原始ID UserName string `json:"user_name,omitempty"` // InstanceID 小程序资产ID InstanceID uint64 `json:"instance_id,omitempty"` // Path 小程序路径 Path string `json:"path,omitempty"` // AuditStatus 审核状态: // AUDIT_ACCEPTED 审核成功 // AUDITING 审核中 // AUDIT_REJECTED 审核失败 AuditStatus enum.WechatAuditStatus `json:"audit_status,omitempty"` // Reason 审核拒绝原因 Reason string `json:"reason,omitempty"` // AuthorizationStatus 授权状态 枚举值:AUTHORIZED已授权、UNAUTHORIZED未授权、AUTHORIZATION_FAILED授权失败 AuthorizationStatus enum.WechatAuthorizationStatus `json:"authorization_status,omitempty"` ReasonUnauthorize string `json:"reason_unauthorize,omitempty"` // AccountType 所属账户类型 AccountType enum.AccountType `json:"account_type,omitempty"` // AccountID 所属账户ID AccountID uint64 `json:"account_id,omitempty"` // AntiAddictionURL 防沉迷提示URL,该url3小时内查看有效 AntiAddictionURL string `json:"anti_addiction_url,omitempty"` // ScreenRecordURL 游戏内容视频URL,该url3小时内查看有效 ScreenRecordURL string `json:"screen_record_url,omitempty"` // RealNameURL 实名认证URL,该url3小时内查看有效 RealNameURL string `json:"real_name_url,omitempty"` // AgeRemindURL 适龄提醒URL,该url3小时内查看有效 AgeRemindURL string `json:"age_remind_url,omitempty"` // CreateTime 创建时间 CreateTime string `json:"create_time,omitempty"` // ModifyTIme 修改时间 ModifyTime string `json:"modify_time,omitempty"` }
WechatGame 微信小游戏