agent

package
v1.29.8 Latest Latest
Warning

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

 Go to latest Published: Dec 5, 2024 License: Apache-2.0 Imports: 5 Imported by: 1

Documentation

Overview

Package agent 代理商相关API models

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountAmountDetail added in v1.25.0 

type AccountAmountDetail struct {
	// AccountID 账户id
	AccountID uint64 `json:"account_id,omitempty"`
	// CapitalDetailList 可转资金列表
	CapitalDetailList []CapitalDetail `json:"capital_detail_list,omitempty"`
	// DepositAmount 竞价消耗保证金金额(单位：分)
	DepositAmount int64 `json:"deposit_amount,omitempty"`
	// TotalTransferAmount 总可转金额(单位：分)
	TotalTransferAmount int64 `json:"total_transfer_amount,omitempty"`
}

AccountAmountDetail 账户金额

type AdvertiserCopyItem added in v1.19.2 

type AdvertiserCopyItem struct {
	// Name 新广告主账户名称。不可重复
	Name string `json:"name,omitempty"`
	// AdvertiserID 广告主账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Success 复制是否成功
	Success bool
	// ErrorMsg 当失败时，返回的失败原因
	ErrorMsg string `json:"error_msg,omitempty"`
}

AdvertiserCopyItem 复制账户信息

func (AdvertiserCopyItem) Error added in v1.19.2 

func (i AdvertiserCopyItem) Error() string

Error implement error interface

func (AdvertiserCopyItem) IsError added in v1.19.2 

func (i AdvertiserCopyItem) IsError() bool

IsError returns true if item is error

type AdvertiserCopyRequest added in v1.19.2 

type AdvertiserCopyRequest struct {
	// AgentID 代理商账户ID
	AgentID uint64 `json:"agent_id,omitempty"`
	// AdvertiserID 被复制广告主账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Item 复制账户信息
	Item []AdvertiserCopyItem `json:"item,omitempty"`
	// Copytag 是否复制原广告主账户的账户标签
	CopyTag bool `json:"copy_tag,omitempty"`
	// ReportType 自运营报备类型 可选值:
	// EMPTY 不报备
	// INCREASE_QUANTITY 走量报备
	// SELF_OPERATION 自运营报备
	//  默认值: EMPTY
	Reportype enum.AdvertiserReportType `json:"reportype,omitempty"`
}

AdvertiserCopyRequest 广告主账户复制 API Request

func (AdvertiserCopyRequest) Encode added in v1.19.2 

func (r AdvertiserCopyRequest) Encode() []byte

Encode implement PostRequest interface

type AdvertiserCopyResponse added in v1.19.2 

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

AdvertiserCopyResponse 广告主账户复制 API Response

type AdvertiserCopyResult added in v1.19.2 

type AdvertiserCopyResult struct {
	// CopyStatus 复制结果状态码 可选值:
	// 1 全部成功
	// 2 部分成功
	// 3 全部失败
	CopyStatus enum.AdvertiserCopyStatus `json:"copy_status,omitempty"`
	// Item 复制结果，包括单个账户的失败原因
	Item []AdvertiserCopyItem `json:"item,omitempty"`
}

type AdvertiserRechargeRequest 

type AdvertiserRechargeRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AgentID 代理商ID
	AgentID uint64 `json:"agent_id,omitempty"`
	// TransferType 转账类型，允许值：
	// GRANT 赠款
	// PREPAY_UNIVERSAL 通用预付
	// PREPAY_BRAND 品牌预付
	// PREPAY_BID 竞价预付
	// CREDIT_UNIVERSAL 通用授信
	// CREDIT_BRAND 品牌授信
	// CREDIT_BID 竞价授信
	TransferType AdvertiserTransferType `json:"transfer_type,omitempty"`
	// Amount 金额,单位(元),最低转账金额500元
	Amount float64 `json:"amount,omitempty"`
}

AdvertiserRechargeRequest 代理商转账 API Request

func (AdvertiserRechargeRequest) Encode 

func (r AdvertiserRechargeRequest) Encode() []byte

Encode implement PostRequest interface

type AdvertiserRechargeResponse 

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

AdvertiserRechargeResponse 代理商转账 API Response

type AdvertiserRechargeResponseData 

type AdvertiserRechargeResponseData struct {
	// TransactionSeq 交易序列号
	TransactionSeq string `json:"transaction_seq,omitempty"`
}

AdvertiserRechargeResponseData json返回值

type AdvertiserRefundRequest 

type AdvertiserRefundRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AgentID 代理商ID
	AgentID uint64 `json:"agent_id,omitempty"`
	// TransferType 转账类型，允许值：
	// GRANT 赠款
	// PREPAY_UNIVERSAL 通用预付
	// PREPAY_BRAND 品牌预付
	// PREPAY_BID 竞价预付
	// CREDIT_UNIVERSAL 通用授信
	// CREDIT_BRAND 品牌授信
	// CREDIT_BID 竞价授信
	TransferType AdvertiserTransferType `json:"transfer_type,omitempty"`
	// Amount 金额,单位(元),最低转账金额500元
	Amount float64 `json:"amount,omitempty"`
}

AdvertiserRefundRequest 代理商退款 API Request

func (AdvertiserRefundRequest) Encode 

func (r AdvertiserRefundRequest) Encode() []byte

Encode implement PostRequest interface

type AdvertiserRefundResponse 

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

AdvertiserRefundResponse 代理商退款 API Response

type AdvertiserRefundResponseData 

type AdvertiserRefundResponseData struct {
	// TransactionSeq 交易序列号
	TransactionSeq string `json:"transaction_seq,omitempty"`
}

AdvertiserRefundResponseData json返回值

type AdvertiserSelectRequest 

type AdvertiserSelectRequest struct {
	// AdvertiserID 代理商ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CompanyIDs
	CompanyIDs []string `json:"company_ids,omitempty"`
	// Page 页码.默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面数据量.默认值: 100
	PageSize int `json:"page_size,omitempty"`
	// Cursor 页码游标值，第一次拉取，无需入参
	// 注：page+page_size与cursor+count为两种分页方式
	// cursor+count适用于获取数据记录数≥10000的场景
	Cursor int `json:"cursor,omitempty"`
	// Count 页面数据量，页面数据量
	// 注：page+page_size与cursor+count为两种分页方式
	// cursor+count适用于获取数据记录数≥10000的场景
	Count int `json:"count,omitempty"`
}

AdvertiserSelectRequest 代理商管理账户列表 API Request

func (AdvertiserSelectRequest) Encode 

func (r AdvertiserSelectRequest) Encode() string

Encode implement GetRequest interface

type AdvertiserSelectResponse 

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

AdvertiserSelectResponse 代理商管理账户列表 API Response

type AdvertiserSelectResponseData 

type AdvertiserSelectResponseData struct {
	// List 广告主ID列表
	List []uint64 `json:"list,omitempty"`
	// AccountSource 账号列表的账号类型
	// 枚举值：AD 广告主、STAR 星图、LUBAN 鲁班、DOMESTIC 入海、LOCAL 本地推账户
	AccountSource string `json:"account_source,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// CursorInfo 分页信息
	CursorInfo *model.PageInfo `json:"cursor_info,omitempty"`
}

AdvertiserSelectResponseData json返回值

type AdvertiserTransferType added in v1.13.9 

type AdvertiserTransferType string

AdvertiserTransferType 转账类型 

const (
	// AdvertiserTransferType_GRANT 赠款
	AdvertiserTransferType_GRANT AdvertiserTransferType = "GRANT"
	// AdvertiserTransferType_PREPAY_UNIVERSAL 通用预付
	AdvertiserTransferType_PREPAY_UNIVERSAL AdvertiserTransferType = "PREPAY_UNIVERSAL"
	// AdvertiserTransferType_PREPAY_BRAND 品牌预付
	AdvertiserTransferType_PREPAY_BRAND AdvertiserTransferType = "PREPAY_BRAND"
	// AdvertiserTransferType_PREPAY_BID 竞价预付
	AdvertiserTransferType_PREPAY_BID AdvertiserTransferType = "PREPAY_BID"
	// AdvertiserTransferType_CREDIT_UNIVERSAL 通用授信
	AdvertiserTransferType_CREDIT_UNIVERSAL AdvertiserTransferType = "CREDIT_UNIVERSAL"
	// AdvertiserTransferType_CREDIT_BRAND 品牌授信
	AdvertiserTransferType_CREDIT_BRAND AdvertiserTransferType = "CREDIT_BRAND"
	// AdvertiserTransferType_CREDIT_BID 竞价授信
	AdvertiserTransferType_CREDIT_BID AdvertiserTransferType = "CREDIT_BID"
)

type AdvertiserUpdateRequest 

type AdvertiserUpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Name 账户名称
	Name string `json:"name,omitempty"`
	// Contacter 联系人
	Contacter string `json:"contacter,omitempty"`
	// Phonenumber 手机号码
	Phonenumber string `json:"phonenumber,omitempty"`
	// Telephone 固定电话
	Telephone string `json:"telephone,omitempty"`
	// Note 备注
	Note string `json:"note,omitempty"`
}

AdvertiserUpdateRequest 修改广告主 API Request

func (AdvertiserUpdateRequest) Encode 

func (r AdvertiserUpdateRequest) Encode() []byte

Encode implement PostRequest interface

type AdvertiserUpdateResponse 

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

AdvertiserUpdateResponse 修改广告主 API Response

type AdvertiserUpdateResponseData 

type AdvertiserUpdateResponseData struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// NeedAudit 此次修改是否触发进入待审状态(1表示进入待审状态,0表示不进入待审状态)
	NeedAudit int `json:"need_audit,omitempty"`
}

AdvertiserUpdateResponseData json返回值

type CanTransferDetail added in v1.25.0 

type CanTransferDetail struct {
	// RemitterAccountID 减款方账户id
	RemitterAccountID uint64 `json:"remitter_account_id,omitempty"`
	// CapitalDetailList 减款方可转资金列表
	CapitalDetailList []CapitalDetail `json:"capital_detail_list,omitempty"`
	// PayeeTransferDetailAmountList 加款方可转余额信息列表
	PayeeTransferDetailAmountList []PayeeTransferDetailAmount `json:"payee_transfer_detail_amount_list,omitempty"`
}

CanTransferDetail 可转余额信息

type CapitalDetail added in v1.25.0 

type CapitalDetail struct {
	// CapitalType 可转资金类型 可选值:
	// CREDIT_BIDDING 授信竞价
	// CREDIT_BRAND 授信品牌
	// CREDIT_GENERAL 授信通用
	// PREPAY_BIDDING 预付竞价
	// PREPAY_BRAND 预付品牌
	// PREPAY_GENERAL 预付通用
	CapitalType enum.CapitalType `json:"capital_type,omitempty"`
	// TransferBalance 可转资金金额(单位：分)
	TransferBalance int64 `json:"transfer_balance,omitempty"`
}

CapitalDetail 可转资金

type ChildAgentSelectRequest 

type ChildAgentSelectRequest struct {
	// AdvertiserID 代理商ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Page 页码.默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面数据量.默认值: 100
	PageSize int `json:"page_size,omitempty"`
}

ChildAgentSelectRequest 二级代理商列表 API Request

func (ChildAgentSelectRequest) Encode 

func (r ChildAgentSelectRequest) Encode() string

Encode implement GetRequest interface

type ChildAgentSelectResponse 

type ChildAgentSelectResponse struct {
	model.BaseResponse
	// Data json返回值
	Data struct {
		// ChildAgentIDs 二级代理商ID列表
		ChildAgentIDs []uint64 `json:"child_agent_ids,omitempty"`
	} `json:"data,omitempty"`
}

ChildAgentSelectResponse 二级代理商列表 API Response

type CreateTransferRequest added in v1.25.0 

type CreateTransferRequest struct {
	// BizRequestNo 请求id，推荐uuid，方便请求链路对齐
	BizRequestNo string `json:"biz_request_no,omitempty"`
	// AgentID 代理商账户id
	AgentID uint64 `json:"agent_id,omitempty"`
	// AccountID 锚定账户id，1:N的1
	AccountID uint64 `json:"account_id,omitempty"`
	// TargetAccountDetailList 目标账户列表，1:N的N，需要列表内账户类型相同，最多支持100个
	TargetAccountDetailList []TargetAccountDetail `json:"target_account_detail_list,omitempty"`
	// TransferDirection 转账方向，以目标账户视角确定 可选值:
	// TRANSFER_IN 转入
	// TRANSFER_OUT 转出
	TransferDirection enum.TransferDirection `json:"transfer_direction,omitempty"`
}

CreateTransferRequest 转账-发起转账（代理） API Request

func (CreateTransferRequest) Encode added in v1.25.0 

func (r CreateTransferRequest) Encode() []byte

Encode implements PostRequest interface

type CreateTransferResponse added in v1.25.0 

type CreateTransferResponse struct {
	model.BaseResponse
	Data struct {
		// TransferSerial 转账单号
		TransferSerial string `json:"transfer_serial,omitempty"`
	} `json:"data,omitempty"`
}

CreateTransferResponse 转账-发起转账（代理） API Response

type FundTransferSeqCommitRequest added in v1.13.9 

type FundTransferSeqCommitRequest struct {
	// AgentID 代理商账户ID
	AgentID uint64 `json:"agent_id,omitempty"`
	// TransferSeq 转账序列号
	TransferSeq string `json:"transfer_seq,omitempty"`
}

FundTransferSeqCommitRequest 提交转账交易号（方舟） API Request

func (FundTransferSeqCommitRequest) Encode added in v1.13.9 

func (r FundTransferSeqCommitRequest) Encode() []byte

Encode implement PostRequest interface

type FundTransferSeqCreateRequest added in v1.13.9 

type FundTransferSeqCreateRequest struct {
	// AgentID 代理商账户ID
	AgentID uint64 `json:"agent_id,omitempty"`
	// AccountID 广告主账户ID
	AccountID uint64 `json:"account_id,omitempty"`
	// TransferType 转账类型 可选值:
	// CASH_DEFAULT 非赠款金额
	// CREDIT_BIDDING 授信-竞价专用金额
	// CREDIT_BRAND 授信-品牌专用金额
	// CREDIT_GENERAL 授信-通用金额
	// GRANT_GENERAL 赠款金额
	// PREPAY_BIDDING 预付-竞价专用金额
	// PREPAY_BRAND 预付-品牌专用金额
	// PREPAY_GENERAL 预付-通用金额
	TransferType FundTransferType `json:"transfer_type,omitempty"`
	// Amount 转账金额，单位元，支持两位小数
	Amount float64 `json:"amount,omitempty"`
}

FundTransferSeqCreateRequest 创建转账交易号（方舟） API Request

func (FundTransferSeqCreateRequest) Encode added in v1.13.9 

func (r FundTransferSeqCreateRequest) Encode() []byte

Encode implement PostRequest interface

type FundTransferSeqCreateResponse added in v1.13.9 

type FundTransferSeqCreateResponse struct {
	model.BaseResponse
	Data struct {
		// TransferSeq 转账序列号，第二步提交操作需要
		TransferSeq string `json:"transfer_seq,omitempty"`
		// Status 状态码，0表示成功，其余表示失败
		Status int `json:"status,omitempty"`
		// StatusMessage 转账失败原因
		StatusMessage string `json:"status_message,omitempty"`
	} `json:"data,omitempty"`
}

FundTransferSeqCreateResponse 创建转账交易号（方舟） API Response

type FundTransferType added in v1.13.9 

type FundTransferType string

FundTransferType 转账类型(方舟) 

const (
	// FundTransferType_CASH_DEFAULT 非赠款金额
	FundTransferType_CASH_DEFAULT FundTransferType = "CASH_DEFAULT"
	// FundTransferType_CREDIT_BIDDING 授信-竞价专用金额
	FundTransferType_CREDIT_BIDDING FundTransferType = "CREDIT_BIDDING"
	// FundTransferType_CREDIT_BRAND 授信-品牌专用金额
	FundTransferType_CREDIT_BRAND FundTransferType = "CREDIT_BRAND"
	// FundTransferType_CREDIT_GENERAL 授信-通用金额
	FundTransferType_CREDIT_GENERAL FundTransferType = "CREDIT_GENERAL"
	// FundTransferType_GRANT_GENERAL 赠款金额
	FundTransferType_GRANT_GENERAL FundTransferType = "GRANT_GENERAL"
	// FundTransferType_PREPAY_BIDDING 预付-竞价专用金额
	FundTransferType_PREPAY_BIDDING FundTransferType = "PREPAY_BIDDING"
	// FundTransferType_PREPAY_BRAND 预付-品牌专用金额
	FundTransferType_PREPAY_BRAND FundTransferType = "PREPAY_BRAND"
	// FundTransferType_PREPAY_GENERAL 预付-通用金额
	FundTransferType_PREPAY_GENERAL FundTransferType = "PREPAY_GENERAL"
)

type Info 

type Info struct {
	// AgentID 代理商ID
	AgentID uint64 `json:"agent_id,omitempty"`
	// AgentName 代理商名称
	AgentName string `json:"agent_name,omitempty"`
	// CustomerID 客户id
	CustomerID uint64 `json:"customer_id,omitempty"`
	// CompanyID 公司id
	CompanyID uint64 `json:"company_id,omitempty"`
	// CompanyName 公司名称
	CompanyName string `json:"company_name,omitempty"`
	// AccountStatus 用户状态
	AccountStatus string `json:"account_status,omitempty"`
	// CreateTime 注册时间
	CreateTime string `json:"create_time,omitempty"`
	// Role 角色
	Role string `json:"role,omitempty"`
}

Info 代理商信息

type InfoRequest 

type InfoRequest struct {
	// AdvertiserIDs 代理商ids
	AdvertiserIDs []uint64 `json:"advertiser_ids,omitempty"`
	// Fields 查询字段集合, 如果指定, 则返回结果数组中, 每个元素是包含所查询字段的字典，默认全部指定.允许值: "agent_id", "agent_name", "customer_id", "customer_name","company_id", "company_name", "create_time", "role"
	Fields []string `json:"fields,omitempty"`
}

InfoRequest 获取代理商信息 API Request

func (InfoRequest) Encode 

func (r InfoRequest) Encode() string

Encode implement GetRequest inteface

type InfoResponse 

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

InfoResponse 获取代理商信息 API Response

type PayeeTransferDetailAmount added in v1.25.0 

type PayeeTransferDetailAmount struct {
	// PayeeAccountID 加款方账户id
	PayeeAccountID uint64 `json:"payee_account_id,omitempty"`
	// CapitalDetailList 加款方可转资金列表
	CapitalDetailList []CapitalDetail `json:"capital_detail_list,omitempty"`
}

PayeeTransferDetailAmount 加款方可转余额信息

type QueryCanTransferBalanceRequest added in v1.25.0 

type QueryCanTransferBalanceRequest struct {
	// BizRequestNo 请求id，推荐uuid，方便请求链路对齐
	BizRequestNo string `json:"biz_request_no,omitempty"`
	// AgentID 代理商账户id
	AgentID uint64 `json:"agent_id,omitempty"`
	// AccountID 锚定账户id，1:N的1
	AccountID uint64 `json:"account_id,omitempty"`
	// TargetAccountIDList 目标账户id列表，1:N的N，需要列表内账户类型相同，最多支持100个
	TargetAccountIDList []uint64 `json:"target_account_id_list,omitempty"`
	// TransferDirection 转账方向，以目标账户视角确定 可选值:
	// TRANSFER_IN 转入
	// TRANSFER_OUT 转出
	TransferDirection enum.TransferDirection `json:"transfer_direction,omitempty"`
}

QueryCanTransferBalanceRequest 转账-获取最大可转余额（代理） API Request

func (QueryCanTransferBalanceRequest) Encode added in v1.25.0 

func (r QueryCanTransferBalanceRequest) Encode() string

Encode implements GetRequest interface

type QueryCanTransferBalanceResponse added in v1.25.0 

type QueryCanTransferBalanceResponse struct {
	model.BaseResponse
	Data struct {
		// CanTransferDetailList 可转余额信息列表
		CanTransferDetailList []CanTransferDetail `json:"can_transfer_detail_list,omitempty"`
	} `json:"data,omitempty"`
}

QueryCanTransferBalanceResponse 转账-获取最大可转余额（代理） API Response

type QueryRiskPromotionListFilter added in v1.27.8 

type QueryRiskPromotionListFilter struct {
	//   PromotionStatus 广告状态 可选值:
	// ADV_OFFLINE_BUDGET adv账户超出预算
	// ADV_PRE_OFFLINE_BUDGET adv账户接近预算
	// AUDIT 广告新建审核中
	// AWEME_ACCOUNT_DISABLED 关联抖音账号不可投
	// AWEME_ANCHOR_DISABLED 关联锚点不可投
	// CREATE 广告新建
	// DELETE 已删除
	// DELIVERY_OK 投放中
	// ERROR_DEFAULT 补偿态
	// FROZEN 已终止
	// LIVE_ROOM_OFF 关联直播间不可投
	// NO_SCHEDULE 不在投放时间段内
	// OFFLINE_AUDIT 广告审核不通过
	// PRE_ONLINE 预上线（目前推广管理不披露，仅quota计算）
	// PRODUCT_OFFLINE 关联商品不可投
	// PROJECT_DISABLE 已被项目暂停
	// PROJECT_OFFLINE_BUDGET 项目超出预算
	// PROJECT_PRE_OFFLINE_BUDGET 项目接近预算
	// PROMOTION_DISABLE 广告暂停
	// PROMOTION_OFFLINE_BALANCE 广告余额不足
	// PROMOTION_OFFLINE_BUDGET 广告超出预算
	// PROMOTION_PRE_OFFLINE_BUDGET 广告接近预算
	// PROMOTION_QUOTA_LIMIT 因为quota限额暂停
	// RE_AUDIT 广告重新送审
	// TIME_DONE 已完成
	// TIME_NO_REACH 未达到投放时间
	PromotionStatus enum.PromotionStatus `json:"promotion_status,omitempty"`
	// IllegalMaterialIDs 违规素材ids，最多支持100个
	IllegalMaterialIDs []uint64 `json:"illegal_material_ids,omitempty"`
	// AdvertiserIDs 广告主账户ID，最多支持100个
	AdvertiserIDs []uint64 `json:"advertiser_ids,omitempty"`
	// AdvertiserName 广告主账户名称，模糊搜索，长度不能超过30
	AdvertiserName string `json:"advertiser_name,omitempty"`
	// FinalOperatorTag 自走收综合标签（T+1后数据稳定） 可选值:
	// DECREASE_QUANTITY 走量
	// EMPTY 无标签
	// INCREASE_QUANTITY 收量
	// SELF_OPERATION 自运营
	FinalOperatorTag enum.AdvertiserReportType `json:"final_operator_tag,omitempty"`
}

type QueryRiskPromotionListRequest added in v1.27.8 

type QueryRiskPromotionListRequest struct {
	// AgentID 代理商账户ID
	AgentID uint64 `json:"agent_id,omitempty"`
	// BusinessType 业务线
	// AD 巨量广告（默认值），获取巨量广告账户下的违规广告信息
	BusinessType string `json:"business_type,omitempty"`
	// StartDate 推送开始时间，比如：2024-03-01
	StartDate string `json:"start_date,omitempty"`
	// EndDate 推送结束时间，比如：2024-03-01（最长跨度31天）
	EndDate string `json:"end_date,omitempty"`
	// Cursor 页码游标值，初始从Long.MAX开始，后续传入返回的cursor值，不传值相当于page=1，查询count条数据
	Cursor int `json:"cursor,omitempty"`
	// Count 页码游标值，最大支持500
	Count int `json:"count,omitempty"`
	// Filtering 过滤器
	Filtering *QueryRiskPromotionListFilter `json:"filtering,omitempty"`
}

QueryRiskPromotionListRequest 【代理商】查询广告违规信息 API Request

func (QueryRiskPromotionListRequest) Encode added in v1.27.8 

func (r QueryRiskPromotionListRequest) Encode() string

Encode implements GetRequest interface

type QueryRiskPromotionListResponse added in v1.27.8 

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

QueryRiskPromotionListResponse 查询广告违规信息 API Response

type QueryRiskPromotionListResult added in v1.27.8 

type QueryRiskPromotionListResult struct {
	// CursorInfo 分页信息
	CursorInfo *model.PageInfo `json:"cursor_info,omitempty"`
	// Data 违规广告列表
	Data []RiskPromotion `json:"data,omitempty"`
}

type QueryTransferBalanceRequest added in v1.25.0 

type QueryTransferBalanceRequest struct {
	// BizRequestNo 请求id，推荐uuid，方便请求链路对齐
	BizRequestNo string `json:"biz_request_no,omitempty"`
	// AgentID 代理商账户id
	AgentID uint64 `json:"agent_id,omitempty"`
	// AccountIDList 查询账户id列表
	AccountIDList []uint64 `json:"account_id_list,omitempty"`
}

QueryTransferBalanceRequest 转账-查询账户转账余额（代理） API Request

func (QueryTransferBalanceRequest) Encode added in v1.25.0 

func (r QueryTransferBalanceRequest) Encode() string

Encode implements GetRequest interface

type QueryTransferBalanceResponse added in v1.25.0 

type QueryTransferBalanceResponse struct {
	model.BaseResponse
	Data struct {
		// AccountAmountDetailList 账户金额列表
		AccountAmountDetailList []AccountAmountDetail `json:"account_amount_detail_list,omitempty"`
	} `json:"data,omitempty"`
}

QueryTransferBalanceResponse 转账-查询账户转账余额（代理） API Response

type QueryTransferDetailRequest added in v1.25.0 

type QueryTransferDetailRequest struct {
	// BizRequestNo 请求id，推荐uuid，方便请求链路对齐
	BizRequestNo string `json:"biz_request_no,omitempty"`
	// AgentID 代理商账户id
	AgentID uint64 `json:"agent_id,omitempty"`
	// TransferBizRequestNo 发起转账的幂等id
	TransferBizRequestNo string `json:"transfer_biz_request_no,omitempty"`
	// TransferSerial 转账单号，与transfer_biz_request_no两者传其一即可
	TransferSerial string `json:"transfer_serial,omitempty"`
}

QueryTransferDetailRequest 转账-查询转账单信息（代理） API Request

func (QueryTransferDetailRequest) Encode added in v1.25.0 

func (r QueryTransferDetailRequest) Encode() string

Encode implements GetRequest interface

type QueryTransferDetailResponse added in v1.25.0 

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

QueryTransferDetailResponse 转账-查询转账单信息（代理） API Response

type RiskMaterial added in v1.27.8 

type RiskMaterial struct {
	// ID 素材ID（落地页站点ID）
	ID uint64 `json:"id,omitempty"`
	// Type 素材类型 可选值:
	// IMAGE 图片
	// VIDEO 视频
	// SITE 落地页
	Type string `json:"type,omitempty"`
	// RiskContent 素材违规原因，比如：["违规内容1", "违规内容2"]
	RiskContent []string `json:"risk_content,omitempty"`
	// RefPromotionIDs 同代理商账户下的其他关联广告ID
	RefPromotionIDs []uint64 `json:"ref_promotion_ids,omitempty"`
	// RefPromotionList 同代理商账户下的其他关联广告信息，只披露近七天有投放消耗的关联广告
	RefPromotionList []RiskPromotion `json:"ref_promotion_list,omitempty"`
}

RiskMaterial 违规素材

type RiskPromotion added in v1.27.8 

type RiskPromotion struct {
	// PromotionID 广告ID
	PromotionID uint64 `json:"promotion_id,omitempty"`
	// PromotionName 广告名称
	PromotionName string `json:"promotion_name,omitempty"`
	// PromotionStatus 广告状态，同入参promotion_status枚举 可选值:
	// ADV_OFFLINE_BUDGET adv账户超出预算
	// ADV_PRE_OFFLINE_BUDGET adv账户接近预算
	// AUDIT 广告新建审核中
	// AWEME_ACCOUNT_DISABLED 关联抖音账号不可投
	// AWEME_ANCHOR_DISABLED 关联锚点不可投
	// CREATE 广告新建
	// DELETE 已删除
	// DELIVERY_OK 投放中
	// ERROR_DEFAULT 补偿态
	// FROZEN 已终止
	// LIVE_ROOM_OFF 关联直播间不可投
	// NO_SCHEDULE 不在投放时间段内
	// OFFLINE_AUDIT 广告审核不通过
	// PRE_ONLINE 预上线（目前推广管理不披露，仅quota计算）
	// PRODUCT_OFFLINE 关联商品不可投
	// PROJECT_DISABLE 已被项目暂停
	// PROJECT_OFFLINE_BUDGET 项目超出预算
	// PROJECT_PRE_OFFLINE_BUDGET 项目接近预算
	// PROMOTION_DISABLE 广告暂停
	// PROMOTION_OFFLINE_BALANCE 广告余额不足
	// PROMOTION_OFFLINE_BUDGET 广告超出预算
	// PROMOTION_PRE_OFFLINE_BUDGET 广告接近预算
	// PROMOTION_QUOTA_LIMIT 因为quota限额暂停
	// RE_AUDIT 广告重新送审
	// TIME_DONE 已完成
	// TIME_NO_REACH 未达到投放时间
	PromotionStatus enum.PromotionStatus `json:"promotion_status,omitempty"`
	// MaterialList 违规素材列表，包含广告下投前+投中拒审的素材信息
	MaterialList []RiskMaterial `json:"material_list,omitempty"`
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdvertiserName 广告主账户名称
	AdvertiserName string `json:"advertiser_name,omitempty"`
	// CompanyID 广告主公司ID
	CompanyID uint64 `json:"company_id,omitempty"`
	// CompanyName 广告主公司名称
	CompanyName string `json:"company_name,omitempty"`
	// AgentID 代理商账户ID
	AgentID uint64 `json:"agent_id,omitempty"`
	// AgentName 代理商账户名称
	AgentName string `json:"agen_name,omitempty"`
	// AgentCompanyID 代理商公司ID
	AgentCompanyID uint64 `json:"agent_company_id,omitempty"`
	// AgentCompanyName 代理商公司名称
	AgentCompanyName string `json:"agent_company_name,omitempty"`
	// FirstAgentCompanyID 一代代理商公司ID
	FirstAgentCompanyID uint64 `json:"first_agent_company_id,omitempty"`
	// FirstAgentCompanyName 一代代理商公司名称
	FirstAgentCompanyName string `json:"first_agent_company_name,omitempty"`
	// BusinessType 业务线，同入参business_type枚举 可选值:
	// AD 巨量广告
	BusinessType string `json:"business_type,omitempty"`
	// FinalOperatorTag 自走收综合标签，同入参final_operator_tag枚举 可选值:
	// DECREASE_QUANTITY 走量
	// EMPTY 无标签
	// INCREASE_QUANTITY 收量
	// SELF_OPERATION 自运营
	FinalOperatorTag enum.AdvertiserReportType `json:"final_operator_tag,omitempty"`
	// OptimizerID 优化师ID
	OptimizerID uint64 `json:"optimizer_id,omitempty"`
	// OptimizerName 优化师姓名
	OptimizerName string `json:"optimizer_name,omitempty"`
	// CollaboratorIDs 协作者ID
	CollaboratorIDs []uint64 `json:"collaborator_ids,omitempty"`
	// CollaboratorNames 协作者姓名
	CollaboratorNames []string `json:"collaborator_names,omitempty"`
	// SendTime 推送时间
	SendTime string `json:"send_time,omitempty"`
	// ID 记录的唯一ID
	ID uint64 `json:"id,omitempty"`
}

RiskPromotion 违规广告

type TargetAccountDetail added in v1.25.0 

type TargetAccountDetail struct {
	// AccountID 目标账户id
	AccountID uint64 `json:"account_id,omitempty"`
	// TransferCapitalDetailList 锚定账户与目标账户转账资金列表
	TransferCapitalDetailList []CapitalDetail `json:"transfer_capital_detail_list,omitempty"`
}

TargetAccountDetail 目标账户

type TransferCapitalRecord added in v1.25.0 

type TransferCapitalRecord struct {
	// CapitalType 可转资金类型 可选值:
	// CREDIT_BIDDING 授信竞价
	// CREDIT_BRAND 授信品牌
	// CREDIT_GENERAL 授信通用
	// PREPAY_BIDDING 预付竞价
	// PREPAY_BRAND 预付品牌
	// PREPAY_GENERAL 预付通用
	CapitalType enum.CapitalType `json:"capital_type,omitempty"`
	// TransferBalance 可转资金金额(单位：分)
	TransferBalance int64 `json:"transfer_balance,omitempty"`
	// TransferStatus转账资金状态 可选值:
	// NO_TRANSFER 未转账
	// TRANSFER_FAILED 转账失败(终态)
	// TRANSFER_ING 转账中
	// TRANSFER_PART 转账部分成功(终态)
	// TRANSFER_SUCCESS 转账成功(终态)
	TransferStatus enum.TransferStatus `json:"transfer_status,omitempty"`
	// FailReason 失败原因
	FailReason string `json:"fail_reason,omitempty"`
}

TransferCapitalRecord 转账资金类型

type TransferDetail added in v1.25.0 

type TransferDetail struct {
	// TransferSerial 转账单号
	TransferSerial string `json:"transfer_serial,omitempty"`
	// BizRequestNo 幂等id
	BizRequestNo string `json:"biz_request_no,omitempty"`
	// TransferDirection 转账方向(以目标账户视角确定) 可选值:
	// TRANSFER_IN 转入
	// TRANSFER_OUT 转出
	TransferDirection enum.TransferDirection `json:"transfer_direction,omitempty"`
	// TransferAmount 转账总金额(单位：分)
	TransferAmount int64 `json:"transfer_amount,omitempty"`
	// TransferStatus 转账总状态 可选值:
	// NO_TRANSFER 未转账
	// TRANSFER_FAILED 转账失败(终态)
	// TRANSFER_ING 转账中
	// TRANSFER_PART 转账部分成功(终态)
	// TRANSFER_SUCCESS 转账成功(终态)
	TransferStatus enum.TransferStatus `json:"transfer_status,omitempty"`
	// TransferFinishTime 转账完成时间
	TransferFinishTime string `json:"transfer_finish_time,omitempty"`
	// TransferCreateTime 转账创建时间
	TransferCreateTime string `json:"transfer_create_time,omitempty"`
	// TransferTargetRecordList 账户信息列表
	TransferTargetRecordList []TransferTargetRecord `json:"transfer_target_record_list,omitempty"`
}

TransferDetail 转账详情

type TransferTargetRecord added in v1.25.0 

type TransferTargetRecord struct {
	// AccountID 锚定账户id，1:N的1
	AccountID uint64 `json:"account_id,omitempty"`
	// TargetAccountID 目标账户id，1:N的N
	TargetAccountID uint64 `json:"target_account_id,omitempty"`
	// TransferAmount 转账金额(单位：分)
	TransferAmount int64 `json:"transfer_amount,omitempty"`
	// TransferStatus 账户间转账状态 可选值:
	// NO_TRANSFER 未转账
	// TRANSFER_FAILED 转账失败(终态)
	// TRANSFER_ING 转账中
	// TRANSFER_PART 转账部分成功(终态)
	// TRANSFER_SUCCESS 转账成功(终态)
	TransferStatus enum.TransferStatus `json:"transfer_status,omitempty"`
	// TransferCapitalRecordList 转账资金类型列表
	TransferCapitalRecordList []TransferCapitalRecord `json:"transfer_capital_record_list,omitempty"`
}

TransferTargetRecord 账户信息

type TransferTransactionRecord added in v1.25.1 

type TransferTransactionRecord struct {
	// ModifyTime 转账时间
	ModifyTime string `json:"modity_time,omitempty"`
	// Remitter 转账时间转出方账户ID
	Remitter model.Uint64 `json:"remitter,omitempty"`
	// RemitterFirstAdAgentID 转出方一代账户ID
	RemitterFirstAdAgentID model.Uint64 `json:"remitter_first_ad_agent_id,omitempty"`
	// RemitterFirstAdAgentName 转出方一代账户名称
	RemitterFirstAdAgentName string `json:"remitter_first_ad_agent_name,omitempty"`
	// RemitterSecondAdAgentID 转出方二代账户ID
	RemitterSecondAdAgentID model.Uint64 `json:"remitter_second_ad_agent_id,omitempty"`
	// PayeeFirstAdAgentID 转入方一代账户ID
	PayeeFirstAdAgentID model.Uint64 `json:"payee_first_ad_agent_id,omitempty"`
	// PayeeFirstAdAgentName 转入方一代账户名称
	PayeeFirstAdAgentName string `json:"payee_first_ad_agent_name,omitempty"`
	// PayeeSecondAdAgentID 转入方二代账户ID
	PayeeSecondAdAgentID model.Uint64 `json:"payee_second_ad_agent_id,omitempty"`
	// RemitterName 转出方账户名称
	RemitterName string `json:"remitter_name,omitempty"`
	// RemitterCustomerName 转出方客户名称
	RemitterCustomerName string ` json:"remitter_customer_name,omitempty"`
	// RemitterCustomerID 转出方客户ID
	RemitterCustomerID model.Uint64 `json:"remitter_customer_id,omitempty"`
	// Payee 转入方账户ID
	Payee model.Uint64 `json:"payee,omitempty"`
	// PayeeName 转入方账户名称
	PayeeName string `json:"payee_name,omitempty"`
	// PayeeRole 转入方账户类型:
	// ROLE_ADVERTISER 普通广告主
	// ROLE_ADVERTISER_SYSTEM_ACCOUNT 广告主系统账号
	// ROLE_AGENT 广告代理商
	// ROLE_AGENT_SYSTEM_ACCOUNT 代理商系统账号
	// ROLE_CHILD_AGENT 代理子账户
	// ROLE_ECP_VIRTUAL_ADVERTISER 千川虚拟广告主
	// ROLE_LOCAL_LIFE_VIRTUAL_ADVERTISER 本地虚拟广告主
	// ROLE_VIRTAUL_ADVERTISER 虚拟广告主
	PayeeRole enum.AdvertiserRole `json:"payee_role,omitempty"`
	// RemitterRole 转出方账户类型 :
	// ROLE_ADVERTISER 普通广告主
	// ROLE_ADVERTISER_SYSTEM_ACCOUNT 广告主系统账号
	// ROLE_AGENT 广告代理商
	// ROLE_AGENT_SYSTEM_ACCOUNT 代理商系统账号
	// ROLE_CHILD_AGENT 代理子账户
	// ROLE_ECP_VIRTUAL_ADVERTISER 千川虚拟广告主
	// ROLE_LOCAL_LIFE_VIRTUAL_ADVERTISER 本地虚拟广告主
	// ROLE_VIRTAUL_ADVERTISER 虚拟广告主
	RemitterRole enum.AdvertiserRole `json:"remitter_role,omitempty"`
	// PayeeCustomerName 转入方客户名称
	PayeeCustomerName string `json:"payee_customer_name,omitempty"`
	// PayeeCustomerID 转入方客户ID
	PayeeCustomerID model.Uint64 `json:"payee_customer_id,omitempty"`
	// Amount 总金额（元）
	Amount float64 `json:"amount,omitempty"`
	// PrepayAmount 预付金额（元）
	PrepayAmount float64 `json:"prepay_amount,omitempty"`
	// CreditAmount 授信金额额（元）
	CreditAmount float64 `json:"credit_amount,omitempty"`
	// Cash 非赠款金额(元)
	Cash float64 `json:"cash,omitempty"`
	// Grants 赠款金额(元)
	Grants float64 `json:"grants,omitempty"`
	// TransferType 转账类型:
	// ADD_MONEY
	// MUTUAL_TRANSFER
	// REFUND_MONEY
	TransferType string `json:"transfer_type,omitempty"`
	// Platform 业务平台:
	// AD 巨量广告
	// EFFECT 效果联盟
	// STAR 巨量星图
	// TRUSTEESHIP_MARKETING 托管营销
	// ZTT 智投通
	Platform string `json:"platform,omitempty"`
	// Operator 操作人名称
	Operator string `json:"operator,omitempty"`
	// OperatorID 操作人ID
	OperatorID model.Uint64 `json:"operator_id,omitempty"`
	// TransferOrderSerial 转账订单号
	TransferOrderSerial string `json:"transfer_order_serial,omitempty"`
	// TransferTargetPayStatus 转账状态 可选值:
	// NO_TRANSFER 未转账
	// TRANSFER_FAILED 转账失败
	// TRANSFER_ING 转账中
	// TRANSFER_PART TRANSFER_PART
	// TRANSFER_SUCCESS 转账成功
	TransferTargetPayStatus enum.TransferStatus `json:"transfer_target_pay_status,omitempty"`
	// Remark 转账备注
	Remark string `json:"remark,omitempty"`
}

TransferTransactionRecord 代理商转账记录

type TransferTransactionRecordFilter added in v1.25.1 

type TransferTransactionRecordFilter struct {
	// CustomerIDs 转入/转出方客户
	CustomerIDs []uint64 `json:"customer_ids,omitempty"`
	// AccountIDs 转入/转出方账户
	AccountIDs []uint64 `json:"account_ids,omitempty"`
	// Payees 转入方账号
	Payees []uint64 `json:"payees,omitempty"`
	// PayeeCustomerIDs 转入方客户
	PayeeCustomerIDs []uint64 `json:"payee_customer_ids,omitempty"`
	// Remitters 转出方账户
	Remitters []uint64 `json:"remitters,omitempty"`
	// RemitterCustomerIDs 转出方客户
	RemitterCustomerIDs []uint64 `json:"remitter_customer_ids,omitempty"`
	// OperatorIDs 操作人
	OperatorIDs []uint64 `json:"operator_ids,omitempty"`
	// TransferOrderSerial 转账编号
	TransferOrderSerial string `json:"transfer_order_serial,omitempty"`
	// TransferType 转账类型 可选值:
	// ADD_MONEY 加款
	// MUTUAL_TRANSFER 同级账户转账
	// REFUND_MONEY 退款
	TransferType string `json:"transfer_type,omitempty"`
	// RemitterType 转出方账户类型 可选值:
	// ROLE_ADVERTISER 广告主
	// ROLE_AGENT 广告代理商
	// ROLE_CHILD_AGENT 代理子账户
	// ROLE_ECP_VIRTUAL_ADVERTISER 千川虚拟广告主
	// ROLE_LOCAL_LIFE_VIRTUAL_ADVERTISER 本地虚拟广告主
	// ROLE_VIRTAUL_ADVERTISER 虚拟广告主
	RemitterType enum.AdvertiserRole `json:"remitter_type,omitempty"`
	// PayeeType 转入方账户类型 可选值:
	// ROLE_ADVERTISER 广告主
	// ROLE_AGENT 广告代理商
	// ROLE_CHILD_AGENT 代理子账户
	// ROLE_ECP_VIRTUAL_ADVERTISER 千川虚拟广告主
	// ROLE_LOCAL_LIFE_VIRTUAL_ADVERTISER 本地虚拟广告主
	// ROLE_VIRTAUL_ADVERTISER 虚拟广告主
	PayeeType enum.AdvertiserRole `json:"payee_type,omitempty"`
	// Platform 业务平台 可选值:
	// AD 巨量广告
	// EFFECT 效果联盟
	// STAR 巨量星图
	// TRUSTEESHIP_MARKETING 托管营销
	// ZTT 智投通
	Platform string `json:"platform,omitempty"`
	// RemitterFirstAdAgentID 转出方代理商账户
	RemitterFirstAdAgentID uint64 `json:"remitter_first_ad_agent_id,omitempty"`
	// PayeeFirstAdAgentID 转入方代理商账户
	PayeeFirstAdAgentID uint64 `json:"payee_first_ad_agent_id,omitempty"`
}

TransferTransactionRecordFilter 查询代理商转账记录过滤条件

type TransferTransactionRecordRequest added in v1.25.1 

type TransferTransactionRecordRequest struct {
	// AgentID 代理商id
	AgentID uint64 `json:"agent_id,omitempty"`
	// StartDate 开始时间，格式 yyyy-MM-dd，最远可以查询3年内的数据
	StartDate string `json:"start_date,omitempty"`
	// EndDate 结束时间，格式 yyyy-MM-dd，最远可以查询3年内的数据
	EndDate string `json:"end_date,omitempty"`
	// Page 页码
	Page int `json:"page,omitempty"`
	// PageSize 每页条数
	PageSize int `json:"page_size,omitempty"`
	// Filtering  过滤器
	Filtering *TransferTransactionRecordFilter `json:"filtering,omitempty"`
}

TransferTransactionRecordRequest 查询代理商转账记录 API Request

func (TransferTransactionRecordRequest) Encode added in v1.25.1 

func (r TransferTransactionRecordRequest) Encode() string

Encode implements GetRequest interfafce

type TransferTransactionRecordResponse added in v1.25.1 

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

TransferTransactionRecordResponse 查询代理商转账记录 API Response

type TransferTransactionRecordResult added in v1.25.1 

type TransferTransactionRecordResult struct {
	Records  []TransferTransactionRecord `json:"records,omitempty"`
	PageInfo *model.PageInfo             `json:"page_info,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.