report

Documentation

Overview

Package report 数据报表

Index

• type Dimension
• type FilterRange
• type GetRequest
  • func (r GetRequest) Encode() string
• type GetResponse
• type GetResponseData
• type LiveGetRequest
  • func (r LiveGetRequest) Encode() string
• type LiveGetResponse
• type LiveStat
• type LongTransferOrderGetData
• type LongTransferOrderGetFilter
• type LongTransferOrderGetRequest
  • func (r LongTransferOrderGetRequest) Encode() string
• type LongTransferOrderGetResponse
• type Metrics
• type Order
• type Stat
• type StatFiltering
• type UniPromotionGetRequest
  • func (r UniPromotionGetRequest) Encode() string
• type UniPromotionGetResponse
• type UniPromotionStats

Types

type Dimension

type Dimension struct {
	// StatDatetime 数据起始时间，分组条件包含 STAT_GROUP_BY_FIELD_STAT_TIME 时返回，格式为：yyyy-MM-dd HH:mm:ss
	StatDatetime string `json:"stat_datetime,omitempty"`
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignID 广告组id
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// CampaignName 广告组名称
	CampaignName string `json:"campaign_name,omitempty"`
	// AdID 计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// AdName 计划名称
	AdName string `json:"ad_name,omitempty"`
	// CreativeID 创意id
	CreativeID uint64 `json:"creative_id,omitempty"`
	// MaterialType 素材类型，允许值：
	// video ：视频素材
	// image ：图片素材
	MaterialType qianchuan.MaterialType `json:"material_type,omitempty"`
	// MarketingGoal 营销目标
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// MaterialID 素材id，一个素材唯一对应一个素材id，相同素材上传多次对应一个material_id
	MaterialID uint64 `json:"material_id,omitempty"`
	// CreateTime 素材创建时间，即该素材最近一次上传素材库的时间
	CreateTime string `json:"create_time,omitempty"`
	// Duration 视频时长，仅素材类型为视频素材有效
	Duration float64 `json:"duration,omitempty"`
	// RelatedAdCnt 关联计划数
	RelatedAdCnt int64 `json:"related_ad_cnt,omitempty"`
	// RelatedAdIDs 关联计划id
	RelatedAdIDs []uint64 `json:"related_ad_ids,omitempty"`
	// RelatedCreativeCnt 关联创意数
	RelatedCreativeCnt int64 `json:"related_creative_cnt,omitempty"`
	// RelatedCreativeIDs 关联创意id
	RelatedCreativeIDs []uint64 `json:"related_creative_ids,omitempty"`
	// Tags 素材标签，枚举值：
	// LQ：低质
	// Null：没有
	Tags string `json:"tags,omitempty"`
	// MaterialMode 素材样式筛选
	// 素材类型为视频素材时允许值：
	// VIDEO_LARGE：横版视频
	// VIDEO_VERTICAL：竖版视频
	// 素材类型为图片素材时允许值：
	// SMALL：横版小图
	// LARGE：横版大图
	// LARGE_VERTICAL：竖版图片
	// SQUARE ：商品卡方图
	MaterialMode enum.MaterialMode `json:"material_mode,omitempty"`
	// VideoSource 视频来源筛选，以平台素材库接口的视频来源枚举值为准，允许值：
	// E_COMMERCE：本地上传
	// LIVE_HIGHLIGHT：直播剪辑素材
	// BP：巨量纵横共享素材
	// VIDEO_CAPTURE：易拍APP共享素材
	// ARTHUR：亚瑟共享素材
	// STAR：星图&即合共享素材
	// TADA：tada共享素材
	// CREATIVE_CENTER：巨量创意PC共享素材
	// 注意：仅素材类型为视频素材时，支持
	VideoSource enum.MaterialSource `json:"video_source,omitempty"`
	// StartDate 开始日期
	StartDate string `json:"start_date,omitempty"`
	// EndDate 结束日期
	EndDate string `json:"end_date,omitempty"`
	// SearchWord 搜索词
	SearchWord string `json:"search_word,omitempty"`
	// Keyword 关键词
	Keyword string `json:"key_word,omitempty"`
	// KeywordMatchType 触发（匹配）方式:
	// EXTENSIVE: 广泛
	// PHRASE: 短语
	// PRECISION: 精确
	KeywordMatchType enum.KeywordMatchType `json:"keyword_match_type,omitempty"`
	// HSec 秒。指标数据对应的视频时间进度，例如：h_sec=3表示视频第三秒时产生的指标数据
	HSec int `json:"h_sec,omitempty"`
}

Dimension 维度数据

type FilterRange

type FilterRange struct {
	// Field 需要过来的指标，允许值：
	// 消耗：stat_cost
	// 展示次数：show_cnt
	// 转化数：convert_cnt
	// 转换成本：cpa_platform
	Field string `json:"field,omitempty"`
	// Calculation 计算方式，允许值：
	// UPPER 大于等于
	// LOWER 小于等于
	Calculation string `json:"calculation,omitempty"`
	// Value 数值范围
	Value string `json:"value,omitempty"`
}

FilterRange 更多过滤条件，支持根据词的消耗、展示次数、转化数、转换成本进行过滤

type GetRequest

type GetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// StartDate 起始日期,格式YYYY-MM-DD,只支持查询2016-10-26及以后的日期
	StartDate time.Time `json:"start_date,omitempty"`
	// EndDate 结束日期,格式YYYY-MM-DD,只支持查询2016-10-26及以后的日期，时间跨度不能超过30天
	EndDate time.Time `json:"end_date,omitempty"`
	// TimeGranularity 时间粒度 ，如果不传，返回查询日期内的聚合数据
	// 允许值:
	// TIME_GRANULARITY_DAILY (按天维度),会返回每天的数据
	// TIME_GRANULARITY_HOURLY (按小时维度)，会返回每小时维度的数据
	TimeGranularity enum.TimeGranularity `json:"time_granularity,omitempty"`
	// WordType 词类型，允许值：
	// SEARCH_WORD 搜索词
	// KEY_WORD 关键词
	WordType qianchuan.WordType `json:"word_type,omitempty"`
	// Fields 指定需要的指标名称
	Fields []string `json:"fields,omitempty"`
	// OrderField 排序字段，所有的统计指标均可参与排序
	OrderField string `json:"order_field,omitempty"`
	// OrderType 排序方式；默认值: DESC；允许值: ASC, DESC
	OrderType enum.OrderType `json:"order_type,omitempty"`
	// Page 页码；默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，即每页展示的数据量；默认值: 20；取值范围: 1-1000
	PageSize int `json:"page_size,omitempty"`
	// Filtering 过滤字段，json格式，支持字段如下
	Filtering *StatFiltering `json:"filtering,omitempty"`
}

GetRequest 获取数据报表API Request

func (GetRequest) Encode

func (r GetRequest) Encode() string

Encode implement GetRequest interface

type GetResponse

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

GetResponse 数据报表API Response

type GetResponseData

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

Data json返回值

type LiveGetRequest

type LiveGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AwemeID 抖音号ID
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// StartTime 直播开始时间，格式 2021-04-05 00:00:00 ，开播时间在筛选日期内的直播间，会被统计
	StartTime string `json:"start_time,omitempty"`
	// EndTime 直播结束时间，格式 2021-04-05 23:59:59，开始时间同一天的23:59:59
	// 即：查询的是一天0点～24点的直播数据
	EndTime string `json:"end_time,omitempty"`
	// Fields 需要查询的消耗指标，具体可参考返回值
	Fields []string `json:"fields,omitempty"`
	// StatsAuthority 需要查询的广告账户维度，直客账户支持查看官方抖音号下同主体全部广告账户的数据表现
	// 同主体账户：QUALIFICATION，仅直客账户支持
	// 当前账户：CURRENT，默认
	StatsAuthority qianchuan.StatsAuthority `json:"stats_authority,omitempty"`
}

LiveGetRequest 获取今日直播数据 API Request

func (LiveGetRequest) Encode

func (r LiveGetRequest) Encode() string

Encode implement GetRequest interface

type LiveGetResponse

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

LiveGetResponse 获取今日直播数据 API Response

type LiveStat

type LiveStat struct {
	// StatCost 消耗
	StatCost float64 `json:"stat_cost,omitempty"`
	// CpmPlatform 平均千次展现费用
	CpmPlatform float64 `json:"cpm_platform,omitempty"`
	// ClickCnt 广告点击次数
	ClickCnt int64 `json:"click_cnt,omitempty"`
	// Ctr 广告点击率
	Ctr float64 `json:"ctr,omitempty"`
	// TodayLivePayOrderGpm GPM
	TodayLivePayOrderGpm float64 `json:"today_live_pay_order_gpm,omitempty"`
	// LubanLivePayOrderGpm 广告GPM
	LubanLivePayOrderGpm float64 `json:"luban_live_pay_order_gpm,omitempty"`
	// CpcPlatform 广告点击单价
	CpcPlatform float64 `json:"cpc_platform,omitempty"`
	// ConvertCnt 广告转化数
	ConvertCnt int64 `json:"convert_cnt,omitempty"`
	// ConvertRate 广告转化率
	ConvertRate float64 `json:"convert_rate,omitempty"`
	// CpaPlatform 广告转化成本
	CpaPlatform float64 `json:"cpa_platform,omitempty"`
	// LivePayOrderGmvAlias 累计成交金额
	LivePayOrderGmvAlias float64 `json:"live_pay_order_gmv_alias,omitempty"`
	// LubanLivePayOrderGmv 广告成交金额
	LubanLivePayOrderGmv float64 `json:"luban_live_pay_order_gmv,omitempty"`
	// LivePayOrderGmvRoi 整体ROI
	LivePayOrderGmvRoi float64 `json:"live_pay_order_gmv_roi,omitempty"`
	// AdLivePrepayAndPayOrderGmvRoi 广告ROI
	AdLivePrepayAndPayOrderGmvRoi float64 `json:"ad_live_prepay_and_pay_order_gmv_roi,omitempty"`
	// LiveCreateOrderCountAlias 整体下单数
	LiveCreateOrderCountAlias int64 `json:"live_create_order_count_alias,omitempty"`
	// LiveCreateOrderRate 整体下单率
	LiveCreateOrderRate float64 `json:"live_create_order_rate,omitempty"`
	// LubanLiveOrderCount 广告下单数
	LubanLiveOrderCount int64 `json:"luban_live_order_count,omitempty"`
	// AdLiveCreateOrderRate 广告下单率
	AdLiveCreateOrderRate float64 `json:"ad_live_create_order_rate,omitempty"`
	// LivePayOrderRate 整体成单数
	LivePayOrderRate float64 `json:"live_pay_order_rate,omitempty"`
	// LubanLivePayOrderCount 广告成单数
	LubanLivePayOrderCount int64 `json:"luban_live_pay_order_count,omitempty"`
	// AdLivePayOrderRate 广告成单率
	AdLivePayOrderRate float64 `json:"ad_live_pay_order_rate,omitempty"`
	// LivePayOrderGmvAvg 直播间平均成单金额
	LivePayOrderGmvAvg float64 `json:"live_pay_order_gmv_avg,omitempty"`
	// AdLivePayOrderGmvAvg 广告平均成单金额
	AdLivePayOrderGmvAvg float64 `json:"ad_live_pay_order_gmv_avg,omitempty"`
	// LubanLivePrepayOrderCount 广告预售订单数
	LubanLivePrepayOrderCount int64 `json:"luban_live_prepay_order_count,omitempty"`
	// LubanLivePrepayOrderGmv 广告预售订单金额
	LubanLivePrepayOrderGmv float64 `json:"luban_live_prepay_order_gmv,omitempty"`
	// LivePrepayOrderCountAlias 整体预售订单数
	LivePrepayOrderCountAlias int64 `json:"live_prepay_order_count_alias,omitempty"`
	// LivePrepayOrderGmvAlias 整体预售订单金额
	LivePrepayOrderGmvAlias float64 `json:"live_prepay_order_gmv_alias,omitempty"`
	// LiveOrderPayCouponAmount 成交智能优惠券金额
	LiveOrderPayCouponAmount float64 `json:"live_order_pay_coupon_amount,omitempty"`
	// TotalLiveWatchCnt 直播间观看人次
	TotalLiveWatchCnt int64 `json:"total_live_watch_cnt,omitempty"`
	// TotalLiveFollowCnt 新增粉丝数
	TotalLiveFollowCnt int64 `json:"total_live_follow_cnt,omitempty"`
	// LiveWatchOneMinuteCount 广告引导超1分钟观看人数
	LiveWatchOneMinuteCount int64 `json:"live_watch_one_minute,omitempty"`
	// TotalLiveFansClubJoinCnt 直播间新加团人数
	TotalLiveFansClubJoinCnt int64 `json:"total_live_fans_club_join_cnt,omitempty"`
	// LiveClickCartCountAlias 直播间查看购物车次数
	LiveClickCartCountAlias int64 `json:"Live_click_cart_count_alias,omitempty"`
	// LiveClickProductCountAlias 直播间商品点击次数
	LiveClickProductCountAlias int64 `json:"live_click_product_count_alias,omitempty"`
	// TotalLiveCommentCnt 直播间评论次数
	TotalLiveCommentCnt int64 `json:"total_live_comment,omitempty"`
	// TotalLiveShareCnt 直播间分享次数
	TotalLiveShareCnt int64 `json:"total_live_share_cnt,omitempty"`
	// TotalLiveGiftCnt 直播间打赏次数
	TotalLiveGiftCnt int64 `json:"total_live_gift_cnt,omitempty"`
	// TotalLiveGiftAmount 直播间音浪收入
	TotalLiveGiftAmount float64 `json:"total_live_gift_amount,omitempty"`
}

LiveStat 直播数据

type LongTransferOrderGetData

type LongTransferOrderGetData struct {
	// List 订单数据列表
	List []Order `json:"list,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

type LongTransferOrderGetFilter

type LongTransferOrderGetFilter struct {
	// AdID 计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// MarketingGoal 可选值:
	// ALL: 所有
	// LIVE_PROM_GOODS: 直播间带货
	// VIDEO_PROM_GOODS: 短视频带货
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
}

LongTransferOrderGetFilter 过滤条件

type LongTransferOrderGetRequest

type LongTransferOrderGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// StartDate 开始时间，格式 2021-04-05
	StartDate time.Time `json:"start_date,omitempty"`
	// EndDate 结束时间，格式 2021-04-05，时间跨度不能超过90天
	EndDate time.Time `json:"end_date,omitempty"`
	// OptimizationTimeScope 可选值: 1、15、3、30、7
	OptimizationTimeScope int `json:"optimization_time_scope,omitempty"`
	// Filtering 过滤条件
	Filtering *LongTransferOrderGetFilter `json:"filtering,omitempty"`
	// OrderType 可选值: ASC默认、DESC
	OrderType enum.OrderType `json:"order_type,omitempty"`
	// Page 页码，默认值：1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，允许值：10, 20, 50, 100, 200，默认值：10
	PageSize int `json:"page_size,omitempty"`
}

LongTransferOrderGetRequest 长周期转化价值-订单明细 API Request

func (LongTransferOrderGetRequest) Encode

func (r LongTransferOrderGetRequest) Encode() string

type LongTransferOrderGetResponse

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

LongTransferOrderGetResponse 长周期转化价值-订单明细 API Response

type Metrics

type Metrics struct {
	// StatCost 消耗
	StatCost float64 `json:"stat_cost,omitempty"`
	// ShowCnt 展示数
	ShowCnt int64 `json:"show_cnt,omitempty"`
	// Ctr 点击率
	Ctr float64 `json:"ctr,omitempty"`
	// CpmPlatform 平均千次展示成本
	CpmPlatform float64 `json:"cpm_platform,omitempty"`
	// ClickCnt 点击数
	ClickCnt int64 `json:"click_cnt,omitempty"`
	// PayOrderCount 成交订单数
	PayOrderCount int64 `json:"pay_order_count,omitempty"`
	// CreateOrderAmount 下单成交金额
	CreateOrderAmount float64 `json:"create_order_amount,omitempty"`
	// CreateOrderCount 下单订单数
	CreateOrderCount int64 `json:"create_order_count,omitempty"`
	// PayOrderAmount 成交订单金额
	PayOrderAmount float64 `json:"pay_order_amount,omitempty"`
	// CreateOrderROI 下单roi
	CreateOrderROI float64 `json:"create_order_roi,omitempty"`
	// PrepayAndPayOrderROI 支付roi
	PrepayAndPayOrderROI float64 `json:"prepay_and_pay_order_roi,omitempty"`
	// PrepayOrderCount 广告预售订单数
	PrepayOrderCount int64 `json:"prepay_order_count,omitempty"`
	// PrepayOrderAmount 广告预售订单金额
	PrepayOrderAmount float64 `json:"prepay_order_amount,omitempty"`
	// ConvertCnt 转化数
	ConvertCnt int64 `json:"convert_cnt,omitempty"`
	// ConversionCost 转化成本
	ConversionCost float64 `json:"conversion_cost,omitempty"`
	// ConversionRate 转化率
	ConversionRate float64 `json:"conversion_rate,omitempty"`
	// EcpConvertRate 转化率
	EcpConvertRate float64 `json:"ecp_convert_rate,omitempty"`
	// EcpConvertCnt 转化数
	EcpConvertCnt int64 `json:"ecp_convert_cnt,omitempty"`
	// EcpConvertPlatform 转化成本
	EcpConvertPlatform float64 `json:"ecp_convert_platform,omitempty"`
	// EcpCpaPlatform 转化成本
	EcpCpaPlatform float64 `json:"ecp_cpa_platform,omitempty"`
	// DyFollow 新增关注数
	DyFollow int64 `json:"dy_follow,omitempty"`
	// DyLike 点赞数
	DyLike int64 `json:"dy_like,omitempty"`
	// DyComment 评论提交数
	DyComment int64 `json:"dy_comment,omitempty"`
	// DyShare 分享数
	DyShare int64 `json:"dy_share,omitempty"`
	// LivePayOrderCostPerOrder 成交客单价。短视频带货：VIDEO_PROM_GOODS 不支持该指标
	LivePayOrderCostPerOrder int64 `json:"live_pay_order_cost_per_order,omitempty"`
	// LubanLiveEnterCnt 直播间观看人次。短视频带货：VIDEO_PROM_GOODS 不支持该指标
	LubanLiveEnterCnt int64 `json:"luban_live_enter_cnt,omitempty"`
	// LiveWatchOneMinuteCount 直播间超过1分钟观看人次。短视频带货：VIDEO_PROM_GOODS 不支持该指标
	LiveWatchOneMinuteCount int64 `json:"live_watch_one_minute_count,omitempty"`
	// LiveFansClubJoinCnt 直播间新加团人次。短视频带货：VIDEO_PROM_GOODS 不支持该指标
	LiveFansClubJoinCnt int64 `json:"live_fans_club_join_cnt,omitempty"`
	// LubanLiveSlidecartClickCnt 直播间查看购物车次数。短视频带货：VIDEO_PROM_GOODS 不支持该指标
	LubanLiveSlidecartClickCnt int64 `json:"luban_live_slidecart_click_cnt,omitempty"`
	// LubanLiveClickProductCnt 直播间商品点击次数。短视频带货：VIDEO_PROM_GOODS 不支持该指标
	LubanLiveClickProductCnt int64 `json:"luban_live_click_product_cnt,omitempty"`
	// LubanLiveCommentCnt 直播间评论次数。短视频带货：VIDEO_PROM_GOODS 不支持该指标
	LubanLiveCommentCnt int64 `json:"luban_live_comment_cnt,omitempty"`
	// LubanLiveShareCnt 直播间分享次数。短视频带货：VIDEO_PROM_GOODS 不支持该指标
	LubanLiveShareCnt int64 `json:"luban_live_share_cnt,omitempty"`
	// LubanLiveGiftCnt 直播间打赏次数。短视频带货：VIDEO_PROM_GOODS 不支持该指标
	LubanLiveGiftCnt int64 `json:"luban_live_gift_cnt,omitempty"`
	// LubanLiveGiftAmount 直播间音浪收入。短视频带货：VIDEO_PROM_GOODS 不支持该指标
	LubanLiveGiftAmount float64 `json:"luban_live_gift_amount,omitempty"`
	// TotalPlay 播放数
	TotalPlay int64 `json:"total_play,omitempty"`
	// PlayDuration3s 3s播放数
	PlayDuration3s int64 `json:"play_duration_3s,omitempty"`
	// Play25FeedBreak 25%进度播放数
	Play25FeedBreak int64 `json:"play_25_feed_break,omitempty"`
	// Play50FeedBreak 50%进度播放数
	Play50FeedBreak int64 `json:"play_50_feed_break,omitempty"`
	// Play75FeedBreak 75%进度播放数
	Play75FeedBreak int64 `json:"play_75_feed_break,omitempty"`
	// PlayOver 播放完成数
	PlayOver int64 `json:"play_over,omitempty"`
	// PlayOverRate 完播率
	PlayOverRate float64 `json:"play_over_rate,omitempty"`
	// ValidPlay 有效播放数
	ValidPlay int64 `json:"valid_play,omitempty"`
	// AveragePlayTimePerPlay 平均单次播放时长
	AveragePlayTimePerPlay float64 `json:"average_play_time_per_play,omitempty"`
	// ValidPlayRate 有效播放率
	ValidPlayRate float64 `json:"valid_play_rate,omitempty"`
	// CpcPlatform 平均点击单价
	CpcPlatform float64 `json:"cpc_platform,omitempty"`
	// DeepConvertCnt 深度转化次数
	DeepConvertCnt int64 `json:"deep_convert_cnt,omitempty"`
	// DeepConvertCost 深度转化成本
	DeepConvertCost float64 `json:"deep_convert_cost,omitempty"`
	// DeepConvertRate 深度转化率
	DeepConvertRate float64 `json:"deep_convert_rate,omitempty"`
	// AttributionConvertCnt 转化数（计费时间）
	AttributionConvertCnt int64 `json:"attribution_convert_cnt,omitempty"`
	// AttributionConvertRate 转化率（计费时间）
	AttributionConvertRate float64 `json:"attribution_convert_rate,omitempty"`
	// AttributionConvertCost 转化成本（计费时间）
	AttributionConvertCost float64 `json:"attribution_convert_cost,omitempty"`
	// AttributionDeepConvertCnt 深度转化次数（计费时间）
	AttributionDeepConvertCnt int64 `json:"attribution_deep_convert_cnt,omitempty"`
	// AttributionDeepConvertCost 深度转化成本（计费时间）
	AttributionDeepCOnvertCost float64 `json:"attribution_deep_convert_cost,omitempty"`
	// AttributionDeepConvertRate 深度转化率（计费时间）
	AttributionDeepConvertRate float64 `json:"attribution_deep_convert_rate,omitempty"`
	// AllOrderCreateRoi7Days 7日总下单ROI
	AllOrderCreateRoi7Days float64 `json:"all_order_create_roi_7days,omitempty"`
	// AllOrderPayRoi7Days 7日总支付ROI
	AllOrderPayRoi7Days float64 `json:"all_order_pay_roi_7days,omitempty"`
	// AllOrderPayCount7Days 7日总成交订单
	AllOrderPayCount7Days int64 `json:"all_order_pay_count_7days,omitempty"`
	// AllOrderPayGmv7Days 7日总成交金额
	AllOrderPayGmv7Days float64 `json:"all_order_pay_gmv_7days,omitempty"`
	// PayOrderCostPerOrder 直接成交客单价
	PayOrderCostPerOrder float64 `json:"pay_order_cost_per_order,omitempty"`
	// CreateOrderCouponAmount 下单智能优惠券金额
	CreateOrderCouponAmount float64 `json:"create_order_coupon_amount,omitempty"`
	// PayOrderCouponAmount 支付智能优惠券金额
	PayOrderCouponAmount float64 `json:"pay_order_coupon_amount,omitempty"`
	// IndirectOrderCreateCount7Days 间接下单订单数
	IndirectOrderCreateCount7Days int64 `json:"indirect_order_create_count_7days,omitempty"`
	// IndirectOrderCrreateGmv7Days 间接下单金额
	IndirectOrderCrreateGmv7Days float64 `json:"indirect_order_crreate_gmv_7days,omitempty"`
	// IndirectOrderPayCount7Days 间接支付订单数
	IndirectOrderPayCount7Days int64 `json:"indirect_order_pay_count_7days,omitempty"`
	// IndirectOrderPayGmv7Days 间接支付金额
	IndirectOrderPayGmv7Days float64 `json:"indirect_order_pay_gmv_7days,omitempty"`
	// IndirectOrderPrePayCount7Days 间接预售订单数
	IndirectOrderPrePayCount7Days int64 `json:"indirect_order_pre_pay_count_7days,omitempty"`
	// IndirectOrderPrePayGmv7Days 间接预售金额
	IndirectOrderPrePayGmv7Days float64 `json:"indirect_order_pre_pay_gmv_7days,omitempty"`
	// QianchuanFistOrderCnt 店铺首单新客人数
	QianchuanFirstOrderCnt int64 `json:"qianchuan_first_order_cnt,omitempty"`
	// QianchuanFistOrderRate 店铺首单新客订单占比
	QianchuanFirstOrderRate float64 `json:"qianchuan_first_order_rate,omitempty"`
	// QianchuanFirstOrderConvertCost 店铺首单新客转化成本
	QianchuanFirstOrderConvertCost float64 `json:"qianchuan_first_order_convert_cost,omitempty"`
	// QianchuanFirstOrderDirectPayGmv 店铺首单新客直接成交金额
	QianchuanFirstOrderDirectPayGmv float64 `json:"qianchuan_first_order_direct_pay_gmv,omitempty"`
	// QianchuanFirstOrderDirectPayOrderRoi 店铺首单新客直接支付ROI
	QianchuanFirstOrderDirectPayOrderRoi float64 `json:"qianchuan_first_order_direct_pay_order_roi,omitempty"`
	// QianchuanFirstOrderLtv30 店铺首单新客30天累计成交金额
	QianchuanFirstOrderLtv30 float64 `json:"qianchuan_first_order_ltv_30,omitempty"`
	// QianchuanFirstOrderRoi30 店铺首单新客30天累计支付ROI
	QianchuanFirstOrderRoi30 float64 `json:"qianchuan_first_order_roi_30,omitempty"`
	// QianchuanBrandFirstOrderRate 品牌首单新客订单占比
	QianchuanBrandFirstOrderRate float64 `json:"qianchuan_brand_first_order_rate,omitempty"`
	// QianchuanBrandFirstOrderConvertCost 品牌首单新客转化成本
	QianchuanBrandFirstOrderConvertCost float64 `json:"qianchuan_brand_first_order_convert_cost,omitempty"`
	// QianchuanBrandFirstOrderLtv30 品牌首单新客30天累计成交金额
	QianchuanBrandFirstOrderLtv30 float64 `json:"qianchuan_brand_first_order_ltv_30,omitempty"`
	// QianchuanBrandFirstOrderDirectPayOrderRoi 品牌首单新客直接支付roi
	QianchuanBrandFirstOrderDirectPayOrderRoi float64 `json:"qianchuan_brand_first_order_direct_pay_order_roi,omitempty"`
	// QianchuanBrandFirstOrderRoi30 品牌首单新客30天累计支付roi
	QianchuanBrandFirstOrderRoi30 float64 `json:"qianchuan_brand_first_order_roi_30,omitempty"`
	// QianchuanBrandFirstOrderCnt 品牌首单新客数
	QianchuanBrandFirstOrderCnt int64 `json:"qianchuan_brand_first_order_cnt,omitempty"`
	// QianchuanBrandFirstOrderDirectPayGmv 品牌首单新客直接成交金额
	QianchuanBrandFirstOrderDirectPayGmv float64 `json:"qianchuan_brand_first_order_direct_pay_gmv,omitempty"`
	// QianchuanAuthorFirstOrderRate 抖音号首单新客订单占比
	QianchuanAuthorFirstOrderRate float64 `json:"qianchuan_author_first_order_rate,omitempty"`
	// QianchuanAuthorFirstOrderRoi30 抖音号首单新客30天累计支付roi
	QianchuanAuthorFirstOrderRoi30 float64 `json:"qianchuan_author_first_order_roi_30,omitempty"`
	// QianchuanAuthorFirstOrderCnt 抖音号首单新客数
	QianchuanAuthorFirstOrderCnt int64 `json:"qianchuan_author_first_order_cnt,omitempty"`
	// QianchuanAuthorFirstOrderConvertCost 抖音号首单新客转化成本
	QianchuanAuthorFirstOrderConvertCost float64 `json:"qianchuan_author_first_order_convert_cost,omitempty"`
	// QianchuanAuthorFirstOrderDirectPayGmv 抖音号首单新客直接成交金额
	QianchuanAuthorFirstOrderDirectPayGmv float64 `json:"qianchuan_author_first_order_direct_pay_gmv,omitempty"`
	// QianchuanAuthorFIrstOrderDirectPayOrderRoi 抖音号首单新客直接支付roi
	QianchuanAuthorFIrstOrderDirectPayOrderRoi float64 `json:"qianchuan_author_first_order_direct_pay_order_roi,omitempty"`
	// QianchuanAuthorFirstOrderLtv30 抖音号首单新客30天累计成交金额
	QianchuanAuthorFirstOrderLtv30 float64 `json:"qianchuan_author_first_order_ltv_30,omitempty"`
	// LiveOrderSettleAmount14d 14天结算金额
	LiveOrderSettleAmount14d float64 `json:"live_order_settle_amount_14d,omitempty"`
	// LiveOrderSettleCount14d 14天结算订单数
	LiveOrderSettleCount14d int64 `json:"live_order_settle_count_14d,omitempty"`
	// LiveOrderSettleCountRate14d 14天结算订单率
	LiveOrderSettleCountRate14d float64 `json:"live_order_settle_count_rate_14d,omitempty"`
	// AdLiveOrderSettleRoi14d 14天结算roi
	AdLiveOrderSettleRoi14d float64 `json:"ad_live_order_settle_roi_14d,omitempty"`
	// AdLiveOrderSettleCost14d 14天结算成本
	AdLiveOrderSettleCost14d float64 `json:"ad_live_order_settle_cost_14d,omitempty"`
	// DislikeCnt 不感兴趣数
	DislikeCnt int64 `json:"dislike_cnt,omitempty"`
	// ReportCnt 举报数
	ReportCnt int64 `json:"report_cnt,omitempty"`
	// UserLoseCnt 流失数
	UserLoseCnt int64 `json:"user_lose_cnt,omitempty"`
}

Metrics 指标数据

type Order

type Order struct {
	// OrderID 订单编号
	OrderID uint64 `json:"order_id,omitempty"`
	// AdID 计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// AdName 计划名称
	AdName string `json:"ad_name,omitempty"`
	// OrderPlaceTime 用户下单时间
	OrderPlaceTime string `json:"order_place_time,omitempty"`
	// IsPay 支付属性，PAID: 已支付、UNPAID: 未支付
	IsPay qianchuan.PayStatus `json:"is_pay,omitempty"`
	// PayType 订单类型，DIRECT: 直接转换订单、INDIRECT: 间接转化订单
	PayType qianchuan.PayType `json:"pay_type,omitempty"`
	// OrderFlowSource 订单来源
	// ACTIVITY: 直播-活动页面
	// DOUYIN_SHOPPING_CENTER: 直播-抖音商城
	// GENERAL_SEARCH: 直播-搜索
	// GUESS_YOU_LIKE: 短视频-猜你喜欢
	// HOMEPAGE_FOLLOW: 直播-关注来源
	// LIVE: 直播
	// LIVE_OTHER: 直播-其他
	// OTHERS_HOMEPAGE: 直播-个人主页
	// OTHER_PROFILE: 短视频-达人个人主页
	// PRODUCT_CARD: 商品卡
	// PRODUCT_CARD_GENERAL_SEARCH: 商户卡-搜索
	// PRODUCT_CARD_OTHER: 商户卡-购物车/收藏
	// QIANCHUAN_PROMOTE: 千川推广
	// RECOMMEND_LIVE: 直播-自然推荐
	// RECOMMEND_PRODUCT: 商户卡-商城/商品推荐
	// RECOMMEND_VIDEO: 短视频-短视频推荐
	// SHOP_WINDOW: 商户卡-橱窗/店铺
	// UNKNOWN: 未知
	// VIDEO: 短视频
	// VIDEO_ACTIVITY: 短视频-活动页
	// VIDEO_GENERAL_SEARCH: 短视频-搜索
	// VIDEO_HOMEPAGE_FOLLOW: 短视频-关注来源
	// VIDEO_OTHER: 短视频-其他
	// VIDEO_TO_LIVE: 直播-短视频引流
	OrderFlowSource qianchuan.OrderFlowSource `json:"order_flow_source,omitempty"`
	// OrderAmount 订单金额
	OrderAmount float64 `json:"order_amount,omitempty"`
}

Order 订单数据

type Stat

type Stat struct {
	Dimension
	Metrics
	// Fields 指标数据
	Fields *Metrics `json:"metrics,omitempty"`
}

Stat 统计数据

type StatFiltering

type StatFiltering struct {
	// CampaignIDs 广告组id列表：按照campaign_id过滤，最多支持100个
	CampaignIDs []uint64 `json:"campaign_ids,omitempty"`
	// AdIDs 广告计划id列表：按照 ad_id 过滤，最多支持100个
	AdIDs []uint64 `json:"ad_ids,omitempty"`
	// CreativeIDs 广告创意id列表：按照 creative_id 过滤，最多支持100个
	CreativeIDs []uint64 `json:"creative_ids,omitempty"`
	// AwemeIDs 按抖音id过滤，即关联的抖音号
	AwemeIDs []uint64 `json:"aweme_ids,omitempty"`
	// MarketingGoal 营销目标
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// OrderPlatform 下单平台，允许值：
	// ALL：全部
	// QIANCHUAN： 千川pc（默认）
	// ECP_AWEME：小店随心推
	OrderPlatform qianchuan.OrderPlatform `json:"order_platform,omitempty"`
	// MarketingScene 营销场景，允许值：
	// ALL：全部
	// FEED： 通投广告
	// SEARCH：搜索广告
	// 注意：当下单平台为“小店随心推”时，不支持
	MarketingScene qianchuan.MarketingScene `json:"marketing_scene,omitempty"`
	// CampaignScene 营销场景，可选值
	// DAILY_SALE：日常销售（默认）
	// 注意：当下单平台为“小店随心推”时，不支持
	CampaignScene qianchuan.CampaignScene `json:"campaign_scene,omitempty"`
	// ExternalAction 优化目标，如果不填，默认查的是当前营销目标下的所有优化目标
	// 当营销目标为直播带货时，允许值为：
	// AD_CONVERT_TYPE_LIVE_CLICK_PRODUCT_ACTION: 直播间商品点击
	// AD_CONVERT_TYPE_LIVE_COMMENT_ACTION: 直播间评论
	// AD_CONVERT_TYPE_LIVE_ENTER_ACTION: 进入直播间
	// AD_CONVERT_TYPE_LIVE_ROI: 直播间支付ROI
	// AD_CONVERT_TYPE_LIVE_SUCCESSORDER_ACTION: 直播间下单
	// AD_CONVERT_TYPE_LIVE_SUCCESSORDER_PAY: 直播间成交
	// AD_CONVERT_TYPE_NEW_FOLLOW_ACTION: 直播间粉丝提升
	// 当营销目标为短视频带货时，允许值：
	// AD_CONVERT_TYPE_QC_FOLLOW_ACTION: 粉丝提升
	// AD_CONVERT_TYPE_QC_MUST_BUY: 点赞评论
	// AD_CONVERT_TYPE_SHOPPING: 商品购买
	// ROIAD_CONVERT_TYPE_VIDEO_ROI:商品支付
	ExternalAction qianchuan.ExternalAction `json:"external_action,omitempty"`
	// CreativeMaterialMode 按创意类型过滤，允许值：
	// CUSTOM_CREATIVE：自定义创意
	// PROGRAMMATIC_CREATIVE： 程序化创意
	// 注意：
	// 1.当下单平台为“小店随心推”时，不支持
	// 2.当创意类型为CUSTOM_CREATIVE时，包含高光快投创意
	CreativeMaterialMode enum.CreativeMaterialMode `json:"creative_material_mode,omitempty"`
	// ImageMode 按素材样式过滤，支持视频和图片，枚举值见【附录-枚举值-素材类型】（暂不支持“小图”和“穿山甲开屏图片”）
	// 注意：
	// 1.当下单平台为“小店随心推”时，不支持
	// 2.素材样式为竖版视频时，包含高光快投创意
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// SmartBidType 投放场景（投放方式），允许值：
	// SMART_BID_CUSTOM：控成本投放
	// SMART_BID_CONSERVATIVE： 放量投放
	// 注意：当下单平台为“小店随心推”或营销场景为“搜索广告”时，不支持
	SmartBidType enum.SmartBidType `json:"smart_bid_type,omitempty"`
	// Status 按计划状态过滤，不传入即默认返回“全部（包含已删除）”，其他规则详见【附录-广告计划查询状态】（暂不支持“系统暂停”和“在投计划配额超限”）
	// 注意：当下单平台为“小店随心推”时，不支持
	Status qianchuan.AdStatusForSearch `json:"status,omitempty"`
	// IsHighlight 是否返回高光快投创意，允许值：
	// ALL：包含高光快投创意
	// ONLY_HIGHLIGHT：只返回高光快投创意
	// NO_HIGHLIGHT：返回非高光快投创意，默认值
	IsHighlight string `json:"is_highlight,omitempty"`
	// MaterialType 素材类型，允许值：
	// video ：视频素材
	// image ：图片素材
	MaterialType qianchuan.MaterialType `json:"material_type,omitempty"`
	// VideoSource 视频来源筛选，以平台素材库接口的视频来源枚举值为准，允许值：
	// E_COMMERCE：本地上传
	// LIVE_HIGHLIGHT：直播剪辑素材
	// BP：巨量纵横共享素材
	// VIDEO_CAPTURE：易拍APP共享素材
	// ARTHUR：亚瑟共享素材
	// STAR：星图&即合共享素材
	// TADA：tada共享素材
	// CREATIVE_CENTER：巨量创意PC共享素材
	// 注意：仅素材类型为视频素材时，支持
	VideoSource enum.MaterialSource `json:"video_source,omitempty"`
	// MaterialID 素材id列表，一个素材唯一对应一个素材id，相同素材上传多次对应一个material_id
	MaterialID []uint64 `json:"material_id,omitempty"`
	// MaterialMode 素材样式筛选
	// 素材类型为视频素材时允许值：
	// VIDEO_LARGE：横版视频
	// VIDEO_VERTICAL：竖版视频
	// 素材类型为图片素材时允许值：
	// SMALL：横版小图
	// LARGE：横版大图
	// LARGE_VERTICAL：竖版图片
	// SQUARE ：商品卡方图
	MaterialMode []enum.MaterialMode `json:"material_mode,omitempty"`
	// AnalysisType 素材建议，允许值
	// first_publish：首发素材
	// high_quality：优质素材
	// low_efficiency：低效素材
	AnalysisType []string `json:"analysis_type,omitempty"`
	// WordType 词类型，当word有传值时，必填，允许值：
	// SEARCH_WORD搜索词
	// KEY_WORD关键词
	WordType qianchuan.WordType `json:"word_type,omitempty"`
	// Word 具体需要过滤的词
	Word string `json:"word,omitempty"`
	// KeywordMerge 合并关键词，可选值
	// true、false（默认）
	// 注意：打开后，将以关键词维度聚合数据，汇总相同关键词在不同计划下的数据
	KeywordMerge bool `json:"keyword_merge,omitempty"`
	// Range 更多过滤条件，支持根据词的消耗、展示次数、转化数、转换成本进行过滤
	Range *FilterRange `json:"range,omitempty"`
}

StatFiltering 数据报表过滤条件

type UniPromotionGetRequest

type UniPromotionGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// StartDate 起始日期,格式YYYY-MM-DD,只支持查询2016-10-26及以后的日期
	StartDate string `json:"start_date,omitempty"`
	// EndDate 结束日期,格式YYYY-MM-DD,只支持查询2016-10-26及以后的日期，时间跨度不能超过30天
	EndDate string `json:"end_date,omitempty"`
	// MarketingGoal 按营销目标过滤，允许值：LIVE_PROM_GOODS：直播带货
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// LabAdType 推广方式，允许值：LAB_AD 托管
	LabAdType enum.AdLabType `json:"lab_ad_type,omitempty"`
	// Fields 需要查询的消耗指标，具体可参考返回值
	Fields []string `json:"fields,omitempty"`
}

UniPromotionGetRequest 全域推广数据 API Request

func (UniPromotionGetRequest) Encode

func (r UniPromotionGetRequest) Encode() string

Encode implement GetRequest interface

type UniPromotionGetResponse

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

UniPromotionGetResponse 全域推广数据 API Response

type UniPromotionStats

type UniPromotionStats struct {
	// StatCost 整体消耗，千分之一分
	StatCost float64 `json:"stat_cost,omitempty"`
	// TotalPrepayAndPayOrderRoi2 整体支付ROI
	TotalPrepayAndPayOrderRoi2 float64 `json:"total_prepay_and_pay_order_roi2,omitempty"`
	// TotalPayOrderGmvForRoi2 整体成交金额
	TotalPayOrderGmvForRoi2 float64 `json:"total_pay_order_gmv_for_roi2,omitempty"`
	// TotalPayOrderCountForRoi2 整体成交订单数
	TotalPayOrderCountForRoi2 int64 `json:"total_pay_order_count_for_roi2,omitempty"`
	// TotalCostPerPayOrderForRoi2 整体成交订单成本
	TotalCostPerPayOrderForRoi2 float64 `json:"total_cost_per_pay_order_for_roi2,omitempty"`
	// TotalPrepayOrderCountForRoi2 整体预售订单数
	TotalPrepayOrderCountForRoi2 int64 `json:"total_prepay_order_count_for_roi2,omitempty"`
	// TotalPrepayOrderGmvForRoi2 整体预售订单成本
	TotalPrepayOrderGmvForRoi2 float64 `json:"total_prepay_order_gmv_for_roi2,omitempty"`
}

UniPromotionStats 全域推广消耗指标