Documentation ¶
Overview ¶
Package customercenter 管家账号(工作台)相关API models
Index ¶
- Constants
- type Advertiser
- type AdvertiserListData
- type AdvertiserListFilter
- type AdvertiserListRequest
- type AdvertiserListResponse
- type AdvertiserTransferableListData
- type AdvertiserTransferableListRequest
- type AdvertiserTransferableListResponse
- type AdvertiserType
- type CanTransferBalanceGetRequest
- type CanTransferBalanceGetResponse
- type CanTransferDetail
- type CanTransferTargetListRequest
- type CanTransferTargetListResponse
- type CanTransferTargetListResult
- type CapitalDetail
- type FundTransferSeqCommitRequest
- type FundTransferSeqCommitResponse
- type FundTransferSeqCreateRequest
- type FundTransferSeqCreateResponse
- type PayeeTransferAmountDetail
- type TargetAmountDetail
- type TransferAccountType
- type TransferBalanceGetRequest
- type TransferBalanceGetResponse
- type TransferCapitalRecord
- type TransferCreateRequest
- type TransferCreateResponse
- type TransferDetail
- type TransferDetailGetRequest
- type TransferDetailGetResponse
- type TransferTarget
- type TransferTargetRecord
- type TransferType
Constants ¶
const ( // TransferAccountType_PAYEE 可转入账户(我可向谁转账) TransferAccountType_PAYEE = "PAYEE" // TransferAccountType_REMITTER 可转出账户(谁可向我转账) TransferAccountType_REMITTER = "REMITTER" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advertiser ¶
type Advertiser struct { // ID 广告主id ID uint64 `json:"advertiser_id,omitempty"` // Name 广告主名称(一个对象只会返回企业号和广告主其中一种) Name string `json:"advertiser_name,omitempty"` // AdvertiserType 广告主类型 // 枚举值:DOU+ DOU+类广告主账号、NORMAL普通广告主帐号 // DOU+类广告主账号不支持任何调用接口操作 Type AdvertiserType `json:"advertiser_type,omitempty"` // EDouyinID 企业号id(一个对象只会返回企业号和广告主其中一种) EDouyinID string `json:"e_douyin_id,omitempty"` // EDouyinName 企业号名称(一个对象只会返回企业号和广告主其中一种) EDouyinName string `json:"e_douyin_name,omitempty"` // AccountId 账户id AccountId uint64 `json:"account_id,omitempty"` // AccountType 账户类型 // NORMAL_AD:普通广告主 // LOCAL:本地推 // DOU+:dou+ AccountType AdvertiserType `json:"account_type,omitempty"` // AccountName 账户名称 AccountName string `json:"account_name,omitempty"` // IsEnabled 账户状态,true为审核通过,false为审核不通过,注:账户审核通过方可进行转账 IsEnabled bool `json:"is_enabled,omitempty"` }
Advertiser 广告主
type AdvertiserListData ¶
type AdvertiserListData struct { // List 账户列表 List []Advertiser `json:"list,omitempty"` // PageInfo 分页信息 PageInfo *model.PageInfo `json:"page_info,omitempty"` }
AdvertiserListData json返回值
type AdvertiserListFilter ¶
type AdvertiserListFilter struct { // AccountName 根据账户名称过滤 AccountName string `json:"account_name,omitempty"` }
AdvertiserListFilter 过滤条件
type AdvertiserListRequest ¶
type AdvertiserListRequest struct { // CcAccountID 纵横组织id,通过【获取已授权账户】接口获取 CcAccountID uint64 `json:"cc_account_id,omitempty"` // Page 页码. 默认值: 1 Page int `json:"page,omitempty"` // PageSize 页面数据量. 默认值: 10 PageSize int `json:"page_size,omitempty"` // Filtering 过滤条件 Filtering *AdvertiserListFilter `json:"filtering,omitempty"` // AccountSource 账户类型,可选值: // AD 广告主账号、默认 // ENTERPRISE企业号 // LOCAL:本地推 AccountSource string `json:"account_source"` }
AdvertiserListRequest 获取纵横组织下资产账户列表(分页) API Request
func (AdvertiserListRequest) Encode ¶
func (r AdvertiserListRequest) Encode() string
Encode implement GetRequest interface
type AdvertiserListResponse ¶
type AdvertiserListResponse struct { model.BaseResponse // Data json返回值 Data *AdvertiserListData `json:"data,omitempty"` }
AdvertiserListResponse 获取纵横组织下资产账户列表(分页)API Response
type AdvertiserTransferableListData ¶ added in v1.10.0
type AdvertiserTransferableListData struct { // List 账户列表 List []Advertiser `json:"list,omitempty"` // PageInfo 分页信息 PageInfo *model.PageInfo `json:"page_info,omitempty"` }
AdvertiserTransferableListData json返回值
type AdvertiserTransferableListRequest ¶ added in v1.10.0
type AdvertiserTransferableListRequest struct { // AdvertiserID 广告主id AdvertiserID uint64 `json:"advertiser_id,omitempty"` // TransferAccountType 广告账户类型 TransferAccountType TransferAccountType `json:"transfer_account_type,omitempty"` // Page 页码. 默认值: 1 Page int `json:"page,omitempty"` // PageSize 页面数据量. 默认值: 10 PageSize int `json:"page_size,omitempty"` }
AdvertiserTransferableListRequest 获取可转账户列表(客户中心&广告主) API Request
func (AdvertiserTransferableListRequest) Encode ¶ added in v1.10.0
func (r AdvertiserTransferableListRequest) Encode() string
Encode implement GetRequest interface
type AdvertiserTransferableListResponse ¶ added in v1.10.0
type AdvertiserTransferableListResponse struct { model.BaseResponse // Data json返回值 Data *AdvertiserTransferableListData `json:"data,omitempty"` }
AdvertiserTransferableListResponse 获取可转账户列表(客户中心&广告主)API Response
type AdvertiserType ¶
type AdvertiserType string
AdvertiserType 广告主类型
const ( // AdvertiserType_DOU DOU+类广告主账号 AdvertiserType_DOU AdvertiserType = "DOU+" // AdvertiserType_NORMAL 普通广告主帐号 AdvertiserType_NORMAL AdvertiserType = "NORMAL" // AdvertiserType_NORMAL_AD 普通广告主帐号 AdvertiserType_NORMAL_AD AdvertiserType = "NORMAL_AD" // AdvertiserType_LOCAL 本地推 AdvertiserType_LOCAL AdvertiserType = "LOCAL" )
type CanTransferBalanceGetRequest ¶ added in v1.30.6
type CanTransferBalanceGetRequest struct { // OrganizationID 组织id OrganizationID uint64 `json:"organization_id,omitempty"` // BizRequestNo 请求id,推荐uuid,方便请求链路对齐 BizRequestNo string `json:"biz_request_no,omitempty"` // OpponentTargetID 锚定账户id,查询该账户的可转账账户列表 OpponentTargetID uint64 `json:"opponent_target_id,omitempty"` // TargetIDs 目标账户id列表,1:N的N,最多支持100个 TargetIDs []uint64 `json:"target_ids,omitempty"` // TransferDirection 转账方向,以可转列表视角确定 可选值: // TRANSFER_IN 转入 // TRANSFER_OUT 转出 TransferDirection enum.TransferDirection `json:"transfer_direction,omitempty"` // Platform 业务线 可选值: // AD 广告 // BENDITUI 本地推 Platform string `json:"platform,omitempty"` }
CanTransferBalanceGetRequest 工作台转账-获取最大可转余额 API Request
func (CanTransferBalanceGetRequest) Encode ¶ added in v1.30.6
func (r CanTransferBalanceGetRequest) Encode() string
Encode implements GetRequest interface
type CanTransferBalanceGetResponse ¶ added in v1.30.6
type CanTransferBalanceGetResponse struct { model.BaseResponse Data struct { // CanTransferDetailList 可转余额信息列表 CanTransferDetailList []CanTransferDetail `json:"can_transfer_detail_list,omitempty"` } `json:"data,omitempty"` }
CanTransferBalanceGetResponse 工作台转账-获取最大可转余额 API Response
type CanTransferDetail ¶ added in v1.30.6
type CanTransferDetail struct { // RemitterTargetID 转出方账户id RemitterTargetID uint64 `json:"remitter_target_id,omitempty"` // PayeeTransferAmountDetailList 转入方可转余额信息列表 PayeeTransferAmountDetailList []PayeeTransferAmountDetail `json:"payee_transfer_amount_detail_list,omitempty"` // CapitalDetailList 转出方可转资金列表 CapitalDetailList []CapitalDetail `json:"capital_detail_list,omitempty"` }
CanTransferDetail 可转余额信息
type CanTransferTargetListRequest ¶ added in v1.30.6
type CanTransferTargetListRequest struct { // OrganizationID 组织id OrganizationID uint64 `json:"organization_id,omitempty"` // BizRequestNo 请求id,推荐uuid,方便请求链路对齐 BizRequestNo string `json:"biz_request_no,omitempty"` // OpponentTargetID 锚定账户id,查询该账户的可转账账户列表 OpponentTargetID uint64 `json:"opponent_target_id,omitempty"` // TransferDirection 转账方向,以可转列表视角确定 可选值: // TRANSFER_IN 转入 // TRANSFER_OUT 转出 TransferDirection enum.TransferDirection `json:"transfer_direction,omitempty"` // Platform 业务线 可选值: // AD 广告 // BENDITUI 本地推 Platform string `json:"platform,omitempty"` // Page 页码,从1开始 Page int `json:"page,omitempty"` // PageSize 每页最多100 PageSize int `json:"page_size,omitempty"` }
CanTransferTargetListRequest 工作台转账-获取可转列表 API Request
func (CanTransferTargetListRequest) Encode ¶ added in v1.30.6
func (r CanTransferTargetListRequest) Encode() string
Encode implements GetRequest interface
type CanTransferTargetListResponse ¶ added in v1.30.6
type CanTransferTargetListResponse struct { model.BaseResponse Data *CanTransferTargetListResult `json:"data,omitempty"` }
CanTransferTargetListResponse 工作台转账-获取可转列表 API Response
type CanTransferTargetListResult ¶ added in v1.30.6
type CanTransferTargetListResult struct { // PageInfo 分页信息 PageInfo *model.PageInfo `json:"page_info,omitempty"` // CanTransferTargetList 可转账户列表 CanTransferTargetList []TransferTarget `json:"can_transfer_target_list,omitempty"` }
type CapitalDetail ¶ added in v1.30.6
type CapitalDetail struct { // CapitalType 转入方可转资金类型 可选值: // CREDIT_BIDDING 授信竞价 // CREDIT_BRAND 授信品牌 // CREDIT_GENERAL 授信通用 // GRANT_COMMON 信息流赠款 // GRANT_DEFAULT 通用赠款 // GRANT_SEARCH 搜索赠款 // GRANT_UNION 穿山甲赠款 // PREPAY_BIDDING 预付竞价 // PREPAY_BRAND 预付品牌 // PREPAY_GENERAL 预付通用 CapitalType enum.CapitalType `json:"capital_type,omitempty"` // TransferBalance 转入方可转资金余额(单位:分) TrainsferBalance int64 `json:"transfer_balance,omitempty"` }
CapitalDetail 转入方可转资金
type FundTransferSeqCommitRequest ¶ added in v1.10.0
type FundTransferSeqCommitRequest struct { // AdvertiserID 广告主id AdvertiserID uint64 `json:"advertiser_id,omitempty"` // TargetAdvertiserID 转入账户 TargetAdvertiserID uint64 `json:"target_advertiser_id,omitempty"` // TransactionSeq 交易流水号 TransactionSeq uint64 `json:"transaction_seq,omitempty"` }
FundTransferSeqCommitRequest 提交转账交易号 API Request
func (FundTransferSeqCommitRequest) Encode ¶ added in v1.10.0
func (r FundTransferSeqCommitRequest) Encode() []byte
Encode implement PostRequest interface
type FundTransferSeqCommitResponse ¶ added in v1.10.0
type FundTransferSeqCommitResponse struct { model.BaseResponse // Data json返回值 Data struct { // TransactionSeq 交易流水号 TransactionSeq uint64 `json:"transaction_seq,omitempty"` } `json:"data,omitempty"` }
FundTransferSeqCommitResponse 提交转账交易号 API Response
type FundTransferSeqCreateRequest ¶ added in v1.10.0
type FundTransferSeqCreateRequest struct { // AdvertiserID 广告主id AdvertiserID uint64 `json:"advertiser_id,omitempty"` // TargetAdvertiserID 转入账户 TargetAdvertiserID uint64 `json:"target_advertiser_id,omitempty"` // Amount 转账金额 Amount float64 `json:"amount,omitempty"` // TransferType 转账类型 TransferType TransferType `json:"transfer_type,omitempty"` }
FundTransferSeqCreateRequest 创建转账交易号 API Request
func (FundTransferSeqCreateRequest) Encode ¶ added in v1.10.0
func (r FundTransferSeqCreateRequest) Encode() []byte
Encode implement PostRequest interface
type FundTransferSeqCreateResponse ¶ added in v1.10.0
type FundTransferSeqCreateResponse struct { model.BaseResponse // Data json返回值 Data struct { // TransactionSeq 交易流水号 TransactionSeq uint64 `json:"transaction_seq,omitempty"` } `json:"data,omitempty"` }
FundTransferSeqCreateResponse 创建转账交易号 API Response
type PayeeTransferAmountDetail ¶ added in v1.30.6
type PayeeTransferAmountDetail struct { // PayeeTargetID 转入方账户id PayeeTargetID uint64 `json:"payee_target_id,omitempty"` // CapitalDetailList 转入方可转资金列表 CapitalDetailList []CapitalDetail `json:"capital_detail_list,omitempty"` }
PayeeTransferAmountDetail 转入方可转余额信息
type TargetAmountDetail ¶ added in v1.30.6
type TargetAmountDetail struct { // TargetID 账户id TargetID uint64 `json:"target_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"` }
TargetAmountDetail 账户金额
type TransferAccountType ¶ added in v1.10.0
type TransferAccountType string
TransferAccountType 广告账户类型
type TransferBalanceGetRequest ¶ added in v1.30.6
type TransferBalanceGetRequest struct { // OrganizationID 组织id OrganizationID uint64 `json:"organization_id,omitempty"` // BizRequestNo 请求id,推荐uuid,方便请求链路对齐 BizRequestNo string `json:"biz_request_no,omitempty"` // TargetIDList 查询账户id列表(限制长度100) TargetIDList []uint64 `json:"target_id_list,omitempty"` // Platform 业务线 可选值: // AD 广告 // BENDITUI 本地推 Platform string `json:"platform,omitempty"` }
TransferBalanceGetRequest 工作台转账-查询账户转账余额 API Request
func (TransferBalanceGetRequest) Encode ¶ added in v1.30.6
func (r TransferBalanceGetRequest) Encode() string
Encode implements GetRequest interface
type TransferBalanceGetResponse ¶ added in v1.30.6
type TransferBalanceGetResponse struct { model.BaseResponse Data struct { // TargetAmountDetailList 账户金额列表 TargetAmountDetailList []TargetAmountDetail `json:"target_amount_detail_list,omitempty"` } `json:"data,omitempty"` }
TransferBalanceGetResponse 工作台转账-查询账户转账余额 API Response
type TransferCapitalRecord ¶ added in v1.30.6
type TransferCapitalRecord struct { // CapitalType 转账资金类型 可选值: // CREDIT_BIDDING 授信竞价 // CREDIT_BRAND 授信品牌 // CREDIT_GENERAL 授信通用 // GRANT_COMMON 信息流赠款 // GRANT_DEFAULT 通用赠款 // GRANT_SEARCH 搜索赠款 // GRANT_UNION 穿山甲赠款 // PREPAY_BIDDING 预付竞价 // PREPAY_BRAND 预付品牌 // PREPAY_GENERAL 预付通用 CapitalType enum.CapitalType `json:"capital_type,omitempty"` // TransferAmount 转账资金金额(单位:分) TransferAmount int64 `json:"transfer_amount,omitempty"` // TansferStatus 转账资金状态 可选值: // NO_TRANSFER 未转账 // TRANSFER_FAILED 转账失败(终态) // TRANSFER_ING 转账中 // TRANSFER_SUCCESS 转账成功(终态) r TransferStatus enum.TransferStatus `json:"transfer_status,omitempty"` // FailReason 失败原因 FailReason string `json:"fail_reason,omitempty"` }
TransferCapitalRecord 转账资金类型
type TransferCreateRequest ¶ added in v1.30.6
type TransferCreateRequest struct { // OrganizationID 组织id OrganizationID uint64 `json:"organization_id,omitempty"` // BizRequestNo 请求id,推荐uuid,方便请求链路对齐 BizRequestNo string `json:"biz_request_no,omitempty"` // OpponentTargetID 锚定账户id,1:N的1 OpponentTargetID uint64 `json:"opponent_target_id,omitempty"` // TargetDetailList 目标账户列表,1:N的N,需要列表内账户类型相同,最多支持100个 TargetDetailList []TransferTarget `json:"target_detail_list,omitempty"` // TransferDirection 转账方向,以目标账户视角确定 可选值: // TRANSFER_IN 转入 // TRANSFER_OUT 转出 TransferDirection enum.TransferDirection `json:"transfer_direction,omitempty"` // Remark 备注 Remark string `json:"remark,omitempty"` // Platform 转账业务线 可选值: // AD 广告 // BENDITUI 本地推 Platform string `json:"platform,omitempty"` }
TransferCreateRequest 工作台转账-发起转账 API Request
func (TransferCreateRequest) Encode ¶ added in v1.30.6
func (r TransferCreateRequest) Encode() []byte
Encode implements PostRequest interface
type TransferCreateResponse ¶ added in v1.30.6
type TransferCreateResponse struct { model.BaseResponse Data struct { // TransferSerial 转账单号 TransferSerial string `json:"transfer_serial,omitempty"` } `json:"data,omitempty"` }
TransferCreateResponse 工作台转账-发起转账
type TransferDetail ¶ added in v1.30.6
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 转账完成时间(yyyy-MM-dd HH:mm:ss) TransferFinishTime string `json:"transfer_transfer_time,omitempty"` // TransferCreateTime 转账创建时间(yyyy-MM-dd HH:mm:ss) TransferCreateTime string `json:"transfer_create_time,omitempty"` // TransferTargetRecordList 账户信息列表 TransferTargetRecordList []TransferTargetRecord `json:"transfer_target_record_list,omitempty"` }
type TransferDetailGetRequest ¶ added in v1.30.6
type TransferDetailGetRequest struct { // OrganizationID 组织id OrganizationID uint64 `json:"organization_id,omitempty"` // BizRequestNo 请求id,推荐uuid,方便请求链路对齐 BizRequestNo string `json:"biz_request_no,omitempty"` // TransferBizRequestNo 发起转账的幂等id TransferBizRequestNo string `json:"transfer_biz_request_no,omitempty"` // TransferSerial 转账单号,与transfer_biz_request_no两者传其一即可 TransferSerial string `json:"transfer_serial,omitempty"` // Platform 转账业务线 可选值: // AD 广告 // BENDITUI 本地推 Platform string `json:"platform,omitempty"` }
TransferDetailGetRequest 工作台转账-查询转账单信息 API Request
func (TransferDetailGetRequest) Encode ¶ added in v1.30.6
func (r TransferDetailGetRequest) Encode() string
Encode implements GetRequest interface
type TransferDetailGetResponse ¶ added in v1.30.6
type TransferDetailGetResponse struct { model.BaseResponse Data *TransferDetail `json:"data,omitempty"` }
TransferDetailGetResponse 工作台转账-查询转账单信息 API Response
type TransferTarget ¶ added in v1.30.6
type TransferTarget struct { // TargetID 可转账户id TargetID uint64 `json:"target_id,omitempty"` // TransferCaptialDetailList 锚定账户与目标账户转账资金列表 TransferCaptialDetailList []CapitalDetail `json:"transfer_captial_detail_list,omitempty"` }
TransferTarget 可转账户
type TransferTargetRecord ¶ added in v1.30.6
type TransferTargetRecord struct { // OpponentTargetID 锚定账户id,1:N的1 OpponetTargetID uint64 `json:"opponent_target_id,omitempty"` // TargetID 目标账户id,1:N的N TargetID uint64 `json:"target_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 TransferType ¶ added in v1.10.0
type TransferType string
TransferType 转账类型
const ( // TransferType_GRANT 赠款 TransferType_GRANT TransferType = "GRANT" // TransferType_PREPAY_UNIVERSAL 通用预付 TransferType_PREPAY_UNIVERSAL TransferType = "PREPAY_UNIVERSAL" // TransferType_PREPAY_BRAND 品牌预付 TransferType_PREPAY_BRAND TransferType = "PREPAY_BRAND" // TransferType_PREPAY_BID 竞价预付 TransferType_PREPAY_BID TransferType = "PREPAY_BID" // TransferType_CREDIT_UNIVERSAL 通用授信 TransferType_CREDIT_UNIVERSAL TransferType = "CREDIT_UNIVERSAL" // TransferType_CREDIT_BRAND 品牌授信 TransferType_CREDIT_BRAND TransferType = "CREDIT_BRAND" // TransferType_CREDIT_BID 竞价授信 TransferType_CREDIT_BID TransferType = "CREDIT_BID" )