Documentation
¶
Overview ¶
Package hotmaterialderive 爆款裂变
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AdoptRequest ¶
type AdoptRequest struct {
// AdvertiserID 广告主账户 ID
AdvertiserID uint64 `json:"advertiser_id,omitempty"`
// VideoIDs 采纳的视频 ID,有效期为 7 天(从 task 完成开始计算)单次最多 50 个
VideoIDs []string `json:"video_ids,omitempty"`
}
AdoptRequest 采纳爆款裂变视频 API Request
func (AdoptRequest) Encode ¶
func (r AdoptRequest) Encode() []byte
Encode implements PostRequest interface
type AdoptResponse ¶
type AdoptResponse struct {
model.BaseResponse
Data struct {
Results []AdoptResult `json:"results,omitempty"`
} `json:"data,omitempty"`
}
AdoptResponse 采纳爆款裂变视频 API Response
type AdoptResult ¶
type AdoptResult struct {
// VideoID 视频 ID
VideoID string `json:"video_id,omitempty"`
// StatusCode 采纳状态码,详见 应答 status_code 与 status_message
StatusCode int `json:"status_code,omitempty"`
// StatusMessage 采纳状态信息,详见 应答 status_code 与 status_message
StatusMessage string `json:"status_message,omitempty"`
// MaterialInfo 素材详细信息,只有 status_code=0 时候返回
MaterialInfo *MaterialInfo `json:"material_info,omitempty"`
}
type ApplyTime ¶
type ApplyTime struct {
// StartTime 策略生效开始时间戳(毫秒级别),以下生效策略不返回
// DERIVE_FROM_CHOSEN_HOT_MID - 自有爆款套路
// DERIVE_FROM_INDUSTRY_HOT_PATTERN - 行业爆款套路
StartTime int64 `json:"start_time,omitempty"`
// EndTime 策略生效结束时间戳(毫秒级别),以下生效策略不返回
// DERIVE_FROM_CHOSEN_HOT_MID - 自有爆款套路
// DERIVE_FROM_INDUSTRY_HOT_PATTERN - 行业爆款套路
EndTime int64 `json:"end_time,omitempty"`
}
ApplyTime 策略生效的视频时间戳
type DeriveMaterial ¶
type DeriveMaterial struct {
// VideoID 视频 ID
VideoID string `json:"video_id,omitempty"`
// VideoURL 预览链接,存在有效期 7 天
VideoURL string `json:"video_url,omitempty"`
// Title 视频标题
Title string `json:"title,omitempty"`
// StrategyDetail 策略详情
StrategyDetail *StrategyDetail `json:"strategy_detail,omitempty"`
}
DeriveMaterial 爆款素材信息
type GetRequest ¶
type GetRequest struct {
// AdvertiserID 广告主账户 ID
AdvertiserID uint64 `json:"advertiser_id,omitempty"`
// TaskIDs 任务 ID,数量限制 1 - 50 个
TaskIDs []uint64 `json:"task_ids,omitempty"`
}
GetRequest 查询爆款裂变任务详情 API Request
func (GetRequest) Encode ¶
func (r GetRequest) Encode() string
Encode implements GetRequest interface
type GetResponse ¶
type GetResponse struct {
model.BaseResponse
Data struct {
// TaskDetails 任务列表
TaskDetails []Task `json:"task_details,omitempty"`
} `json:"data,omitempty"`
}
GetResponse 查询爆款裂变任务详情 API Response
type ListFilter ¶
type ListFilter struct {
// OriginMaterialIDs 爆款素材 ID 过滤,最多支持 50 个
OriginMaterialIDs []uint64 `json:"origin_material_ids,omitempty"`
// TaskIDs 爆款裂变任务 ID 过滤,最多支持 50 个
TaskIDs []uint64 `json:"task_ids,omitempty"`
// Status 可选值:
// FAILED 任务失败
// INIT 任务初始化
// PART_SUCCESS 任务部分成功
// PPOCESSING 任务处理中
// SUCCESS 任务成功
Statuses []string `json:"statuses,omitempty"`
// StartTime 创建开始时间筛选,格式 YYYY-MM-DD HH:MM:SS
StartTime string `json:"start_time,omitempty"`
// EndTime 创建结束时间筛选,格式 YYYY-MM-DD HH:MM:SS
EndTime string `json:"end_time,omitempty"`
}
type ListRequest ¶
type ListRequest struct {
// AdvertiserID 广告主账户 ID
AdvertiserID uint64 `json:"advertiser_id,omitempty"`
// Filtering 过滤项目
Filtering *ListFilter `json:"filtering,omitempty"`
// Page 页码
Page int `json:"page,omitempty"`
// PageSize 单页数
PageSize int `json:"page_size,omitempty"`
}
ListRequest 获取账户下爆款裂变任务列表 API Request
func (ListRequest) Encode ¶
func (r ListRequest) Encode() string
Encode implements GetRequest interface
type ListResponse ¶
type ListResponse struct {
model.BaseResponse
Data *ListResult `json:"data,omitempty"`
}
ListResponse 获取账户下爆款裂变任务列表 API Response
type ListResult ¶
type MaterialInfo ¶
type MaterialInfo struct {
// VideoID 视频 ID,采纳有效期为 7 天
VideoID string `json:"video_id,omitempty"`
// VideoURL 预览链接,有效期为 7 天
VideoURL string `json:"video_url,omitempty"`
// Filename 文件名
Filename string `json:"filename,omitempty"`
// CoverURI 封面 URI
CoverURI string `json:"cover_uri,omitempty"`
// CoverURL 封面链接,有效期为 7 天
CoverURL string `json:"cover_url,omitempty"`
// Duration 视频时长
Duration float64 `json:"duration,omitempty"`
// MaterialID 素材 ID
MaterialID uint64 `json:"material_id,omitempty"`
// ImageMode 视频类型
ImageMode int `json:"image_mode,omitempty"`
}
MaterialInfo 素材详细信息
type StrategyDetail ¶
type StrategyDetail struct {
// Strategy 策略 可选值:
// CLIP_REPLACE
// DERIVE_FROM_CHOSEN_HOT_MID
// DERIVE_FROM_INDUSTRY_HOT_PATTERN
// HOT_PRE_VIDEO
// MIX_CUT
// PRE_VIDEO_CLIP_REPLACE
// ROBOT_REPLACE
Strategy string `json:"strategy,omitempty"`
// StrategyName 策略名称
StrategyName string `json:"strategy_name,omitempty"`
// StrategyDescription 策略描述
StrategyDescription string `json:"strategy_description,omitempty"`
// ApplyTimes 策略生效的视频时间戳
ApplyTimes []ApplyTime `json:"apply_times,omitempty"`
}
StrategyDetail 策略详情
type SubmitRequest ¶
type SubmitRequest struct {
// AdvertiserID 广告主账户ID
AdvertiserID uint64 `json:"advertiser_id,omitempty"`
// MaterialIDs 爆款素材 ID,规则:需要有投放记录,不能是低质、低效素材等
// 长度限制 1-50
// 全量生效策略参数配置
MaterialIDs []uint64 `json:"material_ids,omitempty"`
// Strategies 生效策略,默认为空全生效;支持项:
// CLIP_REPLACE - 分镜替换
// ROBOT_REPLACE - 人物替换
// HOT_PRE_VIDEO - 爆款开头
// MIX_CUT - 重新混剪
// PRE_VIDEO_CLIP_REPLACE - 前贴扩写
// DERIVE_FROM_CHOSEN_HOT_MID - 自有爆款套路 (目前仅千川账户支持)
// DERIVE_FROM_INDUSTRY_HOT_PATTERN - 行业爆款套路(目前仅千川账户支持)
Strategies []string `json:"strategies,omitempty"`
// ExcludeStrategies 禁止策略,范围同生效策略,优先级高于生效策略(两者都有时不生效)
ExcludeStrategies []string `json:"exclude_strategies,omitempty"`
}
SubmitRequest 提交爆款裂变任务 API Request
func (SubmitRequest) Encode ¶
func (r SubmitRequest) Encode() []byte
Encode implements PostRequest interface
type SubmitResponse ¶
type SubmitResponse struct {
model.BaseResponse
Data struct {
Tasks []Task `json:"tasks,omitempty"`
} `json:"data,omitempty"`
}
SubmitResponse 提交爆款裂变任务 API Response
type Task ¶
type Task struct {
// TaskID 任务 ID
TaskID uint64 `json:"task_id,omitempty"`
// MaterialID 原爆款素材 ID
MaterialID uint64 `json:"material_id,omitempty"`
// OriginMaterialID 原爆款素材 ID
OriginMaterialID uint64 `json:"origin_material_id,omitempty"`
// DeriveMaterials 爆款素材信息
DeriveMaterials []DeriveMaterial `json:"derive_materials,omitempty"`
// CreateTime 任务创建时间
CreateTime string `json:"create_time,omitempty"`
// ModifyTime 任务更新时间
ModifyTime string `json:"modify_time,omitempty"`
// Status 任务状态,枚举值
// RENDERING 执行中
// RENDER_SUCCESS 执行成功
// RENDER_FAILED 执行失败
Status string `json:"status,omitempty"`
// StatusCode 任务返回码,详见 【应答 status_code 和 message】
StatusCode int `json:"status_code,omitempty"`
// StatusMessage 任务返回信息,详见 【应答 status_code 和 message】
StatusMessage string `json:"status_message,omitempty"`
}
Task 任务
Click to show internal directories.
Click to hide internal directories.