star

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 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 ClueGetRequest added in v1.29.1 

type ClueGetRequest 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"`
}

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

func (ClueGetRequest) Encode added in v1.29.1 

func (r ClueGetRequest) Encode() string

Encode implement GetRequest interface

type ClueGetResponse added in v1.29.1 

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

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

type ClueGetResult added in v1.29.1 

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

ClueGetResult 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 DataTopicConfig added in v1.29.1 

type DataTopicConfig struct {
	// DataTopic 同请求中的数据主题枚举值。不存在的数据主题将缺省。 可选值:
	// BASIC_DATA 基础信息
	// COMMENT_DATA 评论数据
	// CONVERT_DATA 转化表现
	// DY_SHOP_DATA 抖音进店
	// FLOW_DATA 流量表现
	// INDEX_SCORE_DATA 指数得分
	// RECOMMEND_DATA 种草表现
	// SEARCH_DATA 搜索表现
	// USER_DISTRIBUTION_DATA 用户画像
	DataTopic enum.StarReportTopic `json:"data_topic,omitempty"`
	// Metrics 数据主题下的数据指标，一个数据主题对应一个或多个数据指标。不存在的数据指标将缺省。
	Metrics []DataTopicMetric `json:"metrics,omitempty"`
}

DataTopicConfig 任务下累计可查询的数据指标

type DataTopicMetric added in v1.29.1 

type DataTopicMetric struct {
	// Field 指标字段，仅包含英文与下划线等符号
	Field string `json:"field,omitempty"`
	// Name 指标名称，中文或英文描述字段名称
	Name string `json:"name,omitempty"`
	// Type 指标数据类型：
	// STRING
	// INT64
	// FLOAT64
	// JSON 可选值:
	// FLOAT64 64位浮点数
	// INT64 64位整数
	// JSON JSON
	// STRING 字符串
	Type string `json:"type,omitempty"`
	// Description 指标描述
	Description string `json:"description,omitempty"`
	// Value 指标值
	Value string `json:"value,omitempty"`
}

DataTopicMetric 数据主题下的数据指标

type Demand 

type Demand struct {
	// DemandID 任务id
	DemandID uint64 `json:"demand_id,omitempty"`
	// DemandName 任务名称
	DemandName 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 {
	// QueryTimeRange 查询时间范围内创建的任务。
	// 筛选时间时，开始时间必须与结束时间同时传入，开始时间必须小于等于结束时间。
	// 若缺省默认查询全时间范围任务，若出现超时等情况请缩小查询时间范围。
	QueryTimeRange *model.DateRange `json:"query_time_range,omitempty"`
	// 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 {
	// Filtering 过滤条件，若此字段不传，或传空则视为无限制条件
	Filtering *DemandListFilter `json:"filtering,omitempty"`
	// StarID 星图id，星图客户授权后，通过“获取已授权账户”接口，查询到账号角色为”6-星图账号“的账户id，即为星图id
	StarID uint64 `json:"star_id,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 {
	// Data json返回值
	Data *DemandListResult `json:"data,omitempty"`
	model.BaseResponse
}

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

type DemandListResult added in v1.29.1 

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

DemandListResult json返回值

type DemandOrderListFilter 

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

DemandOrderListFilter 过滤条件

type DemandOrderListRequest 

type DemandOrderListRequest struct {
	// Filtering 过滤条件，若此字段不传，或传空则视为无限制条件
	Filtering *DemandOrderListFilter `json:"filtering,omitempty"`
	// StarID 星图id，星图客户授权后，通过“获取已授权账户”接口，查询到账号角色为”6-星图账号“的账户id，即为星图id
	StarID uint64 `json:"star_id,omitempty"`
	// DemandID 任务id，可通过“获取星图客户任务列表”获取
	DemandID uint64 `json:"demand_id,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 {
	// Data json返回值
	Data *DemandOrderListResult `json:"data,omitempty"`
	model.BaseResponse
}

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

type DemandOrderListResult added in v1.29.1 

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

DemandOrderListResult json返回值

type IndustryInfo added in v1.25.8 

type IndustryInfo struct {
	// IndustryName 行业名称
	IndustryName string `json:"industry_name,omitempty"`
	// IndustryID 行业id
	IndustryID uint64 `json:"industry_id,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 {
	// OrderID 订单id
	OrderID 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"`
	// AvatarURI 达人头像
	AvatarURI string `json:"avatar_uri,omitempty"`
	// CreateTime 订单创建时间，格式：%Y-%m-%d %H:%M:%S
	CreateTime string `json:"create_time,omitempty"`
	// DemandID 任务id
	DemandID uint64 `json:"demand_id,omitempty"`
	// HeadImageURI 封面图
	HeadImageURI string `json:"head_image_uri,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"`
	// CampaignID 需求id
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// ReleaseTime 指派任务产出物发布时间
	ReleaseTime string `json:"release_time,omitempty"`
}

Order 星图客户任务订单

type ReportCustomDataTopicConfigResponse added in v1.29.1 

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

ReportCustomDataTopicConfigResponse 获取投后数据主题累计数据 API Response

type ReportCustomDataTopicConfigResult added in v1.29.1 

type ReportCustomDataTopicConfigResult struct {
	// Data 对应请求的数据主题数组
	Data []DataTopicConfig `json:"data,omitempty"`
	// ItemID 请求的交付物Id
	ItemID uint64 `json:"item_id,omitempty"`
	// DemandID 请求的任务Id
	DemandID uint64 `json:"demand_id,omitempty"`
}

type ReportCustomDataTopicDailyReport added in v1.29.1 

type ReportCustomDataTopicDailyReport struct {
	// Date 该指标数据的yyyy-MM-dd日期时间, 按天聚合。BASIC_DATA作为通用指标在每日趋势数据中date为"0"。
	Date string `json:"date,omitempty"`
	// Data 对应请求的数据主题数组
	Data []DataTopicConfig `json:"data,omitempty"`
	// WorkID 交付作品Id：如视频Id
	ItemID uint64 `json:"item_id,omitempty"`
	// DemandID 请求的任务Id
	DemandID uint64 `json:"demand_id,omitempty"`
}

type ReportCustomDataTopicDailyReportRequest added in v1.29.1 

type ReportCustomDataTopicDailyReportRequest struct {
	// StartTime 起始时间: yyyy-MM-dd
	StartTime string `json:"start_time,omitempty"`
	// EndTime 结束时间: yyyy-MM-dd
	EndTime string `json:"end_time,omitempty"`
	// Topics 数据主题:
	// BASIC_DATA：基础信息
	// FLOW_DATA：流量表现
	// CONVERT_DATA：转化表现
	// SEARCH_DATA：搜索表现
	// RECOMMEND_DATA： 种草表现
	// DY_SHOP_DATA：抖音进店
	// USER_DISTRIBUTION_DATA：用户画像、
	// INDEX_SCORE_DATA： 指数得分
	// COMMENT_DATA：评论数据
	// 直播用户画像仅保留近90天且直播时长 >= 25 分钟直播数据
	Topics []enum.StarReportTopic `json:"topics,omitempty"`
	// StarID 发起请求的客户的starId
	StarID uint64 `json:"star_id,omitempty"`
	// WorkID 交付作品Id，如：视频Id，直播间room_id.
	WorkID uint64 `json:"work_id,omitempty"`
	// DemandID 任务Id
	DemandID uint64 `json:"demand_id,omitempty"`
}

ReportCustomDataTopicDailyReportRequest 获取投后每日趋势数据（短视频） API Request

func (ReportCustomDataTopicDailyReportRequest) Encode added in v1.29.1 

func (r ReportCustomDataTopicDailyReportRequest) Encode() string

Encode implement GetRequest interface

type ReportCustomDataTopicDailyReportResponse added in v1.29.1 

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

ReportCustomDataTopicDailyReportResponse 获取投后数据主题累计数据 API Response

type ReportCustomDataTopicDailyReportResult added in v1.29.1 

type ReportCustomDataTopicDailyReportResult struct {
	// Stats 统计数据列表
	Stats []ReportCustomDataTopicDailyReport `json:"stats,omitempty"`
}

type ReportDataTopicConfigRequest added in v1.29.1 

type ReportDataTopicConfigRequest struct {
	// Topics 数据主题:
	// BASIC_DATA：基础信息
	// FLOW_DATA：流量表现
	// CONVERT_DATA：转化表现
	// SEARCH_DATA：搜索表现
	// RECOMMEND_DATA： 种草表现
	// DY_SHOP_DATA：抖音进店
	// USER_DISTRIBUTION_DATA：用户画像、
	// INDEX_SCORE_DATA： 指数得分
	// COMMENT_DATA：评论数据
	// 直播用户画像仅保留近90天且直播时长 >= 25 分钟直播数据
	Topics []enum.StarReportTopic `json:"topics,omitempty"`
	// StarID 发起请求的客户的starId
	StarID uint64 `json:"star_id,omitempty"`
	// WorkID 交付作品Id，如：视频Id，直播间room_id.
	WorkID uint64 `json:"work_id,omitempty"`
	// DemandID 任务Id
	DemandID uint64 `json:"demand_id,omitempty"`
}

ReportDataTopicConfigRequest 获取任务下累计可查询的数据指标 API Request

func (ReportDataTopicConfigRequest) Encode added in v1.29.1 

func (r ReportDataTopicConfigRequest) Encode() string

Encode implement GetRequest interface

type ReportDataTopicConfigResponse added in v1.29.1 

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

ReportDataTopicConfigResponse 获取任务下累计可查询的数据指标 API Response

type ReportDataTopicConfigResult added in v1.29.1 

type ReportDataTopicConfigResult struct {
	// Stat 对应请求的数据主题数组
	Stat []DataTopicConfig `json:"stat,omitempty"`
}

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 

func (r ReportOrderOverviewGetRequest) Encode() string

Encode implement GetRequest interface

type ReportOrderOverviewGetResponse 

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

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

type ReportOrderOverviewGetResult added in v1.29.1 

type ReportOrderOverviewGetResult 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"`
}

ReportOrderOverviewGetResult 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 

func (r ReportOrderUserDistributionGetRequest) Encode() string

Encode implement GetRequest interface

type ReportOrderUserDistributionGetResponse 

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

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

type ReportOrderUserDistributionGetResult added in v1.29.1 

type ReportOrderUserDistributionGetResult struct {
	// UpdateTime 数据更新时间，格式%Y-%m-%d %H:%M:%S
	UpdateTime string `json:"update_time,omitempty"`
	// 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"`
}

ReportOrderUserDistributionGetResult 返回值

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 传播表现

Source Files

View all Source files

Directories

Path Synopsis
Package task 获取星广联投(星图版)任务
 Package task 获取星广联投(星图版)任务

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.