advertiser

package
v1.24.4 Latest Latest
Warning

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

Go to latest
Published: Apr 18, 2024 License: Apache-2.0 Imports: 7 Imported by: 1

Documentation

Overview

Package advertiser 账号服务相关API models

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AdQualification added in v1.9.11

type AdQualification struct {
	// QualificationID 资质id
	QualificationID uint64 `json:"qualification_id,omitempty"`
	// QualificationType 投放资质类型
	// 1:肖像、商标或其他授权
	// 2: 专利证明
	// 3: 商标证
	// 4: 广告内容中的数据证明
	// 5: 质检报告
	QualificationType int `json:"qualification_type,omitempty"`
	// PicturePreviewURL 投放资质预览url
	PicturePreviewURL string `json:"picture_preview_url,omitempty"`
	// Status 状态
	// 0: 待提交
	// 1: 待审核
	// 2: 审核中
	// 3: 审核通过
	// 4: 审核拒绝
	Status int `json:"status,omitempty"`
	// RejectReason 审核原因
	RejectReason string `json:"reject_reason,omitempty"`
	// AuditTime 审核时间,形如 yyyy-MM-dd HH:mm:ss
	AuditTime string `json:"audit_time,omitempty"`
	// ImageList 资质图片列表
	ImageList []Image `json:"image_list,omitempty"`
}

AdQualification 投放资质

type AttachmentUploadRequest added in v1.11.0

type AttachmentUploadRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ImageData 图片数据
	// 上传格式支持jpg、 jpeg、 png、 webp、 awebp、heic、gif、tiff、ico、svg、bmp,大小10M内
	ImageData io.Reader `json:"image_data,omitempty"`
	// Filename 文件名
	Filename string `json:"filename,omitempty"`
	// AttachmentType 可选值:
	// DELIVERY_ATTACHMENT: 投放资质附件
	AttachmentType enum.AttachmentType `json:"attachment_type,omitempty"`
}

AttachmentUploadRequest 批量上传资质附件 API Request

func (AttachmentUploadRequest) Encode added in v1.11.0

Encode implement UploadReqeust interface

type AttachmentUploadResponse added in v1.11.0

type AttachmentUploadResponse struct {
	model.BaseResponse
	Data struct {
		// AttachmentID 附件id
		AttachmentID uint64 `json:"attachment_id,omitempty"`
	} `json:"data,omitempty"`
}

AttachmentUploadResponse 批量上传资质附件 API Response

type AvatarGetRequest

type AvatarGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
}

AvatarGetRequest 获取广告主头像信息 API Request

func (AvatarGetRequest) Encode

func (r AvatarGetRequest) Encode() string

Encode implement GetRequest interface

type AvatarGetResponse

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

AvatarGetResponse 获取广告主头像信息 API Response

type AvatarGetResponseData

type AvatarGetResponseData struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AvatarStatus 头像审核状态 0-未设置,1-审核中,2-审核被拒,3-审核通过
	AvatarStatus int `json:"avatar_status,omitempty"`
	// AvatarReason 头像被拒原因
	AvatarReason string `json:"avatar_reason,omitempty"`
	// SourceStatus 品牌审核状态 0-未设置,1-审核中,2-审核被拒,3-审核通过,
	SourceStatus int `json:"source_status,omitempty"`
	// SourceReason 品牌信息被拒原因
	SourceReason string `json:"source_reason,omitempty"`
	// AvatarInfo 头像信息
	AvatarInfo *AvatarInfo `json:"avatar_info,omitempty"`
}

AvatarGetResponseData 获取广告主头像信息json返回值

type AvatarInfo

type AvatarInfo struct {
	// WebUri 当前头像的uri
	WebUri string `json:"web_uri,omitempty"`
	// AuditWebUri 审核中头像的uri
	AuditWebUri string `json:"audit_web_uri,omitempty"`
	// Height 审核中头像的高度
	Height int `json:"height,omitempty"`
	// Width 审核中头像的宽度
	Width int `json:"width,omitempty"`
}

AvatarInfo 头像信息

type AvatarSubmitRequest added in v1.23.4

type AvatarSubmitRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ImageID 账户头像id,例:web.business.image/201910225d0d5a39ae2e246645b486
	// 您可调用「获取广告主账户头像ID」接口获取头像的image_id
	// 格式:jpg/jpeg/png/bmp
	// 大小:<=5M
	// 像素:<=300*300
	ImageID string `json:"image_id,omitempty"`
	// SourceInfo 品牌名称
	SourceInfo string `json:"source_info,omitempty"`
}

AvatarSubmitRequest 更新广告主账户头像 API Request

func (AvatarSubmitRequest) Encode added in v1.23.4

func (r AvatarSubmitRequest) Encode() []byte

Encode implement PostRequest interface

type AvatarSubmitResponse added in v1.23.4

type AvatarSubmitResponse struct {
	model.BaseResponse
	Data struct {
		// AdvertiserID 更新头像成功的广告主账户id
		AdvertiserID model.Uint64 `json:"advertiser_id,omitempty"`
	} `json:"data,omitempty"`
}

AvatarSubmitResponse 更新广告主账户头像 API Response

type AvatarUploadRequest added in v1.23.4

type AvatarUploadRequest struct {
	// AdvertiserID 广告主账户id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ImageData 图片数据
	// 格式要求:bmp,jpeg,jpg,png
	// 文件大小:<=5M
	// 像素:<=300*300
	ImageData io.Reader `json:"image_data,omitempty"`
	// Filename 文件名
	Filename string `json:"filename,omitempty"`
}

AvatarUploadRequest 获取广告主账户头像ID API Request

func (AvatarUploadRequest) Encode added in v1.23.4

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

Encode implement UploadReqeust interface

type AvatarUploadResponse added in v1.23.4

type AvatarUploadResponse struct {
	model.BaseResponse
	Data struct {
		// ImageID 账户头像图片ID,您可使用此ID前往「更新广告主账户头像」接口更新头像
		ImageID string `json:"image_id,omitempty"`
	} `json:"data,omitempty"`
}

AvatarUploadResponse 获取广告主账户头像ID API Response

type BaseQualification added in v1.9.11

type BaseQualification struct {
	// QualificationID 资质id
	QualificationID uint64 `json:"qualification_id,omitempty"`
	// AttachmentID 资质图片附件id
	AttachmentID string `json:"attachment_id,omitempty"`
	// PictureURL 资质图片地址
	PictureURL string `json:"picture_url,omitempty"`
	// Status 状态,枚举值:STATUS_NOT_SUBMIT 未提交、STATUS_WAIT_CONFIRM 待审核、STATUS_PENDING_CONFIRM 审核中、STATUS_CONFIRM 审核通过、STATUS_CONFIRM_FAIL 审核不通过
	Status enum.QualificationStatus `json:"status,omitempty"`
	// RejectReason 拒绝理由
	RejectReason string `json:"reject_reason,omitempty"`
}

BaseQualification 资质基本信息

type BudgetGetRequest

type BudgetGetRequest struct {
	// AdvertiserIDs 广告主ID集合(如果包含没有访问权限的ID,将返回no permission error) 取值范围: 1-100
	AdvertiserIDs []uint64 `json:"advertiser_ids,omitempty"`
}

BudgetGetRequest 获取账户日预算 API Request

func (BudgetGetRequest) Encode

func (r BudgetGetRequest) Encode() string

Encode implement GetRequest interface

type BudgetGetResponse

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

BudgetGetResponse 获取账户日预算 API Response

type BudgetGetResponseData

type BudgetGetResponseData struct {
	// List 返回值列表
	List []BudgetGetResponseList `json:"list,omitempty"`
}

BudgetGetResponseData json返回值

type BudgetGetResponseList

type BudgetGetResponseList struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Budget 预算,单位:元; 精度:小数点后两位;举例:100.01。当预算类型为不限,返回的预算为0.0
	Budget float64 `json:"budget,omitempty"`
	// BudgetMode 预算类型
	BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"`
}

BudgetGetResponseList 返回值列表

type Delivery added in v1.21.5

type Delivery struct {
	// QualificationID 资质id
	QualificationID uint64 `json:"qualification_id,omitempty"`
	// QualType 资质类型id
	QualType uint64 `json:"qual_type,omitempty"`
	// QualTypeName 资质类型名称
	QualTypeName string `json:"qual_type_name,omitempty"`
	// Status 资质审核状态 可选值:
	// STATUS_CONFIRM 审核通过
	// STATUS_CONFIRM_FAIL 审核不通过
	// STATUS_NOT_SUBMIT 未提交
	// STATUS_PENDING_CONFIRM 审核中
	// STATUS_WAIT_CONFIRM 待审核
	Status enum.DeliveryPkgStatus `json:"status,omitempty"`
	// Attachments 资质图片附件
	Attachments []DeliveryAttachment `json:"attachments,omitempty"`
	// RejectReason 拒绝理由,若资质被拒绝,则会有拒绝理由
	RejectReason string `json:"reject_reason,omitempty"`
}

Delivery 资质的具体信息

type DeliveryAttachment added in v1.21.5

type DeliveryAttachment struct {
	// AttachmentID 附件id
	AttachmentID uint64 `json:"attachment_id,omitempty"`
	// PictureURL 图片链接
	PictureURL string `json:"picture_url,omitempty"`
}

DeliveryAttachment 资质图片附件

type DeliveryPkg added in v1.21.5

type DeliveryPkg struct {
	// PkgID 推广产品组id
	PkgID uint64 `json:"pkg_id,omitempty"`
	// ConfigID 来自【推广产品资质规则配置查询接口】,行业的资质规则中的config_id
	ConfigID uint64 `json:"config_id,omitempty"`
	// ProductName 用户提交的推广产品名称
	ProductName string `json:"product_name,omitempty"`
	// Status 推广产品整组的审核状态,标识该推广产品是否审核通过 可选值:
	// STATUS_CONFIRM 审核通过
	// STATUS_CONFIRM_FAIL 审核不通过
	// STATUS_NOT_SUBMIT 未提交
	// STATUS_PENDING_CONFIRM 审核中
	// STATUS_WAIT_CONFIRM 待审核
	Status enum.DeliveryPkgStatus `json:"status,omitempty"`
	// IndustryID 一级到三级行业id
	IndustryID []uint64 `json:"industry_id,omitempty"`
	// IndustryName 一级到三级行业名称
	IndustryName []string `json:"industry_name,omitempty"`
	// NecessaryCombine 必填资质模块
	NecessaryCombine []DeliveryPkgCombine `json:"necessary_combine,omitempty"`
	// UnnecessaryCombine 选填资质模块
	UnnecessaryCombine []DeliveryPkgCombine `json:"unnecessary_combine,omitempty"`
	// Permission 权限信息
	Permission *DeliveryPkgPermission `json:"permission,omitempty"`
}

DeliveryPkg 推广产品资质信息

type DeliveryPkgCombine added in v1.21.5

type DeliveryPkgCombine struct {
	// CombineID 推广类型id,来自【推广产品资质规则配置查询接口】,行业的资质规则中的promotion_type_id
	CombineID uint64 `json:"combine_id,omitempty"`
	// Description 推广类型描述
	Description string `json:"description,omitempty"`
	// DeliveryRules 资质规则
	DeliveryRules []DeliveryRule `json:"delivery_rules,omitempty"`
}

DeliveryPkgCombine 资质模块

type DeliveryPkgConfigRequest added in v1.21.5

type DeliveryPkgConfigRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// FirstIndustryID 一级行业id
	FirstIndustryID uint64 `json:"first_industry_id,omitempty"`
	// SecondIndustryID 二级行业id
	SecondIndustryID uint64 `json:"second_industry_id,omitempty"`
	// ThirdIndustryID 三级行业id
	ThirdIndustryID uint64 `json:"third_industry_id,omitempty"`
}

DeliveryPkgConfigRequest 查询推广产品资质规则配置 API Request

func (DeliveryPkgConfigRequest) Encode added in v1.21.5

func (r DeliveryPkgConfigRequest) Encode() string

Encode implement GetRequest interface

type DeliveryPkgConfigResponse added in v1.21.5

type DeliveryPkgConfigResponse struct {
	model.BaseResponse
	Data struct {
		// IndustryConfig 资质规则
		IndustryConfig *IndustryConfig `json:"industry_config,omitempty"`
	} `json:"data,omitempty"`
}

DeliveryPkgConfigResponse 查询推广产品资质规则配置 API Response

type DeliveryPkgGetRequest added in v1.21.5

type DeliveryPkgGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PkgID 推广产品组id,是推广产品的组标识
	PkgID uint64 `json:"pkg_id,omitempty"`
}

DeliveryPkgGetRequest 查询推广产品资质 API Request

func (DeliveryPkgGetRequest) Encode added in v1.21.5

func (r DeliveryPkgGetRequest) Encode() string

Encode implement GetRequest interface

type DeliveryPkgGetResponse added in v1.21.5

type DeliveryPkgGetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data struct {
		// DeliveryPkg 推广产品资质信息
		DeliveryPkg *DeliveryPkg `json:"delivery_pkg,omitempty"`
	} `json:"data,omitempty"`
}

DeliveryPkgGetResponse 查询推广产品资质 API Response

type DeliveryPkgPermission added in v1.21.5

type DeliveryPkgPermission struct {
	// CanEdit 是否支持编辑
	CanEdit bool `json:"can_edit,omitempty"`
	// CantEditReason 不支持编辑的原因
	CantEditReason string `json:"cant_edit_reason,omitempty"`
	// CanDelete 是否支持删除
	CanDelete bool `json:"can_delete,omitempty"`
	// CantDeleteReason 不支持删除的原因
	CantDeleteReason string `json:"cant_delete_reason,omitempty"`
}

DeliveryPkgPermission 权限信息

type DeliveryPkgSubmitRequest added in v1.21.5

type DeliveryPkgSubmitRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// DeliveryPkg 推广产品资质信息
	DeliveryPkg *DeliveryPkg `json:"delivery_pkg,omitempty"`
}

DeliveryPkgSubmitRequest 提交推广产品资质 API Request

func (DeliveryPkgSubmitRequest) Encode added in v1.21.5

func (r DeliveryPkgSubmitRequest) Encode() []byte

Encode implement PostRequest interface

type DeliveryPkgSubmitResponse added in v1.21.5

type DeliveryPkgSubmitResponse struct {
	model.BaseResponse
	Data *DeliveryPkgSubmitResult `json:"data,omitempty"`
}

DeliverPkgSubmitResponse 提交推广产品资质 API Response

type DeliveryPkgSubmitResult added in v1.21.5

type DeliveryPkgSubmitResult struct {
	// PkgID 推广产品组id,可用于后续的查询或编辑
	PkgID uint64 `json:"pkg_id,omitempty"`
	// QualificationIDs 系统生成的资质id,每份资质对应一个id
	QualificationIDs []uint64 `json:"qualification_ids,omitempty"`
}

type DeliveryQualification added in v1.11.0

type DeliveryQualification struct {
	// QualificationID
	QualificationID uint64 `json:"qualification_id,omitempty"`
	// QualificationType 投放资质类型
	QualificationType enum.DeliveryQualificationType `json:"qualification_type,omitempty"`
	// Status 投放资质状态
	Status enum.DeliveryQualificationStatus `json:"status,omitempty"`
	// RejectReason
	RejectReason string `json:"reject_reason,omitempty"`
	// AuditTime string
	AuditTime string `json:"audit_time,omitempty"`
	// Images
	Images []DeliveryQualificationImage `json:"images,omitempty"`
}

DeliveryQualification 投放资质

type DeliveryQualificationImage added in v1.11.0

type DeliveryQualificationImage struct {
	// AttachmentID
	AttachmentID uint64 `json:"attachment_id,omitempty"`
	// ImageDownloadURL
	ImageDownloadURL string `json:"image_download_url,omitempty"`
	// ImagePreviewURL
	ImagePreviewURL string `json:"image_preview_url,omitempty"`
}

type DeliveryQualificationListData added in v1.11.0

type DeliveryQualificationListData struct {
	model.PageInfo
	// List 投放资质列表
	List []DeliveryQualification `json:"list,omitempty"`
}

type DeliveryQualificationListRequest added in v1.11.0

type DeliveryQualificationListRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// QualificationType 投放资质类型
	QualificationType enum.DeliveryQualificationType `json:"qualification_type,omitempty"`
	// Status 投放资质状态
	Status enum.DeliveryQualificationStatus `json:"status,omitempty"`
	// Page 页数默认值:1,page范围为[1,1000]
	Page int `json:"page,omitempty"`
	// PageSize 页面大小默认值:10,page_size范围为[1,100]
	PageSize int `json:"page_size,omitempty"`
}

DeliveryQualificationListRequest 投放资质查询

func (DeliveryQualificationListRequest) Encode added in v1.11.0

Encode implement GetRequest interface

type DeliveryQualificationListResponse added in v1.11.0

type DeliveryQualificationListResponse struct {
	model.BaseResponse
	Data *DeliveryQualificationListData `json:"data,omitempty"`
}

type DeliveryQualificationSubmitRequest added in v1.11.0

type DeliveryQualificationSubmitRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Qualifications
	Qualifications []DeliverySubmitQualification `json:"qualifications,omitempty"`
}

DeliveryQualificationSubmitRequest 投放资质提交 API Request

func (DeliveryQualificationSubmitRequest) Encode added in v1.11.0

Encode implement PostRequest interface

type DeliveryQualificationSubmitResponse added in v1.21.7

type DeliveryQualificationSubmitResponse struct {
	model.BaseResponse
	Data struct {
		// QualificationIDs 资质id列表
		QualificationIDs []uint64 `json:"qualification_ids,omitempty"`
	} `json:"data,omitempty"`
}

DeliveryQualificationSubmitResponse 提交投放资质(新版)API Response

type DeliveryRule added in v1.21.5

type DeliveryRule struct {
	// RuleID 原子规则id
	RuleID uint64 `json:"rule_id,omitempty"`
	// Deliveries 资质的具体信息
	Deliveries []Delivery `json:"deliveries,omitempty"`
}

DeliveryRules 资质规则

type DeliverySubmitQualification added in v1.11.0

type DeliverySubmitQualification struct {
	// QualificationType
	QualificaitonType enum.DeliveryQualificationType `json:"qualification_type,omitempty"`
	// AttachmentIDs 附件ids,通过【批量上传资质附件】接口获取
	AttachmentIDs []uint64 `json:"attachment_ids,omitempty"`
}

DeliverySubmitQualification

type FundDailyStatRequest

type FundDailyStatRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// StartDate 开始时间,格式YYYY-MM-DD,默认当前年份的1月1日
	StartDate time.Time `json:"start_date,omitempty"`
	// EndDate 结束时间,格式YYYY-MM-DD,默认为今天
	EndDate time.Time `json:"end_date,omitempty"`
	// Page 页码. 默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面数据量. 默认值: 10
	PageSize int `json:"page_size,omitempty"`
}

FundDailyStatRequest 查询账户日流水 API Request

func (FundDailyStatRequest) Encode

func (r FundDailyStatRequest) Encode() string

Encode implement GetRequest interface

type FundDailyStatResponse

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

FundDailyStatResponse 查询账户日流水 API Response

type FundDailyStatResponseData

type FundDailyStatResponseData struct {
	// List list
	List []FundDailyStatResponseList `json:"list,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

FundDailyStatResponseData json返回值

type FundDailyStatResponseList

type FundDailyStatResponseList struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Date 日期
	Date string `json:"date,omitempty"`
	// Balance 日终结余(单位元)
	Balance float64 `json:"balance,omitempty"`
	// CashCost 现金支出(单位元)
	CashCost float64 `json:"cash_cost,omitempty"`
	// Cost 总支出(单位元)
	Cost float64 `json:"cost,omitempty"`
	// Frozen 冻结(单位元)
	Frozen float64 `json:"frozen,omitempty"`
	// Income 总存入(单位元)
	Income float64 `json:"income,omitempty"`
	// RewardCost 赠款支出(单位元)
	RewardCost float64 `json:"reward_cost,omitempty"`
	// ReturnGoodsCost 返货支出(单位元)
	ReturnGoodsCost float64 `json:"return_goods_cost,omitempty"`
	// TransferIn 总转入(单位元)
	TransferIn float64 `json:"transfer_in,omitempty"`
	// TransferOut 总转出(单位元)
	TransferOut float64 `json:"transfer_out,omitempty"`
	// CompanyWalletCost 账户消耗的子钱包的共享余额(单位元)
	CompanyWalletCost float64 `json:"company_wallet_cost,omitempty"`
}

FundDailyStatResponseList 广告主流水

type FundGetRequest

type FundGetRequest struct {
	// AdvertiserID 广告主ID或代理商ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// GrantTypeSplit 是否拆分赠款类型,允许值:
	// 开启 ON ,关闭 OFF(默认)
	GrantTypeSplit string `json:"grant_type_split,omitempty"`
}

FundGetRequest 查询账号余额 API Request

func (FundGetRequest) Encode

func (r FundGetRequest) Encode() string

Encode implement GetRequest interface

type FundGetResponse

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

FundGetResponse 查询账号余额 API Response

type FundGetResponseData

type FundGetResponseData struct {
	// AdvertiserID 广告主ID或代理商ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Name 账户名
	Name string `json:"name,omitempty"`
	// Email 联系邮箱
	Email string `json:"email,omitempty"`
	// Balance 账户总余额(单位元)
	Balance model.Float64 `json:"balance,omitempty"`
	// ValidBalance 账户可用总余额(单位元)
	ValidBalance model.Float64 `json:"valid_balance,omitempty"`
	// Cash 现金余额(单位元)
	Cash model.Float64 `json:"cash,omitempty"`
	// ValidCash 现金可用余额(单位元)
	ValidCash model.Float64 `json:"valid_cash,omitempty"`
	// Grant 赠款余额(单位元)
	Grant model.Float64 `json:"grant,omitempty"`
	// DefaultGrant 默认广告位可用赠款余额(单位元)
	DefaultGrant model.Float64 `json:"default_grant,omitempty"`
	// CommonGrant 通用广告位可用赠款余额(单位元)
	CommonGrant model.Float64 `json:"common_grant,omitempty"`
	// SearchGrant 搜索广告位可用赠款余额(单位元)
	SearchGrant model.Float64 `json:"search_grant,omitempty"`
	// UnionGrant 穿山甲广告位可用赠款余额(单位元)
	UnionGrant model.Float64 `json:"union_grant,omitempty"`
	// ValidGrant 赠款可用余额(单位元)
	ValidGrant model.Float64 `json:"valid_grant,omitempty"`
	// ReturnGoodsAbs 返货余额(单位元),仅支持部分广告主
	ReturnGoodsAbs model.Float64 `json:"return_goods_abs,omitempty"`
	// ValidReturnGoodsAbs 返货可用余额(单位元),仅支持部分广告主
	ValidReturnGoodsAbs model.Float64 `json:"valid_return_goods_abs,omitempty"`
	// ReturnGoodsCost 返货支出(单位元),仅支持部分广告主
	ReturnGoodsCost model.Float64 `json:"return_goods_cost,omitempty"`
	// ReturnGoodsGrant 返货赠款
	ReturnGoodsGrant model.Float64 `json:"return_goods_grant,omitempty"`
	// CompensationGrant 赔付赠款
	CompensationGrant model.Float64 `json:"compensation_grant,omitempty"`
	// ReturnGoodsValidGrant 返货可用赠款
	ReturnGoodsValidGrant model.Float64 `json:"return_goods_valid_grant,omitempty"`
	// CompensationValidGrant 赔付可用赠款
	CompensationValidGrant model.Float64 `json:"compensation_valid_grant,omitempty"`
	// WalletID 钱包id(广告主账户绑定的共享子钱包id)
	WalletID model.Uint64 `json:"wallet_id,omitempty"`
	// WalletName 钱包名称(广告主账户绑定的共享子钱包名称)
	WalletName string `json:"wallet_name,omitempty"`
	// WalletTotalBalanceValid 账户绑定的子钱包的可用共享余额(单位元)
	WalletTotalBalanceValid model.Float64 `json:"wallet_total_balance_valid,omitempty"`
}

FundGetResponseData 账号余额

type FundTransactionGetRequest

type FundTransactionGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// StartDate 开始时间,格式YYYY-MM-DD,默认当前年份的1月1日
	StartDate time.Time `json:"start_date,omitempty"`
	// EndDate 结束时间,格式YYYY-MM-DD,默认为今天
	EndDate time.Time `json:"end_date,omitempty"`
	// TransactionType 流水类型
	TransactionType enum.TransactionType `json:"transaction_type,omitempty"`
	// Page 页码. 默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面数据量. 默认值: 10
	PageSize int `json:"page_size,omitempty"`
}

FundTransactionGetRequest 查询账号流水明细 API Request

func (FundTransactionGetRequest) Encode

func (r FundTransactionGetRequest) Encode() string

Encode implement GetRequest interface

type FundTransactionGetResponse

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

FundTransactionGetResponse 查询账号流水明细 API Response

type FundTransactionGetResponseData

type FundTransactionGetResponseData struct {
	// List 明细list
	List []FundTransactionGetResponseList `json:"list,omitempty"`
}

FundTransactionGetResponseData json返回值

type FundTransactionGetResponseList

type FundTransactionGetResponseList struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// TransactionType 流水类型
	TransactionType enum.TransactionType `json:"transaction_type,omitempty"`
	// CreateTime 流水产生时间
	CreateTime string `json:"create_time,omitempty"`
	// Amount 交易总金额(单位元)
	Amount float64 `json:"amount,omitempty"`
	// Cash 现金总金额(单位元)
	Cash float64 `json:"cash,omitempty"`
	// Frozen 冻结(单位元)
	Frozen float64 `json:"frozen,omitempty"`
	// Grant 赠款总金额(单位元)
	Grant float64 `json:"grant,omitempty"`
	// ReturnGoods 返货总金额(单位元)
	ReturnGoods float64 `json:"return_goods,omitempty"`
	// TransactionSeq 交易流水号
	TransactionSeq uint64 `json:"transaction_seq,omitempty"`
	// Remitter 付款方,即广告主id。
	Remitter uint64 `json:"remitter,omitempty"`
	// Payee 收款方,即广告主id。
	Payee uint64 `json:"payee,omitempty"`
	// Dealbase 返点
	Dealbase float64 `json:"dealbase,omitempty"`
}

FundTransactionGetResponseList 明细

type Image added in v1.9.11

type Image struct {
	// AttachmentID 附件id
	AttachmentID uint64 `json:"attachment_id,omitempty"`
	// ImageURL 图片预览地址
	ImageURL string `json:"image_url,omitempty"`
}

Image 图片信息

type IndustryConfig added in v1.21.5

type IndustryConfig struct {
	// ConfigID 资质规则id
	ConfigID uint64 `json:"config_id,omitempty"`
	// IndustryStatus 行业状态:1 生效 、2 禁投(不允许提交该行业的资质) 可选值:
	// NONVALID 禁投
	// VALID 生效
	IndustryStatus enum.IndustryStatus `json:"industry_status,omitempty"`
	// IndustryIDs 第一级到第三级行业id
	IndustryIDs []uint64 `json:"industry_ids,omitempty"`
	// IndustryNames 第一级到第三级行业名称
	IndustryNames []string `json:"industry_names,omitempty"`
	// Necessaries 必填资质模块配置
	Necessaries []IndustryConfigNecessary `json:"necessaries,omitempty"`
	// Unnecessaries 选填资质模块配置
	Unnecessaries []IndustryConfigUnnecessary `json:"unnecessaries,omitempty"`
}

IndustryConfig 资质规则

type IndustryConfigNecessary added in v1.21.5

type IndustryConfigNecessary struct {
	// PromotionTypeID 推广类型id
	PromotionTypeID uint64 `json:"promotion_type_id,omitempty"`
	// PromotionTypeName 推广类名称
	PromotionTypeName string `json:"promotion_type_name,omitempty"`
	// Rules 具体的资质规则
	Rules []IndustryConfigRule `json:"rules,omitempty"`
}

IndustryConfigNecessary 必填资质模块配置

type IndustryConfigQualType added in v1.21.5

type IndustryConfigQualType struct {
	// QualType 资质类型id
	QualType uint64 `json:"qual_type,omitempty"`
	// QualTypeName 资质类型名称
	QualTypeName string `json:"qual_type_name,omitempty"`
}

IndustryConfigQualType 资质类型

type IndustryConfigRule added in v1.21.5

type IndustryConfigRule struct {
	// RuleID 原子规则id
	RuleID uint64 `json:"rule_id,omitempty"`
	// Type 规则的资质组成类型:1 组合资质 2 多选一资质 可选值:
	// CHOICE 选择(资质规则内资质类型任选>1个类型填写提交)
	// COMPOSE 组合(资质规则内资质类型必须全部填写提交)
	Type enum.IndustryConfigRuleType `json:"type,omitempty"`
	// Description 原子规则描述,用于引导用户提交
	Description string `json:"description,omitempty"`
	// QualTypes 资质类型
	QualTypes []IndustryConfigQualType `json:"qual_types,omitempty"`
}

IndustryConfigRule 具体的资质规则

type IndustryConfigUnnecessary added in v1.21.5

type IndustryConfigUnnecessary struct {
	// CombineID 规则组合id
	CombineID uint64 `json:"combine_id,omitempty"`
	// Description 选填资质场景描述,用于引导用户提交
	Description string `json:"description,omitempty"`
	// Rules 具体的资质规则
	Rules []IndustryConfigRule `json:"rules,omitempty"`
}

IndustryConfigUnnecessary 选填资质模块配置

type Info

type Info struct {
	// ID 广告主ID
	ID uint64 `json:"id,omitempty"`
	// Name 账户名
	Name string `json:"name,omitempty"`
	// Description 品牌描述,即推广内容
	Description string `json:"description,omitempty"`
	// Email 联系邮箱
	Email string `json:"email,omitempty"`
	// Contacter 联系人
	Contacter string `json:"contacter,omitempty"`
	// Phonenumber 手机号码
	Phonenumber string `json:"phonenumber,omitempty"`
	// Address 固定电话
	Address string `json:"address,omitempty"`
	// LiscenseUrl 执照预览地址(链接默认1小时内有效)
	LicenseUrl string `json:"license_url,omitempty"`
	// LicenseNo 执照编号
	LicenseNo string `json:"license_no,omitempty"`
	// LicenseProvice 执照省份
	LicenseProvince string `json:"license_province,omitempty"`
	// LicenseCity 执照城市
	LicenseCity string `json:"license_city,omitempty"`
	// Company 公司名
	Company string `json:"company,omitempty"`
	// Brand 经营类别
	Brand string `json:"brand,omitempty"`
	// Role 角色
	Role enum.AdvertiserRole `json:"role,omitempty"`
	// Status 状态
	Status enum.AdvertiserStatus `json:"status,omitempty"`
	// PromotionArea 运营区域
	PromotionArea string `json:"promotion_area,omitempty"`
	// PromotionCenterProvince 运营省份
	PromotionCenterProvince string `json:"promotion_center_province,omitempty"`
	// PromotionCenterCity 运营城市
	PromotionCenterCity string `json:"promotion_center_city,omitempty"`
	// FirstIndustryName 一级行业名称(新版)
	FirstIndustryName string `json:"first_industry_name,omitempty"`
	// SecondIndustryName 二级行业名称(新版)
	SecondIndustryName string `json:"second_industry_name,omitempty"`
	// Reason 审核拒绝原因
	Reason string `json:"reason,omitempty"`
	// CreateTime 创建时间
	CreateTime string `json:"create_time,omitempty"`
}

Info 广告主信息

type InfoRequest

type InfoRequest struct {
	// AdvertiserIDs 广告主ID集合(如果包含没有访问权限的ID,将返回no permission error) 取值范围: 1-100
	AdvertiserIDs []uint64 `json:"advertiser_ids,omitempty"`
	// Fields 查询字段集合, 默认:查询所有。字段详见下方response字段定义 .允许值: "id", "name","description", "email", "contacter", "phonenumber", "role", "status", "telephone", "address", "reason", "license_url", "license_no", "license_province", "license_city", "company", "brand", "promotion_area", "promotion_center_province", "promotion_center_city", "industry", "balance", "create_time"
	Fields []string `json:"fields,omitempty"`
}

InfoRequest 广告主信息 API Request

func (InfoRequest) Encode

func (r InfoRequest) Encode() string

Encode implement GetRequest interface

type InfoResponse

type InfoResponse struct {
	model.BaseResponse
	// Data json返回值
	Data []Info `json:"data,omitempty"`
}

InfoResponse 广告主信息 API Response

type PublicInfo

type PublicInfo struct {
	// ID 广告主ID
	ID uint64 `json:"id,omitempty"`
	// Name 账户名
	Name string `json:"name,omitempty"`
	// Company 公司名
	Company string `json:"company,omitempty"`
	// FirstIndustryName 一级行业名
	FirstIndustryName string `json:"first_industry_name,omitempty"`
	// SecondIndustryName 二级行业名
	SecondIndustryName string `json:"second_industry_name,omitempty"`
}

PublicInfo 广告主公开信息

type PublicInfoRequest

type PublicInfoRequest struct {
	// AdvertiserIDs 广告主ID集合(如果包含没有访问权限的ID,将返回no permission error) 取值范围: 1-100
	AdvertiserIDs []uint64 `json:"advertiser_ids,omitempty"`
}

PublicInfoRequest 广告主公开信息 API Request

func (PublicInfoRequest) Encode

func (r PublicInfoRequest) Encode() string

Encode implement GetRequest interface

type PublicInfoResponse

type PublicInfoResponse struct {
	model.BaseResponse
	// Data json返回值
	Data []PublicInfo `json:"data,omitempty"`
}

PublicInfoResponse 广告主公开信息 API Response

type Qualification added in v1.9.11

type Qualification struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Status 状态,枚举值:STATUS_NOT_SUBMIT 未提交、STATUS_WAIT_CONFIRM 待审核、STATUS_PENDING_CONFIRM 审核中、STATUS_CONFIRM 审核通过、STATUS_CONFIRM_FAIL 审核不通过
	Status enum.QualificationStatus `json:"status,omitempty"`
	// RejectReason 拒绝理由
	RejectReason string `json:"reject_reason,omitempty"`
	// Subject 主体资质
	Subject *QualificationSubject `json:"subject,omitempty"`
	// Industries 行业资质
	Industries []QualificationIndustry `json:"industries,omitempty"`
}

Qualification 广告主资质

type QualificationCreateRequest added in v1.9.11

type QualificationCreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// QualificationType 资质类型,详见【附录-资质类型】.允许值: "QUALIFICATION_AD"
	QualificationType enum.QualificationType `json:"qualification_type"`
	// Qualifications 资质列表 min>=1 && max<=50
	Qualifications []QualificationForCreate `json:"qualifications,omitempty"`
}

QualificationCreateRequest 批量上传投放资质 API Request

func (QualificationCreateRequest) Encode added in v1.9.11

func (r QualificationCreateRequest) Encode() []byte

Encode implement PostRequest interface

type QualificationForCreate added in v1.9.11

type QualificationForCreate struct {
	// QualificationImgID 资质图片id,通过【上传广告主图片】获得(需指定 upload_to 为 AD)
	QualificationImgID string `json:"qualification_img_id,omitempty"`
	// AdQualificationType 资质图片类型
	// AUTHORIZATION 肖像、商标或其他授权
	// CERTIFY 专利证明
	// TRADEMARK_CERT 商标证
	// AD_DATA_CERT 广告内容中的数据证明
	// INSPECT_REPORT 质检报告
	AdQualificationType enum.AdQualificationType `json:"ad_qualification_type,omitempty"`
}

type QualificationGetRequest added in v1.9.11

type QualificationGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
}

QualificationGetRequest 获取广告主资质(新版) API Request

func (QualificationGetRequest) Encode added in v1.9.11

func (r QualificationGetRequest) Encode() string

Encode implement GetRequest interface

type QualificationGetResponse added in v1.9.11

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

QualificationGetResponse 获取广告主资质(新版) API Response

type QualificationIndustry added in v1.9.11

type QualificationIndustry struct {
	// IndustryID 行业id
	IndustryID uint64 `json:"industry_id,omitempty"`
	// Industry1ID 一级行业ID
	Industry1ID uint64 `json:"industry1_id,omitempty"`
	// Industry1Name 一级行业名称
	Industry1Name string `json:"industry1_name,omitempty"`
	// Industry2ID 二级行业ID
	Industry2ID uint64 `json:"industry2_id,omitempty"`
	// Industry2Name 二级行业名称
	Industry2Name string `json:"industry2_name,omitempty"`
	// Industry3ID 三级行业ID
	Industry3ID uint64 `json:"industry3_id,omitempty"`
	// Industry3Name 三级行业名称
	Industry3Name string `json:"industry3_name,omitempty"`
	// Promotion 推广资质
	Promotion *QualificationPromotion `json:"promotion,omitempty"`
	// Others 开户资质列表
	Others []BaseQualification `json:"others,omitempty"`
	// IsHistory 是否是历史的补充资质及推广资质,如果是,则行业相关字段无值,重新提交时需归档到具体行业下
	IsHistory bool `json:"is_history,omitempty"`
}

QualificationIndustry 行业资质

type QualificationPromotion added in v1.9.11

type QualificationPromotion struct {
	BaseQualification
	// Content 推广内容
	Content string `json:"content,omitempty"`
}

QualificationPromotion 推广资质

type QualificationSelectRequest added in v1.9.11

type QualificationSelectRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
}

QualificationSelectRequest 获取投放资质信息(新版) API Request

func (QualificationSelectRequest) Encode added in v1.9.11

Encode implement GetRequest interface

type QualificationSelectResponse added in v1.9.11

type QualificationSelectResponse struct {
	model.BaseResponse
	// Data json返回值
	Data struct {
		// List 资质列表
		List []AdQualification `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

QualificationSelectResponse 获取投放资质信息(新版)

type QualificationSubject added in v1.9.11

type QualificationSubject struct {
	BaseQualification
	// CompanyName 公司名称
	CompanyName string `json:"company_name,omitempty"`
	// CompanyType 公司类型,枚举值:
	// COMPANY 企业、INDIVIDUAL 个人
	CompanyType string `json:"company_type,omitempty"`
	// CheckType 对公验证类型,枚举值:
	// COMPANY 企业、GOVERNMENT 政府组织机构/事业单位、HK_MACAO_TAIWAN 港澳台、INDIVIDUAL 个人、OTHERS 其他机构(如民办机构)、OVERSEA 海外、SELF_EMPLOY 个体工商户
	CheckType string `json:"check_type,omitempty"`
	// QualificationType 资质类型,枚举值:
	// ASSOCIATION_REGISTER_CODE 社会团体法人登记证书编号
	// COMMERCIAL_REGISTER_NUMBER 商业登记证号码
	// COMPANY_CREDIT_CODE 企业营业执照统一社会信用代码
	// COMPANY_REGISTER_CODE 企业营业执照注册号
	// CREDIT_CODE 统一社会信用代码证书编号
	// HK_MACAO_TAIWAN_ID 港澳/台湾居民往来大陆通行证证件号码
	// HK_REGISTER_CODE 香港公司注册证书编号
	// ID 身份证号
	// INDIVIDUAL_CREDIT_CODE 个体工商户营业执照统一社会信用代码
	// INDIVIDUAL_REGISTER_CODE 个体工商户营业执照注册号
	// LAWYER_CERTIFICATE_NUMBER 律师执业证书执业证号
	// LAWYER_PERMIT_CODE 律师事务所执业许可证编号
	// LEGAL_PERSON_CREDIT_CODE 事业单位法人证书统一社会信用代码
	// ORGANIZATION_REGISTER_CODE 组织机构代码证代号
	// OTHER 其他编号
	// OVERSEA_REGISTER_CODE 外国(地区)企业常驻代表机构登记证编号
	// PASSPORT_ID 护照号
	// SCHOOL_PERMIT_CODE 民办学校办学许可证编号
	// SOCIAL_REGISTER_CODE 民办非企业单位登记证书编号
	QualificationType string `json:"qualification_type,omitempty"`
	// QualificationCode 资质编号
	QualificationCode string `json:"qualification_code,omitempty"`
	// RegisteredNationName 注册国家
	RegisteredNationName string `json:"registered_nation_name,omitempty"`
	// RegisteredProvinceName 注册省份
	RegisteredProvinceName string `json:"registered_province_name,omitempty"`
	// RegisteredCityName 注册城市
	RegisteredCityName string `json:"registered_city_name,omitempty"`
	// HasEffectiveDate 是否有有效日期
	HasEffectiveDate bool `json:"has_effective_date,omitempty"`
	// EffectiveDate 过期时间,格式yyyy-mm-dd
	EffectiveDate string `json:"effective_date,omitempty"`
	// ProprietorName 法人
	ProprietorName string `json:"proprietor_name,omitempty"`
	// Address 详细地址
	Address string `json:"address,omitempty"`
}

QualificationSubject 主体资质

type QualificationSubmitRequest added in v1.9.11

type QualificationSubmitRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Subject 主体资质
	Subject *QualificationSubject `json:"subject,omitempty"`
	// Industries 行业资质
	Industries []QualificationIndustry `json:"industries,omitempty"`
}

QualificationSubmitRequest 提交广告主资质(新版) API Request

func (QualificationSubmitRequest) Encode added in v1.9.11

func (r QualificationSubmitRequest) Encode() []byte

Encode implement PostRequest interface

type TransferableFund added in v1.5.8

type TransferableFund struct {
	// GrantValid 可用赠款余额(单位元)
	GrantValid float64 `json:"grant_valid,omitempty"`
	// CashTransferBalance 可用现金余额(单位元)
	CashTransferBalance float64 `json:"cash_transfer_balance,omitempty"`
	// UnversalPrepayValid 通用预付可用余额(单位元)
	UniversalPrepayValid float64 `json:"universal_prepay_valid,omitempty"`
	// BrandPrepayValid 品牌预付可用余额(单位元)
	BrandPrepayValid float64 `json:"brand_prepay_valid,omitempty"`
	// BidPrepayValid 竞价预付可用余额(单位元)
	BidPrepayValid float64 `json:"bid_prepay_valid,omitempty"`
	// UniversalCreditValid 通用授信可用余额(单位元)
	UniversalCreditValid float64 `json:"universal_credit_valid,omitempty"`
	// BrandCreditValid 品牌授信可用余额(单位元)
	BrandCreditValid float64 `json:"brand_credit_valid,omitempty"`
	// BidCreditValid 竞价授信可用余额(单位元)
	BidCreditValid float64 `json:"bid_credit_valid,omitempty"`
	// DepositAmount 保证金(单位元)
	DepositAmount float64 `json:"deposit_amount,omitempty"`
	// TotalTransferBalance 总可转余额
	TotalTransferBalance float64 `json:"total_transfer_balance,omitempty"`
}

TransferableFund 账户可转余额

type TransferableFundGetRequest added in v1.5.8

type TransferableFundGetRequest struct {
	// AdvertiserID 广告主ID或代理商ID或组织ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
}

TransferableFundGetRequest 查询账户可转余额 API Request

func (TransferableFundGetRequest) Encode added in v1.5.8

Encode implement GetRequest interface

type TransferableFundGetResponse added in v1.5.8

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

TransferableFundGetResponse 查询账户可转余额 API Response

type UpdateBudgetRequest

type UpdateBudgetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// BudgetMode 预算模式
	BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"`
	// Budget 预算值,取值范围:1000~9999999.99,当budget_mode=BUDGET_MODE_DAY时,必填
	// 单位:元; 最小值:0; 精度:小数点后两位
	Budget float64 `json:"budget,omitempty"`
}

UpdateBudgetRequest 更新账户日预算 API Request

func (UpdateBudgetRequest) Encode

func (r UpdateBudgetRequest) Encode() []byte

Encode implement PostRequest interface

Jump to

Keyboard shortcuts

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