businessplatform

Documentation

Overview

Package businessplatform 纵横组织相关 API

Index

• type Account
• type CompanyAccountGetData
• type CompanyAccountGetRequest
  • func (r CompanyAccountGetRequest) Encode() string
• type CompanyAccountGetResponse
• type CompanyInfo
• type CompanyInfoGetData
• type CompanyInfoGetRequest
  • func (r CompanyInfoGetRequest) Encode() string
• type CompanyInfoGetResponse
• type PartnerOrganization
• type PartnerOrganizationListData
• type PartnerOrganizationListFilter
• type PartnerOrganizationListRequest
  • func (r PartnerOrganizationListRequest) Encode() string
• type PartnerOrganizationListResponse

Types

type Account

type Account struct {
	// ID 账户id
	ID uint64 `json:"account_id,omitempty"`
	// Type 主体类型:
	// AD: 广告账户
	// QIANCHUAN:千川广告账户
	Type enum.AccountType `json:"account_type,omitempty"`
}

Account 账户

type CompanyAccountGetData

type CompanyAccountGetData struct {
	// List 账户列表
	List []Account `json:"account_list,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

CompanyAccountGetData json返回值

type CompanyAccountGetRequest

type CompanyAccountGetRequest struct {
	// OrganizationID 纵横组织id
	OrganizationID uint64 `json:"organization_id,omitempty"`
	// CompanyID 公司主体id
	CompanyID uint64 `json:"company_id,omitempty"`
	// AccountType 账户类型，可选值:
	// AD: 广告账户
	// QIANCHUAN:千川广告账户
	AccountType []enum.AccountType `json:"account_type,omitempty"`
	// Page 页码. 默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面数据量. 默认值: 10
	PageSize int `json:"page_size,omitempty"`
}

CompanyAccountGetRequest 获取主体下的账户列表 API Request

func (CompanyAccountGetRequest) Encode

func (r CompanyAccountGetRequest) Encode() string

Encode implement GetRequest interface

type CompanyAccountGetResponse

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

CompanyAccountGetResponse 获取主体下的账户列表 API Response

type CompanyInfo

type CompanyInfo struct {
	// CompanyID 公司主体id
	CompanyID uint64 `json:"company_id,omitempty"`
	// CompanyName 公司主体名
	CompanyName string `json:"company_name,omitempty"`
	// Type 主体关系，可选值:
	// BP_OTHER:
	// BP_OWN:
	Type enum.CompanyType `json:"type,omitempty"`
	// Status 公司主体状态，可选值:
	// EXPIRED:已过期
	// FAILED: 审核拒绝
	// NOT_STARTED:待提交
	// PROCESSING: 审核中
	// SUCCESS: 审核通过
	// WAITING: 待审核
	Status enum.CompanyStatus `json:"status,omitempty"`
}

CompanyInfo 主体信息

type CompanyInfoGetData

type CompanyInfoGetData struct {
	// List 主体信息列表
	List []CompanyInfo `json:"company_info,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

CompanyInfoGetData json返回值

type CompanyInfoGetRequest

type CompanyInfoGetRequest struct {
	// OrganizationID 纵横组织id
	OrganizationID uint64 `json:"organization_id,omitempty"`
	// Page 页码. 默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面数据量. 默认值: 10
	PageSize int `json:"page_size,omitempty"`
}

CompanyInfoGetRequest 获取纵横组织下所有主体信息 API Request

func (CompanyInfoGetRequest) Encode

func (r CompanyInfoGetRequest) Encode() string

Encode implement GetRequest interface

type CompanyInfoGetResponse

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

CompanyInfoGetResponse 获取纵横组织下所有主体信息 API Response

type PartnerOrganization

type PartnerOrganization struct {
	// ID 发起合作组织请求的组织id
	ID uint64 `json:"partner_organization_id,omitempty"`
	// Status 合作状态
	// 枚举值：BOUND（已绑定）、BINDING（绑定中）、INVALID（失效）、DELETED（删除）
	Status enum.PartnerOrganizationStatus `json:"status,omitempty"`
	// Remark 备注，合作组织备注信息
	Remark string `json:"remark,omitempty"`
}

PartnerOrganization 发起合作组织请求的组织

type PartnerOrganizationListData

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

PartnerOrganizationListData json返回值

type PartnerOrganizationListFilter

type PartnerOrganizationListFilter struct {
	// PartnerOrganizationIDs 合作的巨量纵横组织id，最大不超过200
	PartnerOrganizationIDs []uint64 `json:"partner_organization_ids,omitempty"`
	// Status 合作状态，默认查询绑定成功的状态
	// 允许值：BOUND（已绑定）、BINDING（绑定中）、INVALID（失效）、DELETED（删除）
	Status enum.PartnerOrganizationStatus `json:"status,omitempty"`
}

PartnerOrganizationListFilter 过滤条件

type PartnerOrganizationListRequest

type PartnerOrganizationListRequest struct {
	// OrganizationID 纵横组织id
	OrganizationID uint64 `json:"organization_id,omitempty"`
	// Page 页码. 默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面数据量. 默认值: 10
	PageSize int `json:"page_size,omitempty"`
	// Filtering 过滤条件
	Filtering *PartnerOrganizationListFilter `json:"filtering,omitempty"`
}

PartnerOrganizationListRequest 查询合作组织 API Request

func (PartnerOrganizationListRequest) Encode

func (r PartnerOrganizationListRequest) Encode() string

Encode implement GetRequest interface

type PartnerOrganizationListResponse

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

PartnerOrganizationListResponse 查询合作组织 API Response