coupon

package
v1.18.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 7, 2023 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Overview

Package coupon 线索通卡券组件管理 API models

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivityType

type ActivityType string

ActivityType 卡券类型

const (
	// ActivityType_DIRECT_NEED_PHONE 直接发券,收集手机号,need_phone须为true
	ActivityType_DIRECT_NEED_PHONE ActivityType = "DIRECT_NEED_PHONE"
	// ActivityType_DIRECT_NOT_NEED_PHONE 直接发券,不收集手机号,need_phone须为false 并且 BindFormId会被忽略
	ActivityType_DIRECT_NOT_NEED_PHONE ActivityType = "DIRECT_NOT_NEED_PHONE"
)

type Code

type Code struct {
	// CodeID 券码ID
	CodeID uint64 `json:"code_id,omitempty"`
	// Code 券码
	Code string `json:"code,omitempty"`
	// ActivityID 活动ID
	ActivityID uint64 `json:"activity_id,omitempty"`
	// CouponID 卡券活动ID
	CouponID uint64 `json:"coupon_id,omitempty"`
	// ResourceID 优惠券ID
	ResourceID uint64 `json:"resource_id,omitempty"`
	// ResourceTitle 优惠券标题
	ResourceTitle string `json:"resource_title,omitempty"`
	// ValidStart 有效期开始时间 格式:%Y-%m-%d
	ValidStart string `json:"valid_start,omitempty"`
	// ValidEnd 有效期结束时间 格式:%Y-%m-%d
	ValidEnd string `json:"valid_end,omitempty"`
	// Status 券码状态
	// VALID:有效中
	// EXPIRED:已过期
	// USED:已使用
	// ABANDONED:已废弃
	Status CodeStatus `json:"status,omitempty"`
	// UpdateTime 更新时间,格式:%Y-%m-%d %H:%M:%S
	// USED状态下,等于核销时间,否则等于创建时间
	UpdateTime string `json:"update_time,omitempty"`
	// CreateTime 创建时间,格式:%Y-%m-%d %H:%M:%S
	CreateTime string `json:"create_time,omitempty"`
}

Code 券码记录

type CodeConsumeRequest

type CodeConsumeRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CodeID 券码ID,c端获取
	CodeID string `json:"code_id,omitempty"`
	// Code 券码code,c端获取
	// code_id和code至少设置一个,两个都设置code_id优先
	// 当设置code时,必须设置activity_id、coupon_id和resource_id中的一个
	Code string `json:"code,omitempty"`
	// ActivityID 线索通活动ID,可从查询券码记录接口获取
	ActivityID uint64 `json:"activity_id,omitempty"`
	// CouponID 卡券ID,可从查询券码记录接口获取
	CouponID uint64 `json:"coupon_id,omitempty"`
	// ResourceID 优惠券ID,可从查询券码记录接口获取
	ResourceID uint64 `json:"resource_id,omitempty"`
	// Employee 核销员信息
	Employee *Employee `json:"employee,omitempty"`
	// Extra 核销补充信息,即自定义信息
	Extra map[string]string `json:"extra,omitempty"`
}

CodeConsumeRequest 核销券码

func (CodeConsumeRequest) Encode

func (r CodeConsumeRequest) Encode() []byte

Encode implemnent PostRequest interface

type CodeGetRequest

type CodeGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ActivityID 活动ID,可从获取卡券详情接口获取
	ActivityID uint64 `json:"activity_id,omitempty"`
	// CouponID 卡券活动ID,可从获取卡券详情接口获取
	CouponID uint64 `json:"coupon_id,omitempty"`
	// ResourceID 优惠券ID,可从获取卡券详情接口获取
	ResourceID uint64 `json:"resource_id,omitempty"`
	// StartTime 起始时间,格式:%Y-%m-%d,默认7天前,即不指定起止时间获取最近7天数据
	StartTime string `json:"start_time,omitempty"`
	// EndTime 截止时间,格式:%Y-%m-%d,默认当天,即不指定起止时间获取最近7天数据
	EndTime string `json:"end_time,omitempty"`
	// Status 券码状态
	// VALID:有效中
	// EXPIRED:已过期
	// USED:已使用
	// ABANDONED:已废弃
	Status CodeStatus `json:"status,omitempty"`
	// Page 页码,默认值为1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小,默认值10,不超过50
	PageSize int `json:"page_size,omitempty"`
}

CodeGetRequest 查询券码记录 API Request

func (CodeGetRequest) Encode

func (r CodeGetRequest) Encode() string

Encode implement GetRequest interface

type CodeGetResponse

type CodeGetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *CodeGetResponseData `json:"data,omitempty"`
}

CodeGetResponse 查询券码记录 API Response

type CodeGetResponseData

type CodeGetResponseData struct {
	// PageInfo 分页数据
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// List 券码记录列表
	List []Code `json:"list,omitempty"`
}

CodeGetResponseData json返回值

type CodeStatus

type CodeStatus string

CodeStatus 券码状态

const (
	// CodeStatus_VALID 有效中
	CodeStatus_VALID CodeStatus = "VALID"
	// CodeStatus_EXPIRED 已过期
	CodeStatus_EXPIRED CodeStatus = "EXPIRED"
	// CodeStatus_USED 已使用
	CodeStatus_USED CodeStatus = "USED"
	// CodeStatus_ABANDONED 已废弃
	CodeStatus_ABANDONED CodeStatus = "ABANDONED"
)

type CodeType

type CodeType string

CodeType 券码类型

const (
	// CodeType_API 合作方api实时传入的券码
	CodeType_API CodeType = "API"
	// CodeType_COMMON 通用码,固定值,不支持核销
	CodeType_COMMON CodeType = "COMMON"
	// CodeType_MERCHANT 商家上传券码,需调用上传券码接口上传券码文件
	CodeType_MERCHANT CodeType = "MERCHANT"
	// CodeType_MERCHANT 平台产生券码
	CodeType_PLATFORM CodeType = "PLATFORM"
)

type CodeUploadRequest

type CodeUploadRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// File 券码文件
	// 建议txt格式,券码数量不超过100万,否则可能解析失败。
	// 每行一个券码,券码格式4-30位,字母+数字
	// 查看券码文件示例
	File io.Reader `json:"file,omitempty"`
	// Filename 文件名
	Filename string `json:"filename,omitempty"`
	// Remark 本次上传的标识; 任意字符串,建议每次不一样,会在response中透传回来
	Remark string `json:"remark,omitempty"`
	// ResourceID 优惠券ID,调用卡券详情接口返回
	ResourceID uint64 `json:"resource_id,omitempty"`
}

CodeUploadRequest 上传券码 API Request

func (CodeUploadRequest) Encode

func (r CodeUploadRequest) Encode() []model.UploadField

Encode implement UploadReqeust interface

type CodeUploadResponse

type CodeUploadResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *CodeUploadResponseData `json:"data,omitempty"`
}

CodeUploadResponse 上传券码 API Response

type CodeUploadResponseData

type CodeUploadResponseData struct {
	// Count 本次上传的有效券码总数
	// 卡券未开始前,支持重复上传和补量
	// 卡券开始后,不支持补量
	Count int `json:"count,omitempty"`
	// Key 生成文件的唯一标识(保留字段,暂时没有地方使用)
	Key string `json:"key,omitempty"`
	// Lines 文件解析得到的行数
	Lines int `json:"lines,omitempty"`
	// Mark 本次上传的标识
	Mark string `json:"mark,omitempty"`
	// URL 本次上传有效的券码文件地址
	URL string `json:"url,omitempty"`
}

CodeUploadResponseData json返回值

type CountConfig

type CountConfig struct {
	// CountType 计数方式; 可选值:COUNT_TYPE_INCREMENT(递增计数)、COUNT_TYPE_DECREMENT(递减计数)
	CountType CountType `json:"count_type,omitempty"`
	// Prefix 计数文案前缀,例如:“截止目前已有”,不超过100个字符
	Prefix string `json:"prefix,omitempty"`
	// StartNum 起始数值
	StartNum int `json:"start_num,omitempty"`
	// Suffix 计数文案后缀,例如:“名用户参加”,不超过100个字符
	Suffix string `json:"suffix,omitempty"`
}

CountConfig 计数配置,包括递增/递减、计数开始值、计数文案模版

type CountType

type CountType string

CountType 计数方式

const (
	// COUNT_TYPE_INCREMENT 递增计数
	COUNT_TYPE_INCREMENT CountType = "COUNT_TYPE_INCREMENT"
	// COUNT_TYPE_DECREMENT 递减计数
	COUNT_TYPE_DECREMENT CountType = "COUNT_TYPE_DECREMENT"
)

type Coupon

type Coupon struct {
	// Title 活动标题,不超过15字
	Title string `json:"title,omitempty"`
	// DeliverStart 活动开始时间,格式:%Y-%m-%d,
	// 小于结束时间
	// 若小于当天则立即生效
	DeliverStart string `json:"deliver_start,omitempty"`
	// DeliverEnd 活动结束时间,格式:%Y-%m-%d
	DeliverEnd string `json:"deliver_end,omitempty"`
	// NeedPhone 是否收集手机号
	// 1:收集
	// 0:不收集(默认)
	NeedPhone int `json:"need_phone,omitempty"`
	// NeedSmsVerify 是否对手机号进行验证
	// 1:验证
	// 0:不验证
	// need_phone=0时,该字段无意义
	NeedSmsVerify int `json:"need_sms_verify,omitempty"`
	// CreateTime 创建时间,格式:%Y-%m-%d %H:%M:%S
	CreateTime string `json:"create_time,omitempty"`
	// UpdateTime 更新时间,格式:%Y-%m-%d %H:%M:%S
	UpdateTime string `json:"update_time,omitempty"`
	// Status 活动状态:
	// UNAUDITED:新建未审核
	// NORMAL:正常
	// PAUSE:暂停
	// AUDIT_DOING:审核中
	// AUDIT_FAIL:审核失败
	// OFFLINE: 已下线
	// DELETED:已删除
	Status CouponStatus `json:"status,omitempty"`
	// GlobalLimit 总库存量限制
	GlobalLimit *LimitSetting `json:"global_limit,omitempty"`
	// UserLimit 单个用户的库存量限制
	UserLimit *LimitSetting `json:"user_limit,omitempty"`
	// ResourceList 优惠券列表
	ResourceList []Resource `json:"resource_list,omitempty"`
}

Coupon 卡券

type CouponStatus

type CouponStatus string

CouponStatus 活动状态

const (
	// CouponStatus_UNAUDITED 新建未审核
	CouponStatus_UNAUDITED CouponStatus = "UNAUDITED"
	// CouponStatus_NORMAL 正常
	CouponStatus_NORMAL CouponStatus = "NORMAL"
	// CouponStatus_PAUSE 暂停
	CouponStatus_PAUSE CouponStatus = "PAUSE"
	// CouponStatus_AUDIT_DOING 审核中
	CouponStatus_AUDIT_DOING CouponStatus = "AUDIT_DOING"
	// CouponStatus_AUDIT_FAIL 审核失败
	CouponStatus_AUDIT_FAIL CouponStatus = "AUDIT_FAIL"
	// CouponStatus_OFFLINE 已下线
	CouponStatus_OFFLINE CouponStatus = "OFFLINE"
	// CouponStatus_DELETED 已删除
	CouponStatus_DELETED CouponStatus = "DELETED"
)

type CreateRequest

type CreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ActivityType 卡券类型,可选值:
	// DIRECT_NEED_PHONE:直接发券,收集手机号,need_phone须为true
	// DIRECT_NOT_NEED_PHONE :直接发券,不收集手机号,need_phone须为false 并且 BindFormId会被忽略
	// activity_type和need_phone传入不匹配会报错
	ActivityType ActivityType `json:"activity_type,omitempty"`
	// Coupon 卡券信息
	Coupon *Coupon `json:"coupon,omitempty"`
	// BindFormID 绑定的表单ID。仅need_phone=1时,支持设置此值.
	// 不设置此值时,系统会默认为当前的卡券创建一个用来收集手机号的表单
	// 使用者也可以明确指定要绑定的表单,此表单的验证类型会覆盖need_sms_verify的值
	// 使用者指定的表单必须有且仅有姓名和电话两个字段
	BindFormID uint64 `json:"bind_form_id,omitempty"`
}

CreateRequest 创建卡券 API Request

func (CreateRequest) Encode

func (r CreateRequest) Encode() []byte

Encode implement PostRequest interface

type CreateResponse

type CreateResponse struct {
	model.BaseResponse
	// Data json 返回值
	Data struct {
		// ActivityID 活动ID
		ActivityID uint64 `json:"activity_id,omitempty"`
	} `json:"data,omitempty"`
}

CreateResponse 创建卡券 API Response

type DetailRequest

type DetailRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ActivityID 活动ID
	ActivityID uint64 `json:"activity_id,omitempty"`
}

DetailRequest 获取卡券详情 API Request

func (DetailRequest) Encode

func (r DetailRequest) Encode() string

Encode implement GetRequest interface

type DetailResponse

type DetailResponse struct {
	model.BaseResponse
	// Data 返回数据
	Data *DetailResponseData `json:"data,omitempty"`
}

DetailResponse 获取卡券详情 API Response

type DetailResponseData

type DetailResponseData struct {
	// ActivityID 活动ID
	ActivityID uint64 `json:"activity_id,omitempty"`
	// ActivityType 卡券类型,可选值:
	// DIRECT_NEED_PHONE:直接发券,收集手机号,need_phone须为true
	// DIRECT_NOT_NEED_PHONE :直接发券,不收集手机号,need_phone须为false 并且 BindFormId会被忽略
	ActivityType ActivityType `json:"activity_type,omitempty"`
	// Coupon 卡券信息
	Coupon *Coupon `json:"coupon,omitempty"`
	// Form 表单信息
	Form *Form `json:"form,omitempty"`
}

DetailResponseData json返回值

type Employee

type Employee struct {
	// UserID 用户ID
	UserID uint64 `json:"user_id,omitempty"`
	// UserType 用户类型
	// TOUTIAO:头条用户
	// DOUYIN:抖音用户
	UserType EmployeeUserType `json:"user_type,omitempty"`
	// StoreID 门店ID,0代表不限制门店
	StoreID uint64 `json:"store_id,omitempty"`
}

Employee 核销员信息

type EmployeeCreateRequest

type EmployeeCreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// List 核销员列表
	List []Employee `json:"list,omitempty"`
}

EmployeeCreateRequest 添加核销员 API Request

func (EmployeeCreateRequest) Encode

func (r EmployeeCreateRequest) Encode() []byte

Encode implement PostRequest interface

type EmployeeCreateResponse

type EmployeeCreateResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *EmployeeCreateResponseData `json:"data,omitempty"`
}

EmployeeCreateResponse 添加核销员 API Response

type EmployeeCreateResponseData

type EmployeeCreateResponseData struct {
	// ExistedList 本次添加已存在的核销员列表
	ExistedList []Employee `json:"existed_list,omitempty"`
	// SuccessList 本次添加成功的核销员列表
	SuccessList []Employee `json:"success_list,omitempty"`
}

EmployeeCreateResponseData json返回值

type EmployeeDeleteRequest

type EmployeeDeleteRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// List 核销员列表
	List []Employee `json:"list,omitempty"`
}

EmployeeDeleteRequest 删除核销员 API Request

func (EmployeeDeleteRequest) Encode

func (r EmployeeDeleteRequest) Encode() []byte

Encode implement PostRequest interface

type EmployeeGetRequest

type EmployeeGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Page 页码,默认值为1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小,默认值10,不超过50
	PageSize int `json:"page_size,omitempty"`
}

EmployeeGetRequest 查询核销员 API Request

func (EmployeeGetRequest) Encode

func (r EmployeeGetRequest) Encode() string

Encode implement GetRequest interface

type EmployeeGetResponse

type EmployeeGetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *EmployeeGetResponseData `json:"data,omitempty"`
}

EmployeeGetResponse 查询核销员 API Response

type EmployeeGetResponseData

type EmployeeGetResponseData struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// List 核销员列表
	List []Employee `json:"list,omitempty"`
}

EmployeeGetResponseData json返回值

type EmployeeUserType

type EmployeeUserType string
const (
	// EmployeeUserType_TOUTIAO 头条用户
	EmployeeUserType_TOUTIAO EmployeeUserType = "TOUTIAO"
	// EmployeeUserType_DOUYIN 抖音用户
	EmployeeUserType_DOUYIN EmployeeUserType = "DOUYIN"
)

type ExtendInfo

type ExtendInfo struct {
	// CountConfig 计数配置,包括递增/递减、计数开始值、计数文案模版
	CountConfig *CountConfig `json:"count_config,omitempty"`
	// SignUpConfig 报名信息配置
	SignUpConfig *SignUpConfig `json:"sign_up_config,omitempty"`
	// SuccessTip 提交成功后的文案提示,文案长度不超过128个字符
	SuccessTip string `json:"success_tip,omitempty"`
}

ExtendInfo 扩展属性

type Form

type Form struct {
	// InstanceID 表单ID
	InstanceID uint64 `json:"instance_id,omitempty"`
	// Name 表单名称,不超过20个字符
	Name string `json:"name,omitempty"`
	// FormType 表单类型,目前不支持设置,仅支持查询时返回; 可选值:NORMAL_FORM(普通落地页)、ADVANCED_CREATIVE_FORM(附加创意)、NATIVE_FORM(原生表单)
	FormType FormType `json:"form_type,omitempty"`
	// ValidateType 线索验证类型,主要指C端是否进行短信验证,表单中含有电话类型时生效; 可选值:CLUE_PRIORITY(线索量优先)、VALIDITY_PRIORITY(有效性优先)、NONE_VERIFICATION(全不出)、AUTO_VERIFICATION(智能验证,历史逻辑,效果等同于全不出)、ALL_VERIFICATION(全出),详情见【附录-青鸟表单线索验证类型】
	ValidateType enum.ClueValidateType `json:"validate_type,omitempty"`
	// SubmitText 提交文案说明,如“提交表单”,文案长度不超过8个字符
	SubmitText string `json:"submit_text,omitempty"`
	// EnableLayer 是否开启分层; 枚举值:0,1(0表示不启用,1表示启用)
	EnableLayer int `json:"enable_layer,omitempty"`
	// LayerSubmitText 分层提交文案说明,分层信息在Elements中,当不开启分层时,所有分层信息无效。文案长度不超过8个字符
	LayerSubmitText string `json:"layer_submit_text,omitempty"`
	// Elements 表单元素
	Elements []FormElement `json:"elements,omitempty"`
	// ExtendInfo 扩展属性
	ExtendInfo *ExtendInfo `json:"extend_info,omitempty"`
}

Form 表单详细

type FormElement

type FormElement struct {
	// ElementID 元素ID
	ElementID uint64 `json:"element_id,omitempty"`
	// Label 元素标签名称,如“姓名“等,文案长度不超过8个字符
	Label string `json:"label,omitempty"`
	// ElementType 元素类型;可选值:NAME(姓名)、TELEPHONE(电话)、EMAIL(邮箱)、NUMBER(数值)、SEX(性别)、DATE(日期)、CITY(城市)、TEXT(文本)、TEXTAREA(文本域)、SELECT(下拉框)、RADIO(单选框)、CHECKBOX(多选框)、CALCULATOR(计算器);暂不支持SELECT、RADIO、CHECKBOX、CALCULATOR的创建
	ElementType FormElementType `json:"element_type,omitempty"`
	// Sequence 元素排序,即元素流式展示分布的先后顺序,默认按list顺序
	Sequence int `json:"sequence,omitempty"`
	// DefaultValue 元素默认值,目前已开放的元素类中,目前仅支持element_type=NUMBER,即数值类型时填写,表示默认值
	DefaultValue float64 `json:"default_value,omitempty"`
	// Layer 是否分层元素,和enable_layer,layer_submit_text结合用; 可选值:0,1(0表示不是,1表示是)
	Layer int `json:"layer,omitempty"`
	// AllowEmpty 是否允许为空,默认允许; 可选值:0,1(0表示不允许,1表示允许)
	AllowEmpty int `json:"allow_empty,omitempty"`
	// IsUnique 同一表单是否限制不可重复提交,默认可重复; 可选值:0,1(0表示可重复,1表示唯一)
	IsUnique int `json:"is_unique,omitempty"`
}

FormElement 表单元素

type FormElementType

type FormElementType string

FormElementType 表单元素类型

const (
	// FormElementType_NAME 姓名
	FormElementType_NAME FormElementType = "NAME"
	// FormElementType_TELEPHONE 电话
	FormElementType_TELEPHONE FormElementType = "TELEPHONE"
	// FormElementType_EMAIL 邮箱
	FormElementType_EMAIL FormElementType = "EMAIL"
	// FormElementType_NUMBER 数值
	FormElementType_NUMBER FormElementType = "NUMBER"
	// FormElementType_SEX 性别
	FormElementType_SEX FormElementType = "SEX"
	// FormElementType_DATE 日期
	FormElementType_DATE FormElementType = "DATE"
	// FormElementType_CITY 城市
	FormElementType_CITY FormElementType = "CITY"
	// FormElementType_TEXT 文本
	FormElementType_TEXT FormElementType = "TEXT"
	// FormElementType_TEXTAREA 文本域
	FormElementType_TEXTAREA FormElementType = "TEXTAREA"
	// FormElementType_SELECT 下拉框
	FormElementType_SELECT FormElementType = "SELECT"
	// FormElementType_RADIO 单选框
	FormElementType_RADIO FormElementType = "RADIO"
	// FormElementType_CHECKBOX 多选框
	FormElementType_CHECKBOX FormElementType = "CHECKBOX"
	// FormElementType_CALCULATOR 计算器
	FormElementType_CALCULATOR FormElementType = "CALCULATOR"
)

type FormType

type FormType string

FormType 表单类型

const (
	// NORMAL_FORM 普通落地页
	NORMAL_FORM FormType = "NORMAL_FORM"
	// ADVANCED_CREATIVE_FORM 附加创意
	ADVANCED_CREATIVE_FORM FormType = "ADVANCED_CREATIVE_FORM"
	// NATIVE_FORM 原生表单
	NATIVE_FORM FormType = "NATIVE_FORM"
)

type GetRequest

type GetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ActivityIDs 青鸟营销活动ID列表,当设置时,会忽略其他搜索条件
	ActivityIDs []uint64 `json:"activity_ids,omitempty"`
	// ActivityTypes 卡券类型,可选值:
	// DIRECT_NEED_PHONE:直接发券,收集手机号,need_phone须为true
	// DIRECT_NOT_NEED_PHONE :直接发券,不收集手机号,need_phone须为false 并且 BindFormId会被忽略
	ActivityTypes []ActivityType `json:"activity_types,omitempty"`
	// StartTime 起始时间,格式:%Y-%m-%d,默认7天前,即不指定起止时间获取最近7天数据
	StartTime string `json:"start_time,omitempty"`
	// EndTime 截止时间,格式:%Y-%m-%d,默认当天,即不指定起止时间获取最近7天数据
	EndTime string `json:"end_time,omitempty"`
	// IsDel 删除标记,默认获取未删除的数据
	// 可选值:0,1(0表示未删除,1表示已删除)
	IsDel int `json:"is_del,omitempty"`
	// Page 页码,默认值为1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小,默认值为10,最大不超过50
	PageSize int `json:"page_size,omitempty"`
}

GetRequest 获取卡券列表 API Request

func (GetRequest) Encode

func (r GetRequest) Encode() string

Encode implement GetRequest interface

type GetResponse

type GetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *GetResponseData `json:"data,omitempty"`
}

GetResponse 获取卡券列表 API Response

type GetResponseData

type GetResponseData struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// List 卡券列表
	List []DetailResponseData `json:"list,omitempty"`
}

GetResponseData json返回值

type Gift

type Gift struct {
	// Count 礼品数量
	Count int `json:"count,omitempty"`
	// IconURL 礼品icon地址
	IconURL string `json:"icon_url,omitempty"`
	// Name 礼品名称,不超过12字
	Name string `json:"name,omitempty"`
}

Gift 游戏礼包

type IndustryType

type IndustryType string

IndustryType 行业列表

const (
	// IndustryType_ENTERTAINMENT 生活娱乐
	IndustryType_ENTERTAINMENT IndustryType = "ENTERTAINMENT"
	// IndustryType_FINANCIAL 互联网金融
	IndustryType_FINANCIAL IndustryType = "FINANCIAL"
	// IndustryType_FOOD 美食
	IndustryType_FOOD IndustryType = "FOOD"
	// IndustryType_GAME 游戏
	IndustryType_GAME IndustryType = "GAME"
	// IndustryType_TICKET 休闲票务
	IndustryType_TICKET IndustryType = "TICKET"
	// IndustryType_OTHER 其他
	IndustryType_OTHER IndustryType = "OTHER"
)

type LimitSetting

type LimitSetting struct {
	// DayLimit 每日投放的总库存,不填或0表示不限制
	DayLimit *int `json:"day_limit,omitempty"`
	// TotalLimit 总投放库存限制,不填或0表示不限制
	TotalLimit *int `json:"total_limit,omitempty"`
}

LimitSetting 限制设置

type Resource

type Resource struct {
	// ResourceID 优惠券ID
	ResourceID uint64 `json:"resource_id,omitempty"`
	// Title 优惠券标题,不超过15字
	Title string `json:"title,omitempty"`
	// MerchantName 商户名称,不超过15字
	MerchantName string `json:"merchant_name,omitempty"`
	// ValidDays 有效时间段,从领取日开始计算,最大值不超过365
	// 设置此值后,valid_start和valid_end会被忽略,0表示不设置
	ValidDays int `json:"valid_days,omitempty"`
	// ValidStart 有效期开始时间 格式:%Y-%m-%d
	ValidStart string `json:"valid_start,omitempty"`
	// ValidEnd 有效期结束时间 格式:%Y-%m-%d
	ValidEnd string `json:"valid_end,omitempty"`
	// CodeType 券码类型,可选值:
	// API:合作方api实时传入的券码
	// COMMON:通用码,固定值,不支持核销
	// MERCHANT:商家上传券码,需调用上传券码接口上传券码文件
	// PLATFORM:平台产生券码
	CodeType CodeType `json:"code_type,omitempty"`
	// CodeReferURL 商家上传券码类型时,有效券码文件的url
	CodeReferURL string `json:"code_refer_url,omitempty"`
	// Code 通用券码类型时设置的券码,4-30位,只支持字母、数字
	Code string `json:"code,omitempty"`
	// Condition 使用须知,长度不超过50字
	Condition string `json:"condition,omitempty"`
	// Notification 领取须知,长度不超过500
	Notification string `json:"notification,omitempty"`
	// HeadImageURL 卡券头图地址,即优惠券背景图
	HeadImageURL string `json:"head_image_url,omitempty"`
	// LogoImageURL 商家logo地址
	LogoImageURL string `json:"logo_image_url,omitempty"`
	// ServiceNum 客服电话
	ServiceNum string `json:"service_num,omitempty"`
	// Stock 优惠券的库存,0表示不限制
	Stock int `json:"stock,omitempty"`
	// UseType 核销类型
	// OFFLINE:用户线下核销
	// LINK:用户使用时直接跳转新链接
	UseType UseType `json:"use_type,omitempty"`
	// Link use_type为LINK时必填,跳转链接
	Link string `json:"link,omitempty"`
	// IndustryType 行业列表,可选值:
	// ENTERTAINMENT:生活娱乐
	// FINANCIAL:互联网金融
	// FOOD:美食
	// GAME:游戏
	// TICKET:休闲票务
	// OTHER:其他
	IndustryType IndustryType `json:"industry_type,omitempty"`
	// StoreIDs 可用门店ID列表
	// 通过 【查询门店接口】获取
	// 建议不超过500
	StoreIDs []uint64 `json:"store_ids,omitempty"`
	// MinAmount 最低消费金额,单位为分,如:500 表示500分,即5元
	MinAmount int64 `json:"min_amount,omitempty"`
	// ResourceType 优惠券类型。详见【附录-枚举值】,可选值:
	// COMMON:通用券
	// DISCOUNT:折扣券
	// FULL:满减券
	// GAME:游戏礼包
	// PHYSICAL:实物券
	ResourceType ResourceType `json:"resource_type,omitempty"`
	// GiftList 游戏礼包列表
	GiftList []Gift `json:"gift_list,omitempty"`
	// IosLink ios端下载链接
	IosLink string `json:"ios_link,omitempty"`
	// AndroidLink 安卓端下载链接
	AndroidLink string `json:"android_link,omitempty"`
	// Discount 折扣券的折扣,值为1到99,如:1代表0.1折,90代表9折。
	Discount int `json:"discount,omitempty"`
	// MaxAmount 优惠券类型为折扣券时的最大减免金额,单位为分,如:500 表示500分,即5元
	MaxAmount int64 `json:"max_amount,omitempty"`
	// ReliefAmount 满减券的减免金额,单位为分,如:500 表示500分,即5元
	ReliefAmount int64 `json:"relief_amount,omitempty"`
	// AuditMsg 审核信息,成功时通常为空,失败时描述原因
	AuditMsg string `json:"audit_msg,omitempty"`
}

Resource 优惠券信息

type ResourceType

type ResourceType string

ResourceType 优惠券类型

const (
	// ResourceType_COMMON 通用券
	ResourceType_COMMON ResourceType = "COMMON"
	// ResourceType_DISCOUNT 折扣券
	ResourceType_DISCOUNT ResourceType = "DISCOUNT"
	// ResourceType_FULL 满减券
	ResourceType_FULL ResourceType = "FULL"
	// ResourceType_GAME 游戏礼包
	ResourceType_GAME ResourceType = "GAME"
	// ResourceType_PHYSICAL 实物券
	ResourceType_PHYSICAL ResourceType = "PHYSICAL"
)

type SignType

type SignType string

SignType 表单报名配置展示形式

const (
	// SIGN_TYPE_SCROLL_WALL 滚动墙展示
	SIGN_TYPE_SCROLL_WALL SignType = "SIGN_TYPE_SCROLL_WALL"
	// SIGN_TYPE_SCROLL_BAR 滚动条展示
	SIGN_TYPE_SCROLL_BAR SignType = "SIGN_TYPE_SCROLL_BAR"
)

type SignUpConfig

type SignUpConfig struct {
	// SignType 表单报名配置展示形式; SIGN_TYPE_SCROLL_WALL(滚动墙展示)、SIGN_TYPE_SCROLL_BAR(滚动条展示)
	SignType SignType `json:"sign_type,omitempty"`
}

SignUpConfig 报名信息配置

type UpdateRequest

type UpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ActivityID 青鸟营销活动ID
	ActivityID uint64 `json:"activity_id,omitempty"`
	// DeliverStart 活动开始时间,格式:%Y-%m-%d
	// 小于结束时间,最多往前调一年
	// 若小于当天则立即生效
	// 活动开始后不允许修改
	DeliverStart string `json:"deliver_start,omitempty"`
	// DeliverEnd 活动结束时间,格式:%Y-%m-%d,
	// 大于当前时间,最多往后调一年
	// deliver_end <= valid_end
	// valid_end为优惠券的有效期结束时间
	// 活动开始后不允许修改
	DeliverEnd string `json:"deliver_end,omitempty"`
	// GlobalLimit 总库存量限制
	// 活动开始后不允许修改
	GlobalLimit *LimitSetting `json:"global_limit,omitempty"`
	// UserLimit 单个用户的库存量限制
	// 活动开始后不允许修改
	UserLimit *LimitSetting `json:"user_limit,omitempty"`
	// Status NORMAL:上线; OFFLINE: 下线
	Status CouponStatus `json:"status,omitempty"`
}

UpdateRequest 编辑卡券

func (UpdateRequest) Encode

func (r UpdateRequest) Encode() []byte

Encode implemnent PostRequest interface

type UseType

type UseType string

UseType 核销类型

const (
	// UseType_OFFLINE 用户线下核销
	UseType_OFFLINE UseType = "OFFLINE"
	// UseType_LINK 用户使用时直接跳转新链接
	UseType_LINK UseType = "LINK"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL