file

Documentation

Overview

Package file 本地推素材管理相关

Index

• type AnchorInfo
• type UploadTask
  • func (t UploadTask) Error() string
  • func (t UploadTask) IsError() bool
• type UploadTaskCreateRequest
  • func (r UploadTaskCreateRequest) Encode() []byte
• type UploadTaskCreateResponse
• type Video
• type VideoAweme
• type VideoAwemeGetFilter
• type VideoAwemeGetRequest
  • func (r VideoAwemeGetRequest) Encode() string
• type VideoAwemeGetResponse
• type VideoAwemeGetResult
• type VideoGetFilter
• type VideoGetRequest
  • func (r VideoGetRequest) Encode() string
• type VideoGetResponse
• type VideoGetResult
• type VideoUploadRequest
  • func (r VideoUploadRequest) Encode() []model.UploadField
• type VideoUploadResponse
• type VideoUploadTaskListRequest
  • func (r VideoUploadTaskListRequest) Encode() string
• type VideoUploadTaskListResponse

Types

type AnchorInfo

type AnchorInfo struct {
	// AnchorType 根据视频所挂载的锚点类型筛选（注意：请按照项目设置和下方说明传入对应的锚点类型枚举），允许值：
	// ALL_ANCHOR 不限制锚点
	// POI_ANCHOR 门店锚点
	// PRODUCT_ANCHOR 商品锚点
	// 本地推创编选择抖音主页视频范围说明：
	// 营销场景=短视频/图文，且推广目的=团购成交/门店引流/内容加热时：
	// 推广门店时，支持选择POI_ANCHOR门店锚点和PRODUCT_ANCHOR商品锚点的抖音主页视频；需同时传入anchor_types和poi_ids/product_ids，其中，门店锚点需为项目所推广的门店，商品锚点需为所推广门店下挂载的商品，门店下挂载的商品id可通过【根据门店ID查询门店下商品ID】接口获取。
	// 推广商品时，支持选择PRODUCT_ANCHOR商品锚点的抖音主页视频；需同时传入anchor_types和product_ids，其中商品锚点需为项目所推广的商品。
	// 营销场景=直播时，支持选择抖音主页下全部视频，即ALL_ANCHOR不限制锚点
	AnchorType []string `json:"anchor_type,omitempty"`
	// PoiIDs 推广的门店ids，anchor_types=POI_ANCHOR时必传
	PoiIDs []uint64 `json:"poi_ids,omitempty"`
	// ProductIDs 推广的商品ids，anchor_types=PRODUCT_ANCHOR时必传
	ProductIDs []uint64 `json:"product_ids,omitempty"`
}

AnchorInfo 视频挂载的锚点信息

type UploadTask

type UploadTask struct {
	// Status 任务处理状态 可选值:
	// PROCESS 处理中
	// SUCCESS 成功
	// FAILED 失败
	Status local.UploadTaskStatus `json:"status,omitempty"`
	// ErrorMsg 当任务失败后，会返回失败信息
	ErrorMsg string `json:"error_msg,omitempty"`
	// CreateTime 任务创建时间
	CreateTime string `json:"create_time,omitempty"`
	// TaskID 任务id
	TaskID uint64 `json:"task_id,omitempty"`
	// VideoInfo 视频信息
	VideoInfo *Video `json:"video_info,omitempty"`
}

UploadTask 上传任务

func (UploadTask) Error

func (t UploadTask) Error() string

func (UploadTask) IsError

func (t UploadTask) IsError() bool

type UploadTaskCreateRequest

type UploadTaskCreateRequest struct {
	// LocalAccountID 本地推账户id
	LocalAccountID uint64 `json:"local_account_id,omitempty"`
	// Filename 素材的文件名
	Filename string `json:"filename,omitempty"`
	// VideoURL 视频 url地址，最大支持上传文件大小：1000M
	// 仅支持开发者购置连山云素材服务上传生成的tos链接上传，不支持其他三方链接地址，具体见接入指南
	VideoURL string `json:"video_url,omitempty"`
}

UploadTaskCreateRequest 异步上传本地推视频 API Request

func (UploadTaskCreateRequest) Encode

func (r UploadTaskCreateRequest) Encode() []byte

Encode implements PostRequest interface

type UploadTaskCreateResponse

type UploadTaskCreateResponse struct {
	model.BaseResponse
	Data struct {
		// TaskID 本地推任务id
		TaskID uint64 `json:"task_id,omitempty"`
	} `json:"data,omitempty"`
}

UploadTaskCreateResponse 异步上传本地推视频 API Response

type Video

type Video struct {
	// VideoID 视频id
	VideoID string `json:"video_id,omitempty"`
	// MaterialID 素材id
	MaterialID uint64 `json:"material_id,omitempty"`
	// Size 视频大小
	Size int64 `json:"size,omitempty"`
	// VideoSiganture 视频md5
	VideoSiganture string `json:"video_siganture,omitempty"`
	// Width 视频宽
	Width int64 `json:"width,omitempty"`
	// Height 视频高
	Height int64 `json:"height,omitempty"`
	// VideoURL 视频地址
	VideoURL string `json:"video_url,omitempty"`
	// Duration 视频时长
	Duration float64 `json:"duration,omitempty"`
	// VideoName 视频名称
	VideoName string `json:"video_name,omitempty"`
	// PosterURL 视频首帧截图
	PosterURL string `json:"poster_url,omitempty"`
	// MaterialProperties 素材标签，枚举值：
	// COPY 搬运风险
	// FIRST_PUBLISH 首发
	// HIGH_QUALITY 优质
	// LOW_QUALITY 低质
	// SIMILAR 同质化风险
	MaterialProperties []string `json:"material_properties,omitempty"`
	// ImageMode 视频类型，枚举值：
	// IMAGE_MODE_VIDEO 横版视频
	// IMAGE_MODE_VIDEO_VERTICAL 竖版视频
	ImageMode local.ImageMode `json:"image_mode,omitempty"`
	// Source  视频来源，枚举值：
	// BP_PLATFORM 巨量引擎工作平台共享视频
	// CREATIVE_AIGC 即创
	// LOCAL_ADS_UPLOAD 本地上传
	// STAR 星图平台
	// MAPI MAPI接口上传
	Source local.MaterialSource `json:"source,omitempty"`
	// CreateTime 素材的上传时间，格式：yyyy-mm-dd HH:mm:ss
	CreateTime string `json:"create_time,omitempty"`
}

Video 视频信息

type VideoAweme

type VideoAweme struct {
	// ItemID 抖音视频ID
	ItemID uint64 `json:"item_id,omitempty"`
	// Title 视频标题
	Title string `json:"title,omitempty"`
	// VideoID 视频ID
	VideoID string `json:"video_id,omitempty"`
	// AwemeID 抖音号ID
	AwemeID string `json:"aweme_id,omitempty"`
	// ImageMode 视频类型，枚举值：
	// IMAGE_MODE_VIDEO 横版视频
	// IMAGE_MODE_VIDEO_VERTICAL 竖版视频
	ImageMode local.ImageMode `json:"image_mode,omitempty"`
	// CoverImageURL 视频封面图片地址
	CoverImageURL string `json:"cover_image_url,omitempty"`
	// AwemeVideoURL 视频播放地址
	AwemeVideoURL string `json:"aweme_video_url,omitempty"`
	// NotDeliveryReason 不可投放原因
	NotDeliveryReason string `json:"not_delivery_reason,omitempty"`
	// CanDelivery 视频是否可投放
	// true 可投放
	// false 不可投放
	CanDelivery bool `json:"can_delivery,omitempty"`
	// LegoMaterialID 素材id
	LegoMaterialID uint64 `json:"lego_material_id,omitempty"`
	// VideoWidth 视频宽度
	VideoWidth int64 `json:"video_width,omitempty"`
	// VideoHeight 视频高度
	VideoHeight int64 `json:"video_height,omitempty"`
	// Duration 视频时长
	Duration string `json:"duration,omitempty"`
}

VideoAweme 抖音视频

type VideoAwemeGetFilter

type VideoAwemeGetFilter struct {
	// AnchorInfo 视频挂载的锚点信息
	AnchorInfo *AnchorInfo `json:"anchor_info,omitempty"`
	// AwemeIDs 抖音号ids筛选，当anchor_types=ALL_ANCHOR时必传
	AwemeIDs []string `json:"aweme_ids,omitempty"`
	// ItemIDs 主页视频ids筛选，一次最大长度限制10
	ItemIDs []uint64 `json:"item_ids,omitempty"`
	// ItemStatus 素材状态筛选，默认可用 可选值:
	// ALL 全部状态(可用&不可用)
	// VALID 可用状态
	// 默认值：VALID
	ItemStatus string `json:"item_status,omitempty"`
	// StartTime 根据视频发布时间进行过滤的起始时间，与end_time搭配使用，格式：yyyy-MM-dd HH:mm:ss
	StartTime string `json:"start_time,omitempty"`
	// EndTime 根据视频发布时间进行过滤的结束时间，与start_time搭配使用，格式：yyyy-MM-dd HH:mm:ss
	EndTime string `json:"end_time,omitempty"`
}

type VideoAwemeGetRequest

type VideoAwemeGetRequest struct {
	// LocalAccountID 本地推账户id
	LocalAccountID uint64 `json:"local_account_id,omitempty"`
	// Filtering 过滤字段
	Filtering *VideoAwemeGetFilter `json:"filtering,omitempty"`
	// OrderField 排序字段，允许值：
	// ARRIVE_SHOP 到店量排序
	// ESTIMATE 预估效果排序
	// LIKE_CNT 点赞量排序
	// PAY_ORDER_CNT 成交量排序
	// PUBLISH_TIME 发布时间排序
	OrderField string `json:"order_field,omitempty"`
	// ExternalAction 转化目标，允许值：
	// OTO_PAY 团购购买（默认值）
	// POI_RECOMMEND 门店引流
	// 仅order_filed= ESTIMATE 预估效果排序时有效
	ExternalAction local.ExternalAction `json:"external_action,omitempty"`
	// Count 页面数据量，默认10，最大值100，最小值1
	Count int `json:"count,omitempty"`
	// Cursor 页码游标值，第一次传0，之后每次传上一次请求返回的游标值
	Cursor string `json:"cursor,omitempty"`
}

VideoAwemeGetRequest 获取抖音主页视频 API Request

func (VideoAwemeGetRequest) Encode

func (r VideoAwemeGetRequest) Encode() string

type VideoAwemeGetResponse

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

VideoAwemeGetResponse 获取抖音主页视频 API Response

type VideoAwemeGetResult

type VideoAwemeGetResult struct {
	// PageInfo 分页信息
	PageInfo *model.CursorInfo `json:"page_info,omitempty"`
	// VideoList 视频列表
	VideoList []VideoAweme `json:"video_list,omitempty"`
}

type VideoGetFilter

type VideoGetFilter struct {
	// SearchKeyWord 根据视频名称或ID筛选
	SearchKeyWord string `json:"search_key_word,omitempty"`
	// ImageMode 素材类型 允许值：
	// IMAGE_MODE_VIDEO 横版视频
	// IMAGE_MODE_VIDEO_VERTICAL 竖版视频
	ImageMode local.ImageMode `json:"image_mode,omitempty"`
	// MaterialSource 素材来源 允许值：
	// BP_PLATFORM 巨量引擎工作平台共享视频
	// CREATIVE_AIGC 即创
	// LOCAL_ADS_UPLOAD 本地上传
	// STAR 星图平台
	// MAPI MAPI上传
	MaterialSource local.MaterialSource `json:"material_source,omitempty"`
	// AnalysisType 评估类型 允许值：
	// FIRST_PUBLISH 首发
	// FIRST_PUBLISH_AND_HIGH_QUALITY 首发&优质
	// HIGH_QUALITY 优质
	AnalysisType local.MaterialAnalysisType `json:"analysis_type,omitempty"`
	// StartTime 根据视频上传时间进行过滤的起始时间，与end_time搭配使用，格式：yyyy-MM-dd HH:mm:ss
	StartTime string `json:"start_time,omitempty"`
	// EndTime 根据视频上传时间进行过滤的截止时间，与start_time搭配使用，格式：yyyy-MM-dd HH:mm:ss
	EndTime string `json:"end_time,omitempty"`
	// IsFilterUnqualified 是否过滤低质素材，允许值：
	// false 不过滤
	// true 过滤（默认值）
	IsFilterUnqualified *bool `json:"is_filter_unqualified,omitempty"`
	// OrderField 排序字段，允许值：
	// CONVERSION_COST 转化成本
	// CONVERSION_RATE 转化率
	// CREATE_TIME 创建时间（默认值）
	// CTR 点击率
	// DURATION 视频时长
	// STAT_COST 消耗
	OrderField string `json:"order_field,omitempty"`
	// OrderType 排序顺序，允许值：
	// ASC 升序
	// DESC 降序（默认值）
	OrderType enum.OrderType `json:"order_type,omitempty"`
}

type VideoGetRequest

type VideoGetRequest struct {
	// LocalAccountID 本地推账户id
	LocalAccountID uint64 `json:"local_account_id,omitempty"`
	// Filtering 过滤器
	Filtering *VideoGetFilter `json:"filtering,omitempty"`
	// Page 页码
	Page int `json:"page,omitempty"`
	// PageSize 每页大小,默认值：20，最大值：100
	PageSize int `json:"page_size,omitempty"`
}

VideoGetRequest 获取素材库视频 API Request

func (VideoGetRequest) Encode

func (r VideoGetRequest) Encode() string

Encode implements GetRequest interface

type VideoGetResponse

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

VideoGetResponse 获取素材库视频 API Response

type VideoGetResult

type VideoGetResult struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// VideoList 素材库视频列表
	VideoList []Video `json:"video_list,omitempty"`
}

type VideoUploadRequest

type VideoUploadRequest struct {
	// LocalAccountID 本地推账户id
	LocalAccountID uint64 `json:"local_account_id,omitempty"`
	// VideoFile 文件
	VideoFile io.Reader `json:"video_file,omitempty"`
	// Filename 文件名
	Filename string `json:"filename,omitempty"`
	// VideoSignature 文件MD5
	VideoSignature string `json:"video_signature,omitempty"`
}

VideoUploadRequest 上传视频 API Request

func (VideoUploadRequest) Encode

func (r VideoUploadRequest) Encode() []model.UploadField

Encode implement UploadReqeust interface

type VideoUploadResponse

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

VideoUploadResponse 上传视频 API Response

type VideoUploadTaskListRequest

type VideoUploadTaskListRequest struct {
	// LocalAccountID 本地推账户id
	LocalAccountID uint64 `json:"local_account_id,omitempty"`
	// TaskIDs 任务id列表，单次最多支持100个任务id
	TaskIDs []uint64 `json:"task_ids,omitempty"`
}

VideoUploadTaskListRequest 查询异步上传本地推视频结果 API Request

func (VideoUploadTaskListRequest) Encode

func (r VideoUploadTaskListRequest) Encode() string

Encode implements GetRequest interface

type VideoUploadTaskListResponse

type VideoUploadTaskListResponse struct {
	model.BaseResponse
	Data struct {
		// List 任务列表
		List []UploadTask `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

VideoUploadTaskListResponse 查询异步上传本地推视频结果 API Response