duoplus

package

v1.30.0 Latest Latest Go to latest Published: Dec 5, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/bububa/oceanengine

Documentation ¶

Overview ¶

Package duoplus Dou+ 投放能力

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Ad ¶

type Ad struct {
	// AdID 计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// AdStatus 状态 可选值：
	// UNPAID未支付
	// AUDITING 审核中
	// OFFLINE_AUDIT审核不通过
	// TIME_NO_REACH 待开播
	// DELIVERING 投放中
	// UNDELIVERIED 投放终止
	// DELIVERIED 投放完成/结束
	// AUDIT_PAUSE 审核暂停
	// WAIT_TO_START 等待开始
	AdStatus enum.DuoplusOrderStatus `json:"ad_status,omitempty"`
	// IsFans 是否粉丝必见计划
	IsFans bool `json:"is_fans,omitempty"`
	// Budget 投放金额，单位：分
	Budget int64 `json:"budget,omitempty"`
	// ExternalAction 优化目标
	ExternalAction enum.TrackEventType `json:"external_action,omitempty"`
	// DeliveryTime 期望投放时长（小时）
	DeliveryTime float64 `json:"delivery_time,omitempty"`
	// BidMode 可选值:
	// 保播放
	// 保转化
	// 自动出价
	BidMode string `json:"bid_mode,omitempty"`
	// CpaBid cpa出价，单位：元
	CpaBId float64 `json:"cpa_bid,omitempty"`
	// Audience 定向信息
	Audience *Audience `json:"audience,omitempty"`
}

Ad 计划

type Audience ¶

type Audience struct {
	// Gender 性别定向
	Gender enum.AudienceGender `json:"gender,omitempty"`
	// Age 年龄定向
	Age []enum.AudienceAge `json:"age,omitempty"`
	// District 可选值:
	// 区县
	// 商圈
	// 省市
	District string `json:"district,omitempty"`
	// City 定向城市信息
	City []string `json:"city,omitempty"`
	// Province 定向省份信息
	Province []string `json:"province,omitempty"`
	// InterestCategories 兴趣类目词
	InterestCategories []string `json:"interest_categories,omitempty"`
	// AuthorPkgs 抖音达人ID列表
	AuthorPkgs []string `json:"author_pkgs,omitempty"`
	// DeliveryType 定向模式
	// 智能定向
	// 自定义定向
	DeliveryType string `json:"delivery_type,omitempty"`
	// Business 定向商圈
	Business []string `json:"business,omitempty"`
}

Audience 定向信息

type AwemeItem ¶

type AwemeItem struct {
	// AwemeAuthorName 抖音号昵称
	AwemeAuthorName string `json:"aweme_author_name,omitempty"`
	// AwemeAuthorUniqueID 抖音号
	AwemeAuthorUniqueID string `json:"aweme_author_unique_id,omitempty"`
	// AwemeAuthorAvatar 抖音号头像
	AwemeAuthorAvatar []string `json:"aweme_author_avatar,omitempty"`
	// AwemeItemID 视频id
	AwemeItemID model.Uint64 `json:"aweme_item_id,omitempty"`
	// AwemeItemTitle 视频标题
	AwemeItemTitle string `json:"aweme_item_title,omitempty"`
	// AwemeItemCover 视频封面
	AwemeItemCover []string `json:"aweme_item_cover,omitempty"`
}

AwemeItem 视频信息

type LiveRoomInfo ¶

type LiveRoomInfo struct {
	// RoomID 直播间id
	RoomID uint64 `json:"room_id,omitempty"`
	// RoomTitle 直播间标题
	RoomTitle string `json:"room_title,omitempty"`
	// RoomCover 直播间封面
	RoomCover []string `json:"room_cover,omitempty"`
	// RoomStatus 直播间状态，可选值:
	// FINISH: 结束
	// LIVING: 直播中
	// PAUSE: 暂停
	// PREPARE: 未开播
	// UNKNOW: 未知
	RoomStatus enum.LiveRoomStatus `json:"room_status,omitempty"`
}

LiveRoomInfo 直播间信息

type Order ¶

type Order struct {
	// Order 订单信息
	Order *OrderInfo `json:"order,omitempty"`
	// AdList 计划列表
	AdList []Ad `json:"ad_list,omitempty"`
	// LiveRoomInfo 直播间信息
	LiveRoomInfo *LiveRoomInfo `json:"live_room_info,omitempty"`
	// ItemInfoList 视频信息
	ItemInfoList []AwemeItem `json:"item_info_list,omitempty"`
}

Order Duo+订单

type OrderDimension ¶

type OrderDimension struct {
	// OrderID 订单id
	OrderID uint64 `json:"order_id,omitempty"`
	// AdvertiserID 账户id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// IsFans 是否粉丝必见计划
	IsFans bool `json:"is_fans,omitempty"`
	// ItemID 视频id
	ItemID uint64 `json:"item_id,omitempty"`
	// RoomID 直播间id
	RoomID uint64 `json:"room_id,omitempty"`
}

OrderDimension 数据维度

type OrderInfo ¶

type OrderInfo struct {
	// OrderID 订单id
	OrderID uint64 `json:"order_id,omitempty"`
	// TaskID 订单id（页面上显示）
	TaskID uint64 `json:"task_id,omitempty"`
	// SceneType 营销目标
	SceneType enum.MarketingGoal `json:"scene_type,omitempty"`
	// OrderCreateTime 订单创建时间
	OrderCreateTime string `json:"order_create_time,omitempty"`
	// TaskStatus 任务状态 可选值：
	// UNPAID未支付
	// AUDITING 审核中
	// OFFLINE_AUDIT审核不通过
	// TIME_NO_REACH 待开播
	// DELIVERING 投放中
	// UNDELIVERIED 投放终止
	// DELIVERIED 投放完成/结束
	// AUDIT_PAUSE 审核暂停
	// WAIT_TO_START 等待开始
	TaskStatus enum.DuoplusOrderStatus `json:"task_status,omitempty"`
	// Budget 投放金额，单位：分
	Budget int64 `json:"budget,omitempty"`
	// LiveScene 可选值:
	// 混合投放
	// 直推直播间
	// 视频导流直播间
	LiveScene string `json:"live_scene,omitempty"`
}

OrderInfo 订单信息

type OrderListFilter ¶

type OrderListFilter struct {
	// SceneType 按营销目标过滤，允许值：:
	// LIVE ：直播
	// VIDEO ：短视频
	SceneType enum.MarketingGoal `json:"scene_type,omitempty"`
	// OrderID 订单id，按id过滤数据
	OrderID []uint64 `json:"order_id,omitempty"`
	// Status DOU+订单状态 可选值：
	// UNPAID未支付
	// AUDITING 审核中
	// OFFLINE_AUDIT审核不通过
	// TIME_NO_REACH 待开播
	// DELIVERING 投放中
	// UNDELIVERIED 投放终止
	// DELIVERIED 投放完成/结束
	// AUDIT_PAUSE 审核暂停
	// WAIT_TO_START 等待开始
	Status enum.DuoplusOrderStatus `json:"status,omitempty"`
}

OrderListFilter 筛选条件

type OrderListRequest ¶

type OrderListRequest struct {
	// AwemeSecUid 抖音号ID，通过已授权账户接口可以获取
	AwemeSecUid string `json:"aweme_sec_uid,omitempty"`
	// Filter 筛选条件
	Filter *OrderListFilter `json:"filter,omitempty"`
	// Page 页码，默认值：0
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，允许值：1- 100，默认值：10
	PageSize int `json:"page_size,omitempty"`
	// OrderByField 排序字段， 可选值:
	// CREATE_TIME 创建时间（默认值），不传参数默认按此排序
	// ORDER_ID 订单id
	OrderByField string `json:"order_by_field,omitempty"`
	// OrderByType 排序方式， 可选值:
	OrderByType enum.OrderType `json:"order_by_type,omitempty"`
}

OrderListRequest 查询订单列表 API Request

func (OrderListRequest) Encode ¶

func (r OrderListRequest) Encode() string

Encode implement GetRequest interface

type OrderListResponse ¶

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

OrderListResponse 查询订单列表 API Response

type OrderListResult ¶

type OrderListResult struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// OrderList 订单列表
	OrderList []Order `json:"order_list,omitempty"`
}

type OrderMetrics ¶

type OrderMetrics struct {
	// StatCost 消耗
	StatCost float64 `json:"stat_cost,omitempty"`
	// TotalPlay 播放次数
	TotalPlay int64 `json:"total_play,omitempty"`
	// DyFollow 新增粉丝数
	DyFollow int64 `json:"dy_follow,omitempty"`
	// DyShare 分享次数
	DyShare int64 `json:"dy_share,omitempty"`
	// DyComment 评论次数
	DyComment int64 `json:"dy_comment,omitempty"`
	// CustomLike 点赞次数
	CustomLike int64 `json:"custom_like,omitempty"`
	// DyHomeVisited 主页访问次数
	DyHomeVisited int64 `json:"dy_home_visited,omitempty"`
	// PlayDuration5sRank 5s完播率，短视频内容分析指标
	PlayDuration5sRank float64 `json:"play_duration_5s_rank,omitempty"`
	// DpTargetConvertCnt 转化数
	DpTargetConvertCnt int64 `json:"dp_target_convert_cnt,omitempty"`
	// CustomConvertCost 转化成本
	CustomConvertCost float64 `json:"custom_convert_cost,omitempty"`
	// ShowCnt 直播间展示数
	ShowCnt int64 `json:"show_cnt,omitempty"`
	// LiveClickSourceCnt 直播间新增观众数
	LiveClickSourceCnt int64 `json:"live_click_source_cnt,omitempty"`
	// LiveGiftUV 直播间打赏观众人数
	LiveGiftUV int64 `json:"live_gift_uv,omitempty"`
	// LiveGiftAmount 直播间音浪收入
	LiveGiftAmount float64 `json:"live_gift_amount,omitempty"`
	// LiveCommentCnt 直播间评论次数
	LiveCommentCnt int64 `json:"live_comment_cnt,omitempty"`
	// DuoplusLiveFollowCnt 直播间新增粉丝量
	DuoplusLiveFollowCnt int64 `json:"duoplus_live_follow_cnt,omitempty"`
	// LiveGiftCnt 直播间打赏次数
	LiveGiftCnt int64 `json:"live_gift_cnt,omitempty"`
}

OrderMetrics 指标值

type OrderReportFilter ¶

type OrderReportFilter struct {
	// ItemIDs 视频id
	ItemIDs []uint64 `json:"item_ids,omitempty"`
	// OrderIDs 订单id
	OrderIDs []uint64 `json:"order_ids,omitempty"`
	// RoomIDs 直播间id
	RoomIDs []uint64 `json:"room_ids,omitempty"`
	// AuthorUniqueIDs 达人id
	AuthorUniqueIDs []string `json:"author_unique_ids,omitempty"`
}

OrderReportFilter 数据过滤

type OrderReportRequest ¶

type OrderReportRequest struct {
	// AwemeSecUid 抖音号ID，通过已授权账户接口可以获取
	AwemeSecUid string `json:"aweme_sec_uid,omitempty"`
	// StatTime 时间范围
	StatTime *TimeRange `json:"stat_time,omitempty"`
	// GroupBy 分组方式？
	// GROUP_BY_AD_ID 按订单分组（默认值，若为按订单分组，则返回内容item_id,room_id不生效）
	// GROUP_BY_CREATIVE_ID 按素材（视频/直播间）分组
	// 目前支持传入方式包括：
	// [GROUP_BY_AD_ID]按订单拆分数据
	// [GROUP_BY_AD_ID,GROUP_BY_CREATIVE_ID] 按素材拆分数据 ，当传入该组合时，暂时将不支持分页，同时filter中的order_ids必传
	GroupBy []string `json:"group_by,omitempty"`
	// Filter 数据过滤
	Filter *OrderReportFilter `json:"filter,omitempty"`
	// Page 页码，默认值：0
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，允许值：1- 100，默认值：10
	PageSize int `json:"page_size,omitempty"`
}

OrderReportRequest 获取订单数据报表 API Request

func (OrderReportRequest) Encode ¶

func (r OrderReportRequest) Encode() string

Encode implement GetRequest interface

type OrderReportResponse ¶

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

OrderReportResponse 获取订单数据报表 API Response

type OrderReportResult ¶

type OrderReportResult struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// OrderMetrics 订单数据
	OrderMetrics []OrderStat `json:"order_metrics,omitempty"`
}

type OrderStat ¶

type OrderStat struct {
	// DimensionData 数据维度
	DimensionData *OrderDimension `json:"dimension_data,omitempty"`
	// MetricsData 指标值
	MetricsData *OrderMetrics `json:"metrics_data,omitempty"`
}

OrderStat 订单数据

type TimeRange ¶

type TimeRange struct {
	// BeginTime 开始时间，格式 2021-04-05
	BeginTime string `json:"begin_time,omitempty"`
	// EndTime 结束时间，格式 2021-04-05，时间跨度不能超过180天
	EndTime string `json:"end_time,omitempty"`
}

TimeRange 时间范围

Source Files ¶

View all Source files

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

Documentation ¶

Overview ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type Ad ¶

type Audience ¶

type AwemeItem ¶

type LiveRoomInfo ¶

type Order ¶

type OrderDimension ¶

type OrderInfo ¶

type OrderListFilter ¶

type OrderListRequest ¶

func (OrderListRequest) Encode ¶

type OrderListResponse ¶

type OrderListResult ¶

type OrderMetrics ¶

type OrderReportFilter ¶

type OrderReportRequest ¶

func (OrderReportRequest) Encode ¶

type OrderReportResponse ¶

type OrderReportResult ¶

type OrderStat ¶

type TimeRange ¶

Source Files ¶