file

package
v1.16.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 12, 2023 License: Apache-2.0 Imports: 5 Imported by: 2

Documentation

Overview

Package file 素材管理相关API models

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type FailedMaterialBind 

type FailedMaterialBind struct {
	// VideoID 推送失败的视频id
	VideoID string `json:"video_id,omitempty"`
	// ImageID 推送失败的图片id
	ImageID string `json:"image_id,omitempty"`
	// TargetAdvertiserID 目标推送广告主id
	TargetAdvertiserID uint64 `json:"target_advertiser_id,omitempty"`
	// FailReason 推送失败原因
	// 枚举值：VIDEO_BINDING_EXISTED（视频已存在）、IMAGE_BINDING_EXISTED（图片已存在）
	FailReason enum.MaterialBindFailReason `json:"fail_reason,omitempty"`
}

FailedMaterialBind 推送失败素材

type Image 

type Image struct {
	// ID 图片ID
	ID string `json:"id,omitempty"`
	// MaterialID 素材id，即多合一报表中的素材id，一个素材唯一对应一个素材id
	MaterialID uint64 `json:"material_id,omitempty"`
	// Size 图片大小
	Size uint64 `json:"size,omitempty"`
	// Width 图片宽度
	Width int `json:"width,omitempty"`
	// Height 图片高度
	Height int `json:"height,omitempty"`
	// URL 图片预览地址，仅限同主体进行素材预览查看，若非同主体会返回“素材所属主体与开发者主体不一致无法获取URL”
	// 链接仅做预览使用，预览链接有效期为1小时
	URL string `json:"url,omitempty"`
	// Format 图片格式
	Format string `json:"format,omitempty"`
	// Signature 图片md5
	Signature string `json:"signature,omitempty"`
	// CreateTime 素材的上传时间，格式："yyyy-mm-dd HH:MM:SS"
	CreateTime string `json:"create_time,omitempty"`
	// Filename 素材的文件名
	Filename string `json:"filename,omitempty"`
	// ImageMode 素材类型，允许值:
	// SQUARE 方图
	// LARGE 大图
	// SMALL 小图
	// LARGE_VERTICAL 大图竖图
	// UNION_SPLASH 穿山甲开屏图片
	// VIDEO_LARGE 横版视频
	// VIDEO_VERTICAL 竖版视频
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// Tag 素材标签
	Tag string `json:"tag,omitempty"`
}

Image 图片

type ImageAdGetRequest 

type ImageAdGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ImageIDs 图片ids，长度限制1~100
	ImageIDs []string `json:"image_ids,omitempty"`
}

ImageAdGetRequest 获取同主体下广告主图片素材 API Request

func (ImageAdGetRequest) Encode 

func (r ImageAdGetRequest) Encode() string

Encode implement GetRequest interface

type ImageAdRequest 

type ImageAdRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// UploadType 图片上传方式; 默认值：UPLOAD_BY_FILE; 允许值：UPLOAD_BY_FILE、UPLOAD_BY_URL
	UploadType enum.UploadType `json:"upload_type,omitempty"`
	// ImageSignature 图片的md5值(用于服务端校验)，upload_type为UPLOAD_BY_FILE必填
	ImageSignature string `json:"image_signature,omitempty"`
	// ImageFile 图片文件,upload_type为UPLOAD_BY_FILE必填; 格式: jpg、jpeg、png、bmp、gif, 大小1.5M内
	ImageFile *model.UploadField `json:"image_file,omitempty"`
	// ImageUrl 图片url地址，如http://xxx.xxx，upload_type为UPLOAD_BY_URL必填
	ImageUrl string `json:"image_url,omitempty"`
	// Filename 素材的文件名，可自定义素材名，不传则默认取文件名，最长255个字符; 注：若同一素材已进行上传，重新上传不会改名
	Filename string `json:"filename,omitempty"`
}

ImageAdRequest 上传广告图片 API Request

func (ImageAdRequest) Encode 

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

Encode implement UploadRequest interface

type ImageAdResponse 

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

ImageAdResponse 上传广告图片 API Response

type ImageAdvertiserRequest 

type ImageAdvertiserRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// UploadType 图片上传方式; 默认值：UPLOAD_BY_FILE; 允许值：UPLOAD_BY_FILE、UPLOAD_BY_URL
	UploadType enum.UploadType `json:"upload_type,omitempty"`
	// ImageSignature 图片的md5值(用于服务端校验)，upload_type为UPLOAD_BY_FILE必填
	ImageSignature string `json:"image_signature,omitempty"`
	// ImageFile 图片文件,upload_type为UPLOAD_BY_FILE必填; 格式: jpg、jpeg、png、bmp、gif, 大小1.5M内
	ImageFile *model.UploadField `json:"image_file,omitempty"`
	// ImageUrl 图片url地址，如http://xxx.xxx，upload_type为UPLOAD_BY_URL必填
	ImageUrl string `json:"image_url,omitempty"`
	// UploadTo 调用上传资质; 默认值：CG; 允许值：CG：广告主资质接口、AD：投放资质接口
	UploadTo string `json:"upload_to,omitempty"`
}

ImageAdvertiserRequest 上传广告主图片 API Request

func (ImageAdvertiserRequest) Encode 

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

Encode implement UploadRequest interface

type ImageAdvertiserResponse 

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

ImageAdvertiserResponse 上传广告主图片 API Response

type ImageGetFilter 

type ImageGetFilter struct {
	// ImageIDs 图片ids，可以根据图片ids（创意中使用的图片key，存在一张图片对应多个image_ids的情况）进行过滤
	// 数量限制：<=100
	// 注意：image_ids、material_ids、signatures只能选择一个进行过滤
	ImageIDs []string `json:"image_ids,omitempty"`
	// MaterialIDs 素材id列表，可以根据material_ids（素材报表使用的id，一个素材唯一对应一个素材id）进行过滤
	// 数量限制：<=100
	// 注意：image_ids、material_ids、signatures只能选择一个进行过滤
	MaterialIDs []uint64 `json:"material_ids,omitempty"`
	// Signatures md5值列表，可以根据素材的md5进行过滤
	// 数量限制：<=100
	// 注意：image_ids、material_ids、signatures只能选择一个进行过滤
	Signatures []string `json:"signatures,omitempty"`
	// Width 图片宽度
	Width int `json:"width,omitempty"`
	// Height 图片高度
	Height int `json:"height,omitempty"`
	// Ratio 图片宽高比，eg: [1.7, 2.5]，输入1.7则搜索满足宽高比介于1.65-1.75之间的图片，即精度上下浮动0.05
	Ratio []float64 `json:"ratio,omitempty"`
	// StartTime 根据视频上传时间进行过滤的起始时间，与end_time搭配使用，格式：yyyy-mm-dd
	StartTime string `json:"start_time,omitempty"`
	// EndTime 根据视频上传时间进行过滤的截止时间，与start_time搭配使用，格式：yyyy-mm-dd
	EndTime string `json:"end_time,omitempty"`
}

ImageGetFilter 图片过滤条件

type ImageGetRequest 

type ImageGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 图片过滤条件
	Filtering *ImageGetFilter `json:"filtering,omitempty"`
	// Page 页码，默认值1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，默认值20
	PageSize int `json:"page_size,omitempty"`
}

ImageGetRequest 获取图片素材 API Request

func (ImageGetRequest) Encode 

func (r ImageGetRequest) Encode() string

Encode implement GetRequest interface

type ImageGetResponse 

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

ImageGetResponse 获取图片素材 API Response

type ImageGetResponseData 

type ImageGetResponseData struct {
	// List 图片列表
	List []Image `json:"list,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

ImageGetResponseData json返回值

type Material added in v1.12.3 

type Material struct {
	// MaterialID 请求的素材 id
	MaterialID model.Uint64 `json:"material_id,omitempty"`
	// MaterialProperties 素材属性标签
	// INEFFICIENT_MATERIAL低效素材
	// SIMILAR_MATERIAL 同质化挤压严重素材
	// SIMILAR_QUEUE_MATERIAL 同质化素材风险-排队投放素材
	// AD_HIGH_QUALITY_MATERIAL AD 优质素材
	// ECP_HIGH_QUALITY_MATERIAL 千川优质素材
	// FIRST_PUBLISH_MATERIAL  首发素材
	MaterialProperties enum.MaterialProperty `json:"material_properties,omitempty"`
	// IsInefficientMaterial 是否低效素材
	IsInefficientMaterial bool `json:"is_inefficient_material,omitempty"`
	// IsSimilarQueueMaterial 是否同质化素材风险-排队投放素材
	IsSimilarQueueMaterial bool `json:"is_similar_queue_material,omitempty"`
	// IsSimilarExpectedQueueMaterial 是否同质化素材风险-未投放预计排队素材
	IsSimilarExpectedQueueMaterial bool `json:"is_similar_expected_queue_material,omitempty"`
	// IsSimilarMaterial 是否同质化挤压严重素材
	IsSimilarMaterial bool `json:"is_similar_material,omitempty"`
	// IsEcpHighQuality 是否千川优质素材
	IsEcpHighQuality bool `json:"is_ecp_high_quality,omitempty"`
	// IsAdHighQuality 是否AD优质素材
	IsAdHighQuality bool `json:"is_ad_high_quality,omitempty"`
	// IsFirstPublishMaterial 是否是首发素材
	IsFirstPublishMaterial bool `json:"is_first_publish_matertial,omitempty"`
}

Material 低效素材

type MaterialBindRequest 

type MaterialBindRequest struct {
	// AdvertiserID 素材归属广告主
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// TargetAdvertiserIDs 待推送的广告主，数量限制：<=50
	TargetAdvertiserIDs []uint64 `json:"target_advertiser_ids,omitempty"`
	// VideoIDs 视频ID，数量限制：<=50; 注意：跟image_ids必须二选一、组织共享视频不可推送
	VideoIDs []string `json:"video_ids,omitempty"`
	// ImageIDs 图片ID，数量限制：<=50; 注意：跟video_ids必须二选一
	ImageIDs []string `json:"image_ids,omitempty"`
}

MaterialBindRequest 素材推送 API Request

func (MaterialBindRequest) Encode 

func (r MaterialBindRequest) Encode() []byte

Encode implement PostRequest interface

type MaterialBindResponse 

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

MaterialBindResponse 素材推送 API Response

type MaterialBindResponseData 

type MaterialBindResponseData struct {
	// FailList 推送失败列表
	FailList []FailedMaterialBind `json:"fail_list,omitempty"`
}

MaterialBindResponseData json返回值

type MaterialDetailRequest added in v1.12.3 

type MaterialDetailRequest struct {
	// AdvertiserID 广告主 id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// MaterialIDs 素材 id 列表，最多50
	MaterialIDs []uint64 `json:"material_ids,omitempty"`
}

MaterialDetailRequest 查询素材标签信息 API Request

func (MaterialDetailRequest) Encode added in v1.12.3 

func (r MaterialDetailRequest) Encode() string

Encode implement GetRequest interface

type MaterialDetailResponse added in v1.12.3 

type MaterialDetailResponse struct {
	model.BaseResponse
	Data struct {
		// Materials 素材列表
		Materials []Material `json:"materials,omitempty"`
	} `json:"data,omitempty"`
}

MaterialDetailResponse 查询素材标签信息 API Response

type MaterialListData added in v1.12.3 

type MaterialListData struct {
	// Materials 低效素材id列表
	Materials []Material `json:"materials,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

type MaterialListRequest added in v1.12.3 

type MaterialListRequest struct {
	// AdvertiserID 广告主 id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// MaterialSource 素材来源，允许值：QIANCHUAN 千川
	// AD 广告平台
	MaterialSource enum.AccountType `json:"material_source,omitempty"`
	// PropertiesFilter 素材标签过滤项，允许值：
	// INEFFICIENT_MATERIAL低效素材；
	// SIMILAR_MATERIAL 同质化挤压严重素材；
	// SIMILAR_QUEUE_MATERIAL 同质化素材风险-排队投放素材
	// AD_HIGH_QUALITY_MATERIAL AD 优质素材
	// ECP_HIGH_QUALITY_MATERIAL 千川优质素材
	// FIRST_PUBLISH_MATERIAL  首发素材
	// 如果不传，则默认返回广告主ID下所有素材
	PropertiesFilter []enum.MaterialProperty `json:"properties_filter,omitempty"`
	// StartTime 素材创建时间，格式为yyyy-mm-dd HH:MM:SS，最早允许传入时间&默认时间：2022-01-01 00:00:00
	StartTime string `json:"start_time,omitempty"`
	// EndTime 素材结束时间，格式为yyyy-mm-dd HH:MM:SS，默认为当前时间
	EndTime string `json:"end_time,omitempty"`
	// Page 页数默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小默认值:10, 最大值：100
	PageSize int `json:"page_size,omitempty"`
}

MaterialListRequest 获取素材标签列表 API Request

func (MaterialListRequest) Encode added in v1.12.3 

func (r MaterialListRequest) Encode() string

Encode implement GetRequest interface

type MaterialListResponse added in v1.12.3 

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

MaterialListResponse 获取素材标签列表 API Response

type Video 

type Video struct {
	// ID 视频ID
	ID string `json:"id,omitempty"`
	// VideoID 视频ID
	VideoID string `json:"video_id,omitempty"`
	// VideoCoverURL 视频封面图片url
	VideoCoverURL string `json:"video_cover_url,omitempty"`
	// Size 视频大小
	Size uint64 `json:"size,omitempty"`
	// Width 视频宽度
	Width int `json:"width,omitempty"`
	// Height 视频高度
	Height int `json:"height,omitempty"`
	// URL 视频地址，仅限同主体进行素材预览查看，若非同主体会返回“素材所属主体与开发者主体不一致无法获取URL”
	// 链接仅做预览使用，预览链接有效期为1小时
	URL string `json:"url,omitempty"`
	// VideoURL 视频地址
	VideoURL string `json:"video_url,omitempty"`
	// Format 视频格式
	Format string `json:"format,omitempty"`
	// Signature 视频md5
	Signature string `json:"signature,omitempty"`
	// PosterURL 视频首帧截图，仅限同主体进行素材预览查看，若非同主体会返回“素材所属主体与开发者主体不一致无法获取URL”
	PosterURL string `json:"poster_url,omitempty"`
	// BitRate 码率，单位bps
	BitRate int64 `json:"bit_rate,omitempty"`
	// Duration 视频时长
	Duration float64 `json:"duration,omitempty"`
	// MaterialID 素材id，即多合一报表中的素材id，一个素材唯一对应一个素材id
	MaterialID uint64 `json:"material_id,omitempty"`
	// ImageMode 素材类型，枚举值:
	// LARGE 大图
	// SMALL 小图
	// LARGE_VERTICAL 大图竖图
	// UNION_SPLASH 穿山甲开屏图片
	// VIDEO_LARGE 横版视频
	// VIDEO_VERTICAL 竖版视频
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// Source 素材来源，详见【附录-素材来源】
	Source enum.MaterialSource `json:"source,omitempty"`
	// CreateTime 素材的上传时间，格式："yyyy-mm-dd HH:MM:SS"
	CreateTime string `json:"create_time,omitempty"`
	// Filename 素材的文件名
	Filename string `json:"filename,omitempty"`
	// Tags 素材标签
	Tags []string `json:"tags,omitempty"`
	// Labels 视频标签
	Labels []string `json:"labels,omitempty"`
	// AwemeItemID 抖音短视频 ID
	AwemeItemID uint64 `json:"aweme_item_id,omitempty"`
	// Title 抖音中的视频标题
	Title string `json:"title,omitempty"`
	// IsRecommend 是否推荐; 0 不推荐 1 推荐
	IsRecommend int `json:"is_recommend,omitempty"`
	// ViewCnt 观看数
	ViewCnt int64 `json:"view_cnt,omitempty"`
	// LikeCnt 点赞数
	LikeCnt int64 `json:"like_cnt,omitempty"`
	// ShareCnt 分享数
	ShareCnt int64 `json:"share_cnt,omitempty"`
	// CommentCnt 评论数
	CommentCnt int64 `json:"comment_cnt,omitempty"`
}

Video 视频

type VideoAdGetRequest 

type VideoAdGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// VideoIDs 视频ids，长度限制 1~60
	VideoIDs []string `json:"video_ids,omitempty"`
}

VideoAdGetRequest 获取同主体下广告主视频素材API Request

func (VideoAdGetRequest) Encode 

func (r VideoAdGetRequest) Encode() string

Encode implement GetRequest interface

type VideoAdRequest 

type VideoAdRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// VideoSignature 视频的md5值(用于服务端校验)
	VideoSignature string `json:"video_signature,omitempty"`
	// VideoFile 视频文件; 允许格式：mp4、mpeg、3gp、avi（10s超时限制）
	VideoFile *model.UploadField `json:"video_file,omitempty"`
	// Filename 素材的文件名，可自定义素材名，不传则默认取文件名，最长255个字符; 注：若同一素材已进行上传，重新上传不会改名
	Filename string `json:"filename,omitempty"`
}

VideoAdRequest 上传广告视频 API Request

func (VideoAdRequest) Encode 

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

Encode implement UploadRequest interface

type VideoAdResponse 

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

VideoAdResponse 上传广告视频 API Response

type VideoAweme added in v1.12.6 

type VideoAweme struct {
	AwemePlayUrl  string  `json:"aweme_play_url"`
	Duration      float64 `json:"duration"`
	ImageMode     string  `json:"image_mode"`
	ItemId        uint64  `json:"item_id"`
	Title         string  `json:"title"`
	VideoCoverId  string  `json:"video_cover_id"`
	VideoCoverUrl string  `json:"video_cover_url"`
	VideoId       string  `json:"video_id"`
}

type VideoAwemeGetFiltering added in v1.5.0 

type VideoAwemeGetFiltering struct {
	// AwemeURL 抖音视频链接，可在抖音端上通过【分享】-【复制链接】获取
	AwemeURL string `json:"aweme_url,omitempty"`
}

VideoAwemeGetFiltering 筛选条件

type VideoAwemeGetRequest added in v1.5.0 

type VideoAwemeGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AwemeID 需拉取视频的抖音号
	AwemeID string `json:"aweme_id,omitempty"`
	// Filtering 视频过滤条件
	Filtering *VideoAwemeGetFiltering `json:"filtering,omitempty"`
	// Page 页码，默认值：1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小， 默认值：10，取值范围1-100
	PageSize int `json:"page_size,omitempty"`
}

VideoAwemeGetRequest 获取抖音号下的视频 API Request

func (VideoAwemeGetRequest) Encode added in v1.5.0 

func (r VideoAwemeGetRequest) Encode() string

Encode implement GetRequest interface

type VideoAwemeGetResponse added in v1.5.0 

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

VideoAwemeGetResponse 获取抖音号下的视频 API Response

type VideoAwemeGetResponseData added in v1.5.0 

type VideoAwemeGetResponseData struct {
	// List 视频列表
	List []VideoAweme `json:"list,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

VideoAwemeGetResponseData json返回值

type VideoCoverSuggestRequest 

type VideoCoverSuggestRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// VideoID 视频id
	VideoID string `json:"video_id,omitempty"`
}

VideoCoverSuggestRequest 获取视频智能封面 API Request

func (VideoCoverSuggestRequest) Encode 

func (r VideoCoverSuggestRequest) Encode() string

Encode implement GetRequest interface

type VideoCoverSuggestResponse 

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

VideoCoverSuggestResponse 获取视频智能封面 API Response

type VideoCoverSuggestResponseData 

type VideoCoverSuggestResponseData struct {
	// Status 封面生成的状态
	// 枚举值：RUNNING（生成中）、SUCCESS（成功）、FAILED（失败）
	// 注意：视频封面不是实时生成，需要根据status字段判断封面生成的状态，大概需要6，7s中生成，所以当status=RUNNING时请等待后重试
	Status enum.VideoCoverStatus `json:"status,omitempty"`
	// List 视频封面列表
	List []Image `json:"list,omitempty"`
}

VideoCoverSuggestResponseData json返回值

type VideoDeleteRequest 

type VideoDeleteRequest struct {
	// AdvertiserID 素材归属的广告主
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// VideoIDs 待删除的video_id列表，长度范围：1 ~ 100
	VideoIDs []string `json:"video_ids,omitempty"`
}

VideoDeleteRequest 批量删除视频素材 API Request

func (VideoDeleteRequest) Encode 

func (r VideoDeleteRequest) Encode() []byte

Encode implement PostRequest interface

type VideoDeleteResponse 

type VideoDeleteResponse struct {
	model.BaseResponse
	Data struct {
		// FailVideoIDs 操作失败的video_id列表，不在此列表内的素材表示删除成功
		FailVideoIDs []string `json:"fail_video_ids,omitempty"`
	} `json:"data,omitempty"`
}

VideoDeleteResponse 批量删除视频素材 API Response

type VideoEffeciencyGetRequest added in v1.7.5 

type VideoEffeciencyGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// MaterialIDs 素材列表，单次最多可查询100个
	MaterialIDs []string `json:"material_ids,omitempty"`
}

VideoEffeciencyGetRequest 获取低效素材 API Request

func (VideoEffeciencyGetRequest) Encode added in v1.7.5 

func (r VideoEffeciencyGetRequest) Encode() string

Encode implement GetRequest interfacd

type VideoEffeciencyGetResponse added in v1.7.5 

type VideoEffeciencyGetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data struct {
		// IDs <BS>低效素材id列表
		IDs []string `json:"inefficient_material_ids,omitempty"`
	} `json:"data,omitempty"`
}

VideoEffeciencyGetResponse 获取低效素材 API Response

type VideoForUpdate 

type VideoForUpdate struct {
	// VideoID 视频id，更新必填
	VideoID string `json:"video_id,omitempty"`
	// Filename 视频素材名称，最多255个字，更新时必填
	Filename string `json:"filename,omitempty"`
	// StatusCode 更新状态
	// SUCCESS 成功; FAILURE 失败（原因：操作视频非当前广告主所有或操作的视频不存在）
	StatusCode enum.VideoUpdateStatusCode `json:"status_code,omitempty"`
}

VideoForUpdate 上传视频信息

type VideoGetFilter 

type VideoGetFilter struct {
	// VideoIDs 视频ids，示例: ["86adb23eaa21229fc04ef932b5089bb8"]
	// 数量限制：<=100
	// 注意：video_ids、material_ids、signatures只能选择一个进行过滤
	VideoIDs []string `json:"video_ids,omitempty"`
	// MaterialIDs 素材id列表，可以根据material_ids（素材报表使用的id，一个素材唯一对应一个素材id）进行过滤
	// 数量限制：<=100
	// 注意：image_ids、material_ids、signatures只能选择一个进行过滤
	MaterialIDs []uint64 `json:"material_ids,omitempty"`
	// Signatures md5值列表，可以根据素材的md5进行过滤
	// 数量限制：<=100
	// 注意：image_ids、material_ids、signatures只能选择一个进行过滤
	Signatures []string `json:"signatures,omitempty"`
	// Width 图片宽度
	Width int `json:"width,omitempty"`
	// Height 图片高度
	Height int `json:"height,omitempty"`
	// Ratio 图片宽高比，eg: [1.7, 2.5]，输入1.7则搜索满足宽高比介于1.65-1.75之间的图片，即精度上下浮动0.05
	Ratio []float64 `json:"ratio,omitempty"`
	// StartTime 根据视频上传时间进行过滤的起始时间，与end_time搭配使用，格式：yyyy-mm-dd
	StartTime string `json:"start_time,omitempty"`
	// EndTime 根据视频上传时间进行过滤的截止时间，与start_time搭配使用，格式：yyyy-mm-dd
	EndTime string `json:"end_time,omitempty"`
}

VideoGetFilter 视频过滤条件

type VideoGetRequest 

type VideoGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 视频过滤条件
	Filtering *VideoGetFilter `json:"filtering,omitempty"`
	// Page 页码，默认值1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，默认值20
	PageSize int `json:"page_size,omitempty"`
}

VideoGetRequest 获取视频素材 API Request

func (VideoGetRequest) Encode 

func (r VideoGetRequest) Encode() string

Encode implement GetRequest interface

type VideoGetResponse 

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

VideoGetResponse 获取视频素材 API Response

type VideoGetResponseData 

type VideoGetResponseData struct {
	// List 视频列表
	List []Video `json:"list,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

VideoGetResponseData json返回值

type VideoMaterialClearResult added in v1.12.3 

type VideoMaterialClearResult struct {
	// MaterialID 素材id
	MaterialID uint64 `json:"material_id,omitempty"`
	// ClearMaterialTypes 清理素材类型：
	// INEFFICIENT_MATERIAL低效素材；
	// SIMILAR_MATERIAL 同质化挤压严重素材；
	// SIMILAR_QUEUE_MATERIAL 同质化排队素材
	ClearMaterialTypes []enum.MaterialProperty `json:"clear_material_types,omitempty"`
	// CreativeSuccessCount 清理成功的创意数
	CreativeSuccessCount int64 `json:"creative_success_count,omitempty"`
	// CreativeFailCount 清理失败的创意数
	CreativeFailCount int64 `json:"creative_fail_count,omitempty"`
	// PromotionSuccessCount 清理成功的广告数
	PromotionSuccessCount int64 `json:"promotion_success_count,omitempty"`
	// PromotionFailCount 清理失败的广告数
	PromotionFailCount int64 `json:"promotion_fail_count,omitempty"`
	// ClearResult 清理结果：
	// SUCCESS 成功
	// PART_SUCCESS 部分成功
	// FAIL 失败
	ClearResult string `json:"clear_result,omitempty"`
}

VideoMaterialClearResult 清理结果

type VideoMaterialClearTask added in v1.12.3 

type VideoMaterialClearTask struct {
	// ClearID 清理任务id
	ClearID uint64 `json:"clear_id,omitempty"`
	// ClearTaskParams 任务的参数
	ClearTaskParams *VideoMaterialClearTaskParameters `json:"clear_task_params,omitempty"`
	// CreateTime 任务创建时间，格式：%Y-%m-%d %H:%M:%S
	CreateTime string `json:"create_time,omitempty"`
	// TaskStatus 任务状态:
	// DONE 已完成
	// RUNNING 运行中
	// TIMEOUT超时
	TaskStatus enum.VideoMaterialClearTaskStatus `json:"task_status,omitempty"`
}

VideoMaterialClearTask 清理任务

type VideoMaterialClearTaskCreateRequest added in v1.12.3 

type VideoMaterialClearTaskCreateRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ClearTaskParams 任务参数，若同时填写多项任务的参数，则最终返回各个参数的交集
	ClearTaskParams *VideoMaterialClearTaskParameters `json:"clear_task_params,omitempty"`
}

VideoMaterialClearTaskCreateRequest 创建素材清理任务 API Request

func (VideoMaterialClearTaskCreateRequest) Encode added in v1.12.3 

func (r VideoMaterialClearTaskCreateRequest) Encode() []byte

Encode implement PostRequest interface

type VideoMaterialClearTaskCreateResponse added in v1.12.3 

type VideoMaterialClearTaskCreateResponse struct {
	model.BaseResponse
	// Data
	Data struct {
		// ClearID 创建成功的素材清理任务id
		ClearID uint64 `json:"clear_id,omitempty"`
	}
}

VideoMaterialClearTaskCreateResponse 创建素材清理任务 API Response

type VideoMaterialClearTaskGetData added in v1.12.3 

type VideoMaterialClearTaskGetData struct {
	List     []VideoMaterialClearTask `json:"list,omitempty"`
	PageInfo *model.PageInfo          `json:"page_info,omitempty"`
}

type VideoMaterialClearTaskGetRequest added in v1.12.3 

type VideoMaterialClearTaskGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ClearIDs 清理任务id列表，最多支持10个
	ClearIDs []uint64 `json:"clear_ids,omitempty"`
	// Page 页码，默认：1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，默认10，范围：1-100
	PageSize int `json:"page_size,omitempty"`
}

VideoMaterialClearTaskGetRequest 获取清理任务列表 API Request

func (VideoMaterialClearTaskGetRequest) Encode added in v1.12.3 

func (r VideoMaterialClearTaskGetRequest) Encode() string

Encode implement GetRequest interface

type VideoMaterialClearTaskGetResponse added in v1.12.3 

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

VideoMaterialClearTaskGetResponse 获取清理任务列表 API Response

type VideoMaterialClearTaskParameters added in v1.12.3 

type VideoMaterialClearTaskParameters struct {
	// MaterialSource 清理素材来源
	// 允许值：QIANCHUAN 千川、AD 广告平台
	MaterialSource enum.AccountType `json:"material_source,omitempty"`
	// MaterialIDs 待清理素材列表，单次最多支持100个
	MaterialIDs []uint64 `json:"material_ids,omitempty"`
	// ClearMaterialTypes 清理素材类型，允许值：INEFFICIENT_MATERIAL低效素材；SIMILAR_MATERIAL 同质化挤压严重素材；SIMILAR_QUEUE_MATERIAL同质化排队素材
	// 如果不传清理素材类型，默认清理这三个标签的全部素材
	ClearMaterialTypes []enum.MaterialProperty `json:"clear_material_types,omitempty"`
	// CreateTimeUpper 清理创建时间"yyyy-mm-dd"之前的素材，不包括这一天
	ClearTimeUpper string `json:"clear_time_upper,omitempty"`
	// StartTime 账户下累积转化数和累积消耗数的数据统计开始时间，格式为"yyyy-mm-dd"，且包含该日期
	StartTime string `json:"start_time,omitempty"`
	// EndTime 账户下累积转化数和累积消耗数的数据统计结束时间，格式为"yyyy-mm-dd"，且包含该日期
	EndTime string `json:"end_time,omitempty"`
	// Convert 账户下累积转化数，在start_time和end_time期间发生的累积转化数，清理小于该累积转化数的素材
	// 当start_time和end_time传入时有效
	Convert int64 `json:"convert,omitempty"`
	// Cost 账户下累积消耗，在start_time和end_time期间发生的累积消耗，清理小于该累积消耗的素材
	// 当start_time和end_time传入时有效
	Cost float64 `json:"cost,omitempty"`
}

VideoMaterialClearTaskParameters 任务参数，若同时填写多项任务的参数，则最终返回各个参数的交集

type VideoMaterialClearTaskResultGetData added in v1.12.3 

type VideoMaterialClearTaskResultGetData struct {
	// ClearResult 清理结果
	ClearResult []VideoMaterialClearResult `json:"clear_result,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

VideoMaterialClearTaskResultGetData

type VideoMaterialClearTaskResultGetRequest added in v1.12.3 

type VideoMaterialClearTaskResultGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ClearID 清理任务id
	ClearID uint64 `json:"clear_id,omitempty"`
	// Page 页码，默认1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，默认10，最大100
	PageSize int `json:"page_size,omitempty"`
}

VideoMaterialClearTaskResultGetRequest 下载清理任务结果 API Request

func (VideoMaterialClearTaskResultGetRequest) Encode added in v1.12.3 

func (r VideoMaterialClearTaskResultGetRequest) Encode() string

Encode implement GetRequest interface

type VideoMaterialClearTaskResultGetResponse added in v1.12.3 

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

VideoMaterialClearTaskResultGetResponse 下载清理任务结果 API Response

type VideoUpdateRequest 

type VideoUpdateRequest struct {
	// AdvertiserID 素材归属的广告主
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Videos 限制最多 100 个
	Videos []VideoForUpdate `json:"videos,omitempty"`
}

VideoUpdateRequest 更新视频API Request

func (VideoUpdateRequest) Encode 

func (r VideoUpdateRequest) Encode() []byte

Encode implement PostRequest interface

type VideoUpdateResponse 

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

VideoUpdateResponse 更新视频API Response

type VideoUpdateResponseData 

type VideoUpdateResponseData struct {
	// Videos 视频列表
	Videos []VideoForUpdate `json:"videos,omitempty"`
}

VideoUpdateResponseData json返回值

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.