Documentation
¶
Overview ¶
Package live 直播间相关API
Index ¶
- type Age
- type City
- type Gender
- type ProductStat
- type Room
- type RoomDetailGetRequest
- type RoomDetailGetResponse
- type RoomFlowPerformance
- type RoomFlowPerformanceGetRequest
- type RoomFlowPerformanceGetResponse
- type RoomGetData
- type RoomGetRequest
- type RoomGetResponse
- type RoomProductListData
- type RoomProductListGetRequest
- type RoomProductListGetResponse
- type RoomStat
- type RoomUser
- type RoomUserGetRequest
- type RoomUserGetResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Age ¶
type Age struct { // AgeType 年龄阶段 AgeType string `json:"age_type,omitempty"` // Value 人数 Value int64 `json:"value,omitempty"` }
Age 年龄
type City ¶
type City struct { // CityName 城市名称 CityName string `json:"city_name,omitempty"` // Value 人数 Value int64 `json:"value,omitempty"` }
City 地域
type Gender ¶
type Gender struct { // GenderType 性别类型 GenderType string `json:"gender_type,omitempty"` // Value 人数 Value int64 `json:"value,omitempty"` }
Gender 性别
type ProductStat ¶
type ProductStat struct { // ProductID 商品id ProductID uint64 `json:"productId,omitempty"` // Title 商品名称 Title string `json:"title,omitempty"` // ImgURL 商品缩略图 ImgURL string `json:"img_url,omitempty"` // ExplainStatus 商品状态,可选值: // BEINGEXPLAIN: 讲解中 // HASEXPLAIN: 已讲解 // UNEXPLAIN: 未讲解 ExplainStatus qianchuan.ExplainStatus `json:"explain_status,omitempty"` // LiveCostPerProduct 消耗 LiveCostPerProduct float64 `json:"live_cost_per_product,omitempty"` // LiveProductBindTime 上架时间 LiveProductBindTime string `json:"live_product_bind_time,omitempty"` // LiveProductPrice 价格 LiveProductPrice float64 `json:"live_product_price,omitempty"` // LiveProductExplainCnt 讲解次数 LiveProductExplainCnt int64 `json:"live_product_explain_cnt,omitempty"` // LiveProductInventory 库存 LiveProductInventory int64 `json:"live_product_inventory,omitempty"` // LiveOrderRefundAmount 广告实时退款金额 LiveOrderRefundAmount float64 `json:"live_order_refund_amount,omitempty"` // LiveOrderSettleAmount7d 广告7天结算金额 LiveOrderSettleAmount7d float64 `json:"live_order_settle_amount_7d,omitempty"` // LiveOrderSettleCount7d 广告7天结算订单数 LiveOrderSettleCount7d int64 `json:"live_order_settle_count_7d,omitempty"` // LiveOrderSettleCountRate7d 广告7天结算订单数 LiveOrderSettleCountRate7d float64 `json:"live_order_settle_count_rate_7d,omitempty"` // AdLiveOrderSettleRoiPerProduct7d 广告7天结算roi AdLiveOrderSettleRoiPerProduct7d float64 `json:"ad_live_order_settle_roi_per_product_7d"` // AdLiveOrderSettleCostPerProduct7d 广告7天结算成本 AdLiveOrderSettleCostPerProduct7d float64 `json:"ad_live_order_settle_cost_per_product_7d"` // LivePayOrderGmvAlias 累积GMV LivePayOrderGmvAlias float64 `json:"live_pay_order_gmv_alias,omitempty"` // LubanLivePayOrderGmv 广告GMV LoubanLivePayOrderGmv float64 `json:"luban_live_pay_order_gmv,omitempty"` // LivePayOrderCountAlias 累计成交订单 LivePayOrderCountAlias int64 `json:"live_pay_order_count_alias,omitempty"` // LubanLivePayOrderCount 广告成交订单 LubanLivePayOrderCount int64 `json:"luban_live_pay_order_count,omitempty"` // LivePayOrderRoiPerProduct 直接支付ROI LivePayOrderRoiPerProduct float64 `json:"live_pay_order_roi_per_product,omitempty"` // ProductClickPayUcntRatio 点击-成交转化率 ProductClickPayUcntRatio float64 `json:"product_click_pay_ucnt_ratio,omitempty"` // TotalLivePayOrderGmvEcom GPM TotalLivePayOrderGmvEcom float64 `json:"total_live_pay_order_gpm_ecom,omitempty"` }
ProductStat 商品数据
type Room ¶
type Room struct { // RoomID 直播间id RoomID uint64 `json:"room_id,omitempty"` // RoomStatus 直播间状态 RoomStatus qianchuan.RoomStatus `json:"room_status,omitempty"` // RoomTitle 直播间标题 RoomTitle string `json:"room_title,omitempty"` // RoomCover 直播间封面图url列表 RoomCover string `json:"room_cover,omitempty"` // StartTime 直播开始时间 StartTime string `json:"start_time,omitempty"` // EndTime 直播结束时间 EndTime string `json:"end_time,omitempty"` // AwemeID 抖音号id AwemeID uint64 `json:"aweme_id,omitempty"` // AwemeName 抖音号名称 AwemeName string `json:"aweme_name,omitempty"` // AwemeAvatar 抖音号头像url列表 AwemeAvatar string `json:"aweme_avatar,omitempty"` // RoomDelivery 在投计划数 RoomDelivery int64 `json:"room_delivery,omitempty"` // AnchorID 主播ID AnchorID uint64 `json:"anchor_id,omitempty"` // AnchorName 主播名称 AnchorName string `json:"anchor_name,omitempty"` // AnchorAvatar 主播头像 AnchorAvatar string `json:"anchor_avatar,omitempty"` }
Room 直播间信息
type RoomDetailGetRequest ¶
type RoomDetailGetRequest struct { // AdvertiserID 广告主id AdvertiserID uint64 `json:"advertiser_id,omitempty"` // RoomID 直播间id RoomID uint64 `json:"room_id,omitempty"` }
RoomDetailGetRequest 获取直播间详情 API Request
func (RoomDetailGetRequest) Encode ¶
func (r RoomDetailGetRequest) Encode() string
Encode implement GetRequest interface
type RoomDetailGetResponse ¶
type RoomDetailGetResponse struct { model.BaseResponse Data *Room `json:"data,omitempty"` }
RoomDetailGetResponse 获取直播间详情 API Response
type RoomFlowPerformance ¶
type RoomFlowPerformance struct { // LiveDouPlus 抖+直播 LiveDouPlus int64 `json:"live_dou_plus,omitempty"` // LiveAwemePromote 抖音号推广直播 LiveAwemePromote int64 `json:"live_aweme_promote,omitempty"` // LiveLuban 鲁班直播 LiveLuban int64 `json:"live_luban,omitempty"` // LiveBrandRedirect 品牌引流直播间 LiveBrandRedirect int64 `json:"live_brand_redirect,omitempty"` // LiveBrandTop 品牌toplive LiveBrandTop int64 `json:"live_brand_top,omitempty"` // LiveBrandDirect 品牌直投直播间(feedslive) LiveBrandDirect int64 `json:"live_brand_direct,omitempty"` // LiveOtherBidding 其他竞价直播 LiveOtherBidding int64 `json:"live_other_bidding,omitempty"` // LivePcQianChuan 千川直播PC LivePcQianChuan int64 `json:"live_pc_qian_chuan,omitempty"` // LiveXiaoDianQianChuan 千川直播小店随心推 LiveXiaoDianQianChuan int64 `json:"live_xiao_dian_qian_chuan,omitempty"` // RoomPromotionLive 直播间推广 RoomPromotionLive int64 `json:"room_promotion_live,omitempty"` // QianChuanBrandFeedsLiveAd 千川品牌feedslive广告 QianChuanBrandFeedsLiveAd int64 `json:"qian_chuan_brand_feeds_live_ad,omitempty"` // QianChuanBrandFeedsLiveSearch 千川品牌feedslive服务 QianChuanBrandFeedsLiveSearch int64 `json:"qian_chuan_brand_feeds_live_search,omitempty"` // Nature 自然流量 Nature int64 `json:"nature,omitempty"` // VideoToLive 短视频引流 VideoToLive int64 `json:"video_to_live,omitempty"` // HomepageHot 推荐feed HomepageHot int64 `json:"homepage_hot,omitempty"` // LiveMerge 直播广场 LiveMerge int64 `json:"live_merge,omitempty"` // HomepageFresh 同城 HomepageFresh int64 `json:"homepage_fresh,omitempty"` // OhterRecommendLive 其他推荐场景 OtherRecommendLive int64 `json:"other_recommend_live,omitempty"` // HomepageFollow 关注 HomepageFollow int64 `json:"homepage_follow,omitempty"` // GeneralSearch 搜索 GeneralSearch int64 `json:"general_search,omitempty"` // OthersHomepage 个人主页 OthersHomepage int64 `json:"others_homepage"` // DouyinShoppingCenter 抖音商城 DouyinShoppingCenter int64 `json:"douyin_shopping_center,omitempty"` // Activity 活动页 Activity int64 `json:"activity,omitempty"` // TouxiSaas 头条西瓜 TouxiSaas int64 `json:"touxi_saas,omitempty"` // AllSource 全部来源 AllSource int64 `json:"all_source,omitempty"` // AllAdSource 全部广告流量 AllAdSource int64 `json:"all_ad_source,omitempty"` // AllBrand 全部品牌广 AllBrand int64 `json:"all_brand,omitempty"` // AllOtherBidding 全部其他竞价广告 AllOtherBidding int64 `json:"all_other_bidding,omitempty"` // AllBidding 全部竞价广告 AllBidding int64 `json:"all_bidding,omitempty"` // Other 有可能是广告作弊流量 Other int64 `json:"other,omitempty"` // AllEcomFlowSource 广告大屏-流量来源 AllEcomFlowSource int64 `json:"all_ecom_flow_source,omitempty"` // AllEcomGmvSource 广告大屏-成交来源 AllEcomGmvSource int64 `json:"all_ecom_gmv_source,omitempty"` // EcomAdSecond 付费流量 EcomAdSecond int64 `json:"ecom_ad_second,omitempty"` // EcomLiveSecond 直播自然推荐流量 EcomLiveSecond int64 `json:"ecom_live_second,omitempty"` // EcomOther 其他 EcomOther int64 `json:"ecom_other,omitempty"` // EcomAdThirdQcBrand 付费流量-千川品牌 EcomAdThirdQcBrand int64 `json:"ecom_ad_third_qc_brand,omitempty"` // EcomAdThirdQcBrandOtherBidding 付费流量-其他竞价广告 EcomAdThirdQcBrandOtherBidding int64 `json:"ecom_ad_third_qc_brand_other_bidding,omitempty"` // EcomAdThirdQcOtherBrand 付费流量-其他品牌广告 EcomAdThirdQcOtherBrand int64 `json:"ecom_ad_third_qc_other_brand,omitempty"` }
RoomFlowPerformance 直播间流量表现
type RoomFlowPerformanceGetRequest ¶
type RoomFlowPerformanceGetRequest struct { // AdvertiserID 广告主id AdvertiserID uint64 `json:"advertiser_id,omitempty"` // RoomID 直播间id RoomID uint64 `json:"room_id,omitempty"` // FlowSource 来源 FlowSource qianchuan.LiveFlowSource `json:"flow_source,omitempty"` }
RoomFlowPerformanceGetRequest 获取直播间流量表现 API Request
func (RoomFlowPerformanceGetRequest) Encode ¶
func (r RoomFlowPerformanceGetRequest) Encode() string
Encode implement GetRequest interface
type RoomFlowPerformanceGetResponse ¶
type RoomFlowPerformanceGetResponse struct { model.BaseResponse Data *RoomFlowPerformance `json:"data,omitempty"` }
RoomFlowPerformanceGetResponse 获取直播间流量表现 API Response
type RoomGetData ¶
type RoomGetRequest ¶
type RoomGetRequest struct { // AdvertiserID 广告主id AdvertiserID uint64 `json:"advertiser_id,omitempty"` // AwemeID 抖音号ID AwemeID uint64 `json:"aweme_id,omitempty"` // DateTime 开播日期,格式 2021-04-05 DateTime string `json:"date_time,omitempty"` // RoomStatus 直播间状态,可选值,默认全部 // 全部ALL // 直播中LIVING // 直播结束FINISH RoomStatus qianchuan.RoomStatus `json:"room_status,omitempty"` // AdStatus 投放状态,可选值,默认不限 // 不限ALL // 广告在投DELIVERY_OK // 暂无投放NO_DELIVERY AdStatus string `json:"ad_status,omitempty"` // Fields 要查询的消耗指标,具体可参考返回值 Fields []string `json:"fields,omitempty"` // Page 页码,默认为1 Page int `json:"page,omitempty"` // PageSize 页面大小,默认为20,取值范围:1-100 PageSize int `json:"page_size,omitempty"` }
RoomGetRequest 获取今日直播间列表 API Request
func (RoomGetRequest) Encode ¶
func (r RoomGetRequest) Encode() string
Encode implement GetRequest interface
type RoomGetResponse ¶
type RoomGetResponse struct { model.BaseResponse Data *RoomGetData `json:"data,omitempty"` }
RoomGetResponse 获取今日直播间列表 API Response
type RoomProductListData ¶
type RoomProductListData struct { // List 商品列表 List []ProductStat `json:"list,omitempty"` // PageInfo 分页信息 PageInfo *model.PageInfo `json:"page_info,omitempty"` }
type RoomProductListGetRequest ¶
type RoomProductListGetRequest struct { // AdvertiserID 广告主id AdvertiserID uint64 `json:"advertiser_id,omitempty"` // RoomID 直播间id RoomID uint64 `json:"room_id,omitempty"` // Fields 需要查询的消耗指标,具体可参考返回字段 Fields []string `json:"fields,omitempty"` // ExplainStatus 商品状态,默认全部,可选值: // ALL: 全部 // HASEXPLAIN: 已讲解 // UNEXPLAIN: 未讲解 ExplainStatus qianchuan.ExplainStatus `json:"explain_status,omitempty"` // Page 页码,默认1 Page int `json:"page,omitempty"` // PageSize 页面大小,默认20,不超过100 PageSize int `json:"page_size,omitempty"` }
RoomProductListGetRequest 获取直播间商品列表 API Request
func (RoomProductListGetRequest) Encode ¶
func (r RoomProductListGetRequest) Encode() string
Encode implement GetRequest interface
type RoomProductListGetResponse ¶
type RoomProductListGetResponse struct { model.BaseResponse Data *RoomProductListData `json:"data,omitempty"` }
RoomProductListGetResponse 获取直播间商品列表 API Response
type RoomUser ¶
type RoomUser struct { // City 地域 City *City `json:"city,omitempty"` // Gender 性别 Gender *Gender `json:"gender,omitempty"` // Age 年龄 Age *Age `json:"age,omitempty"` }
RoomUser 直播间用户洞察
type RoomUserGetRequest ¶
type RoomUserGetRequest struct { // AdvertiserID 广告主id AdvertiserID uint64 `json:"advertiser_id,omitempty"` // RoomID 直播间id RoomID uint64 `json:"room_id,omitempty"` // ActionEvent 用户来源, // 进入直播间:ENTER // 支付成功:PAY ActionEvent qianchuan.UserActionEvent `json:"action_event,omitempty"` // Dimensions 洞察维度,可选择 "CITY", "GENDER", "AGE" Dimensions []string `json:"dimensions,omitempty"` // FlowSource 广告类型,默认全部广告 // 全部广告:ALL // 全部千川PC端广告:PC FlowSource string `json:"flow_source,omitempty"` }
RoomUserGetRequest 获取直播间用户洞察 API Request
func (RoomUserGetRequest) Encode ¶
func (r RoomUserGetRequest) Encode() string
Encode implement GetRequest interface
type RoomUserGetResponse ¶
type RoomUserGetResponse struct { model.BaseResponse Data *RoomUser `json:"data,omitempty"` }
RoomUserGetResponse 获取直播间用户洞察 API Response