star

package
v1.28.5 Latest Latest
Warning

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

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

Documentation

Overview

Package star 巨量星图

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Clue

type Clue struct {
	// StarID 星图id
	StarID uint64 `json:"star_id,omitempty"`
	// DemandID 任务id
	DemandID uint64 `json:"demand_id,omitempty"`
	// OrderID 订单id
	OrderID uint64 `json:"order_id,omitempty"`
	// ItemID 视频id
	ItemID uint64 `json:"item_id,omitempty"`
	// AuthorUid 作者抖音uid
	AuthorUid uint64 `json:"author_uid,omitempty"`
	// AuthorName 作者昵称
	AuthorName string `json:"author_name,omitempty"`
	// ComponentType 组件类型
	ComponentType enum.StarComponentType `json:"component_type,omitempty"`
	// AnchorName 锚点名称
	AnchorName string `json:"anchor_name,omitempty"`
	// Phone 手机号码
	Phone string `json:"phone,omitempty"`
	// CarSeries 车系
	CarSeries string `json:"car_series,omitempty"`
	// CarType 车型
	CarType string `json:"car_type,omitempty"`
	// Address 地址
	Address string `json:"address,omitempty"`
	// Name 姓名
	Name string `json:"name,omitempty"`
	// Province 省份
	Province string `json:"province,omitempty"`
	// City 城市
	City string `json:"city,omitempty"`
	// CreateTime 创建时间,时间格式“%Y-%m-%d %H:%M:%S”
	CreateTime string `json:"create_time,omitempty"`
}

Clue 星图订单投后线索

type ClueListRequest

type ClueListRequest struct {
	// StarID 星图id,星图客户授权后,通过“获取已授权账户”接口,查询到账号角色为”6-星图账号“的账户id,即为星图id
	StarID uint64 `json:"star_id,omitempty"`
	// DemandID 任务id
	DemandID uint64 `json:"demand_id,omitempty"`
	// OrderID 订单id
	OrderID uint64 `json:"order_id,omitempty"`
	// Page 页码,默认为1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小,默认10,最大值50
	PageSize int `json:"page_size,omitempty"`
}

ClueListRequest 获取星图订单投后线索 API Request

func (ClueListRequest) Encode

func (r ClueListRequest) Encode() string

Encode implement GetRequest interface

type ClueListResponse

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

ClueListResponse 获取星图客户任务列表 API Response

type ClueListResponseData

type ClueListResponseData struct {
	List     []Clue         `json:"list,omitempty"`
	PageInfo model.PageInfo `json:"page_info"`
}

ClueListResponseData json返回值

type CommentReport

type CommentReport struct {
	// HighFrequencyWords 热词top10
	HighFrequencyWords []string `json:"high_frequency_words,omitempty"`
	// NegRate 负向评论率(neg_rate/100)%
	NegRate int `json:"neg_rate,omitempty"`
	// NeuRate 中立评论率(neu_rate/100)%
	NeuRate int `json:"neu_rate,omitempty"`
	// PosRate 正向评论率(pos_rate/100)%
	PosRate int `json:"pos_rate,omitempty"`
}

CommentReport 舆情表现

type ConvertReport

type ConvertReport struct {
	// Click 组件点击量
	Click int64 `json:"click,omitempty"`
	// Ctr 组件点击率 (ctr/100)%
	Ctr int `json:"ctr,omitempty"`
	// Show 组件展示量
	Show int64 `json:"show,omitempty"`
}

ConvertReport 转化表现

type CostEffectiveness

type CostEffectiveness struct {
	// Cpm 千次播放成本(分)
	Cpm int64 `json:"cpm,omitempty"`
	// Play 播放次数
	Play int64 `json:"play,omitempty"`
	// Price 订单金额(分)
	Price int64 `json:"price,omitempty"`
}

CostEffectiveness 性价比表现

type CreativeReport

type CreativeReport struct {
	// FinishRate 完播率 (finish_rate/100)%
	FinishRate int `json:"finish_rate,omitempty"`
	// FiveSPlayRate 有效播放率(播放5s以上记为有效播放)(five_s_play_rate/100)%
	FiveSPlayRate int `json:"five_s_play_rate,omitempty"`
	// PlayRate 平均播放率(=用户观看该任务视频的平均观看时长/视频总时长)(play_rate/100)%
	PlayRate int `json:"play_rate,omitempty"`
}

CreativeReport 创意表现

type Demand

type Demand struct {
	// ID 任务id
	ID uint64 `json:"demand_id,omitempty"`
	// Name 任务名称
	Name string `json:"name,omitempty"`
	// TaskCategory 所创建的星图任务类型。枚举值详见【附录-枚举值-星图任务类型】
	TaskCategory enum.StarTaskCategory `json:"task_category,omitempty"`
	// ComponentType 组件类型
	ComponentType enum.StarComponentType `json:"component_type,omitempty"`
	// UniversalSettlementType 结算方式
	UniversalSettlementType enum.UniversalSettlementType `json:"universal_settlement_type,omitempty"`
	// CreateTime 任务创建时间,格式:%Y-%m-%d %H:%M:%S
	CreateTime string `json:"create_time,omitempty"`
}

Demand 星图客户任务

type DemandListFilter

type DemandListFilter struct {
	// ComponentType 组件类型
	ComponentType enum.StarComponentType `json:"component_type,omitempty"`
	// TaskCategory 星图任务类型,允许值详见【附录-枚举值-星图任务类型】
	TaskCategory enum.StarTaskCategory `json:"task_category,omitempty"`
	// Name 任务名称,模糊匹配
	Name string `json:"name,omitempty"`
	// UniversalOrderStatus 任务订单状态(订单状态,并非任务状态,意为过滤出包含该状态订单的任务)
	UniversalOrderStatus enum.UniversalOrderStatus `json:"universal_order_status,omitempty"`
	// UniversalSettlementType 结算方式
	UniversalSettlementType enum.UniversalSettlementType `json:"universal_settlement_type,omitempty"`
}

DemandListFilter 过滤条件

type DemandListRequest

type DemandListRequest struct {
	// StarID 星图id,星图客户授权后,通过“获取已授权账户”接口,查询到账号角色为”6-星图账号“的账户id,即为星图id
	StarID uint64 `json:"star_id,omitempty"`
	// Filtering 过滤条件,若此字段不传,或传空则视为无限制条件
	Filtering *DemandListFilter `json:"filtering,omitempty"`
	// Page 页码,默认为1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小,默认10,最大值50
	PageSize int `json:"page_size,omitempty"`
}

DemandListRequest 获取星图客户任务列表 API Request

func (DemandListRequest) Encode

func (r DemandListRequest) Encode() string

Encode implement GetRequest interface

type DemandListResponse

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

DemandListResponse 获取星图客户任务列表 API Response

type DemandListResponseData

type DemandListResponseData struct {
	List     []Demand       `json:"list,omitempty"`
	PageInfo model.PageInfo `json:"page_info"`
}

DemandListResponseData json返回值

type DemandOrderListFilter

type DemandOrderListFilter struct {
	// UniversalOrderStatus 任务订单状态(订单状态,并非任务状态,意为过滤出包含该状态订单的任务)
	UniversalOrderStatus enum.UniversalOrderStatus `json:"universal_order_status,omitempty"`
}

DemandOrderListFilter 过滤条件

type DemandOrderListRequest

type DemandOrderListRequest struct {
	// StarID 星图id,星图客户授权后,通过“获取已授权账户”接口,查询到账号角色为”6-星图账号“的账户id,即为星图id
	StarID uint64 `json:"star_id,omitempty"`
	// Filtering 过滤条件,若此字段不传,或传空则视为无限制条件
	Filtering *DemandOrderListFilter `json:"filtering,omitempty"`
	// Page 页码,默认为1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小,默认10,最大值50
	PageSize int `json:"page_size,omitempty"`
}

DemandOrderListRequest 获取星图客户任务列表 API Request

func (DemandOrderListRequest) Encode

func (r DemandOrderListRequest) Encode() string

Encode implement GetRequest interface

type DemandOrderListResponse

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

DemandOrderListResponse 获取星图客户任务列表 API Response

type DemandOrderListResponseData

type DemandOrderListResponseData struct {
	List     []Order        `json:"list,omitempty"`
	PageInfo model.PageInfo `json:"page_info"`
}

DemandOrderListResponseData json返回值

type IndustryInfo added in v1.25.8

type IndustryInfo struct {
	// IndustryID 行业id
	IndustryID uint64 `json:"industry_id,omitempty"`
	// IndustryName 行业名称
	IndustryName string `json:"industry_name,omitempty"`
}

IndustryInfo 行业信息

type Info added in v1.25.8

type Info struct {
	// StarID 星图id
	StarID uint64 `json:"star_id,omitempty"`
	// StarName 星图名称
	StarName string `json:"star_name,omitempty"`
	// Status 账户状态
	// DELETED 已删除
	// ENABLE 有效
	// FROZEN 禁用
	// NEW_PROTOCOL 待同意新协议
	// PUNISH 惩罚
	// QUALIFICATION_VERIFICATION 资质验证
	// UN_PROTOCOL 未同意协议
	Status enum.StarInfoStatus `json:"status,omitempty"`
	// CompanyName 公司名称
	CompanyName string `json:"company_name,omitempty"`
	// CategoryID 行业分类id
	CategoryID uint64 `json:"categorty_id,omitempty"`
	// CompanyID 公司id
	CompanyID uint64 `json:"company_id,omitempty"`
	// FirstInfo 一级行业
	FirstInfo *IndustryInfo `json:"first_info,omitempty"`
	// SecondInfo 二级行业
	SecondInfo *IndustryInfo `json:"second_info,omitempty"`
	// CreateTime 创建时间
	CreateTime int64 `json:"create_time,omitempty"`
}

Info 星图账户信息

type InfoRequest added in v1.25.8

type InfoRequest struct {
	// StarIDs 星图id
	StarIDs []uint64 `json:"star_ids,omitempty"`
}

InfoRequest 获取星图账户信息 API Request

func (InfoRequest) Encode added in v1.25.8

func (r InfoRequest) Encode() string

Encode implement GetRequest interface

type InfoResponse added in v1.25.8

type InfoResponse struct {
	model.BaseResponse
	Data struct {
		// InfoList 信息列表
		InfoList []Info `json:"info_list,omitempty"`
	} `json:"data,omitempty"`
}

InfoResponse 获取星图账户信息 API Response

type KV

type KV struct {
	// Key .
	Key string `json:"key,omitempty"`
	// Value 分布值
	Value int64 `json:"value,omitempty"`
}

KV .

type Order

type Order struct {
	// ID 订单id
	ID uint64 `json:"order_id,omitempty"`
	// Title 作品名称
	Title string `json:"title,omitempty"`
	// UniversalOrderStatus 订单状态
	UniversalOrderStatus enum.UniversalOrderStatus `json:"universal_order_status,omitempty"`
	// AuthorID 达人id
	AuthorID uint64 `json:"author_id,omitempty"`
	// AuthorName 达人名称
	AuthorName string `json:"author_name,omitempty"`
	// AvatarURL 达人头像
	AvatarURL string `json:"avatar_url,omitempty"`
	// CreateTime 订单创建时间,格式:%Y-%m-%d %H:%M:%S
	CreateTime string `json:"create_time,omitempty"`
	// DemandID 任务id
	DemandID uint64 `json:"demand_id,omitempty"`
	// HeadImageURL 封面图
	HeadImageURL string `json:"head_image_url,omitempty"`
	// VideoID 视频id,每个视频唯一(建议使用item_id)
	VideoID string `json:"video_id,omitempty"`
	// ItemID 视频id,与星图平台前端video_url中展现的视频id一致,每个视频唯一
	ItemID uint64 `json:"item_id,omitempty"`
	// VideoURL 视频链接
	VideoURL string `json:"video_url,omitempty"`
}

Order 星图客户任务订单

type ReportOrderOverviewGetRequest

type ReportOrderOverviewGetRequest struct {
	// StarID 星图id,星图客户授权后,通过“获取已授权账户”接口,查询到账号角色为”6-星图账号“的账户id,即为星图id
	StarID uint64 `json:"star_id,omitempty"`
	// OrderID 订单id,可通过“获取星图客户任务订单列表”获取
	OrderID uint64 `json:"order_id,omitempty"`
}

ReportOrderOverviewGetRequest 获取订单投后分析报表 API Request

func (ReportOrderOverviewGetRequest) Encode

Encode implement GetRequest interface

type ReportOrderOverviewGetResponse

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

ReportOrderOverviewGetResponse 获取订单投后分析报表 API Response

type ReportOrderOverviewGetResponseData

type ReportOrderOverviewGetResponseData struct {
	// Comment 舆情表现
	Comment *CommentReport `json:"comment,omitempty"`
	// Convert 转化表现
	Convert *ConvertReport `json:"convert,omitempty"`
	// CostEffectiveness 性价比表现
	CostEffectiveness *CostEffectiveness `json:"cost_effectiveness,omitempty"`
	// CreativeReport 创意表现
	Creative *CreativeReport `json:"creative,omitempty"`
	// Spread 传播表现
	Spread *SpreadReport `json:"spread,omitempty"`
	// UpdateTime 数据更新时间,格式%Y-%m-%d %H:%M:%S
	UpdateTime string `json:"update_time,omitempty"`
}

ReportOrderOverviewGetResponseData json返回值

type ReportOrderUserDistributionGetRequest

type ReportOrderUserDistributionGetRequest struct {
	// StarID 星图id,星图客户授权后,通过“获取已授权账户”接口,查询到账号角色为”6-星图账号“的账户id,即为星图id
	StarID uint64 `json:"star_id,omitempty"`
	// OrderID 订单id,可通过“获取星图客户任务订单列表”获取
	OrderID uint64 `json:"order_id,omitempty"`
}

ReportOrderUserDistributionGetRequest 获取订单投后受众报表 API Request

func (ReportOrderUserDistributionGetRequest) Encode

Encode implement GetRequest interface

type ReportOrderUserDistributionGetResponse

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

ReportOrderUserDistributionGetResponse 获取订单投后受众报表 API Response

type ReportOrderUserDistributionGetResponseData

type ReportOrderUserDistributionGetResponseData struct {
	// Activity 活跃度分布
	Activity []KV `json:"activity,omitempty"`
	// Age 年龄分布
	Age []KV `json:"age,omitempty"`
	// City 城市分布
	City []KV `json:"city,omitempty"`
	// Device 设备分布
	Device []KV `json:"device,omitempty"`
	// Gender 性别分布
	Gender []KV `json:"gender,omitempty"`
	// Interest 兴趣分布
	Interest []KV `json:"interest,omitempty"`
	// Province 省份分布
	Province []KV `json:"province,omitempty"`
	// UpdateTime 数据更新时间,格式%Y-%m-%d %H:%M:%S
	UpdateTime string `json:"update_time,omitempty"`
}

ReportOrderUserDistributionGetResponseData 返回值

type SpreadReport

type SpreadReport struct {
	// Comment 评论量
	Comment int64 `json:"comment,omitempty"`
	// Like 点赞量
	Like int64 `json:"like,omitempty"`
	// Play 播放量
	Play int64 `json:"play,omitempty"`
	// Share 分享量
	Share int64 `json:"share,omitempty"`
}

SpreadReport 传播表现

Jump to

Keyboard shortcuts

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