file

package
v1.30.5 Latest Latest
Warning

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

 Go to latest Published: Dec 25, 2024 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 Audio added in v1.18.6 

type Audio struct {
	// Vid 音频id
	Vid string `json:"vid,omitempty"`
	// VideoID 音频id（旧版）（该字段将在12月19日下线，暂不对您的调用产生影响，请及时调整，使用下方audio_id）
	VideoID string `json:"video_id,omitempty"`
	// URL 音频地址（旧版）（该字段将在12月19日下线，暂不对您的调用产生影响，请及时调整，使用下方audio_url）
	URL string `json:"url,omitempty"`
	// AudioID 音频id
	AudioID string `json:"audio_id,omitempty"`
	// AudioURL 音频地址
	AudioURL string `json:"audio_url,omitempty"`
	// MaterialID 素材id
	MaterialID uint64 `json:"material_id,omitempty"`
	// AudioSignature 音频素材md5值
	AudioSignature string `json:"audio_signature,omitempty"`
}

Audio 音频信息

func (*Audio) UnmarshalJSON added in v1.18.6 

func (a *Audio) UnmarshalJSON(data []byte) error

type AudioAdRequest added in v1.21.5 

type AudioAdRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// UploadType 音频上传方式, 允许值:
	// UPLOAD_BY_FILE 文件上传（默认值）
	// UPLOAD_BY_URL 网址上传
	UploadType enum.UploadType `json:"upload_type,omitempty"`
	// AudioSignature 音频的md5值(用于服务端校验)
	// upload_type为UPLOAD_BY_FILE时必填
	AudioSignature string `json:"audio_signature,omitempty"`
	// AudioFile 音频文件，upload_type为UPLOAD_BY_FILE时必填
	// 允许格式：m4a、mp3
	// 文件大小：≤20M
	AudioFile *model.UploadField `json:"audio_file,omitempty"`
	// AudioURL 音频url地址，如http://xxx.xxx，upload_type为UPLOAD_BY_URL必填
	AudioURL string `json:"audio_url,omitempty"`
}

AudioAdRequest 上传图文内的音频素材 API Request

func (AudioAdRequest) Encode added in v1.21.5 

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

Encode implement UploadRequest interface

type AudioAdResponse added in v1.21.5 

type AudioAdResponse struct {
	model.BaseResponse
	Data struct {
		// AudioInfo 音频信息
		AudioInfo *Audio `json:"audio_info,omitempty"`
	} `json:"data,omitempty"`
}

AudioAdResponse 上传图文内的音频素材 API Response

type AwemeCarousel added in v1.28.2 

type AwemeCarousel struct {
	// ItemID 抖音图文id，在抖音号内上传图文素材时生成的id，是抖音端图文素材的唯一id
	ItemID uint64 `json:"item_id,omitempty"`
	//  MaterialID 抖音图文素材id，在查询素材维度的报表（会用该id作为维度，对应「素材管理」-「获取图文素材」等相关接口中的carousel_ids.id或carousel_id）
	MaterialID uint64 `json:"material_id,omitempty"`
	// CarouselTitle 抖音图文标题
	CarouselTitle string `json:"carousel_title,omitempty"`
	// CarouselPlayURL 抖音图文播放地址，格式为：https://douyin.com/video/XXXXXX
	CarouselPlayURL string `json:"carousel_play_url,omitempty"`
	// CarouselCoverURL 抖音图文素材内封面图片预览url，有效期10小时
	CarouselCoverURL string `json:"carousel_cover_url,omitempty"`
	// Images 抖音图文素材内的图片信息，最多35张图片
	// 按照图文本身的顺序返回，最前面的图片在最上面
	Images []CarouselImage `json:"images,omitempty"`
}

AwemeCarousel 抖音图文素材 

type Carousel struct {
	// ID 图集id
	ID uint64 `json:"id,omitempty"`
	// CarouselID 图集id
	CarouselID uint64 `json:"carousel_id,omitempty"`
	// Uri 图集uri
	Uri string `json:"uri,omitempty"`
	// CarouselType 图集素材类型
	CarouselType enum.ImageMode `json:"carousel_type,omitempty"`
	// Images 图片信息
	Images []CarouselImage `json:"images,omitempty"`
	// Audio 音频信息
	Audio *Audio `json:"audio,omitempty"`
	// FileName 文件名
	FileName string `json:"file_name,omitempty"`
	// CreateTime 图集创建时间
	CreateTime string `json:"create_time,omitempty"`
	// UpdateTime 图集更新时间
	UpdateTime string `json:"update_time,omitempty"`
	// Source  图文素材来源
	Source string `json:"source,omitempty"`
}

Carousel 图集信息

func (*Carousel) UnmarshalJSON added in v1.18.6 

func (c *Carousel) UnmarshalJSON(data []byte) error

type CarouselAdGetRequest added in v1.18.6 

type CarouselAdGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CarouselIDs 图集id
	CarouselIDs []uint64 `json:"carousel_ids,omitempty"`
}

CarouselAdGetRequest 获取同主体下广告主图集素材 API Request

func (CarouselAdGetRequest) Encode added in v1.18.6 

func (r CarouselAdGetRequest) Encode() string

Encode implement GetRequest interface

type CarouselAdGetResponse added in v1.18.6 

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

CarouselAdGetResponse 获取同主体下广告主图集素材 API Response

type CarouselAdGetResult added in v1.18.6 

type CarouselAdGetResult struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Carousels 图集信息
	Carousels []Carousel `json:"carousels,omitempty"`
}

type CarouselAwemeGetFilter added in v1.28.2 

type CarouselAwemeGetFilter struct {
	// ItemIDs 抖音图文唯一ID
	ItemIDs []uint64 `json:"item_ids,omitempty"`
}

type CarouselAwemeGetRequest added in v1.28.2 

type CarouselAwemeGetRequest struct {
	// AdvertiserID 巨量广告广告主账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AwemeID 抖音号id
	AwemeID string `json:"aweme_id,omitempty"`
	// Filtering 过滤器
	Filtering *CarouselAwemeGetFilter `json:"filtering,omitempty"`
	// Cursor 页码游标值，第一次拉取，请传入0
	// 不传入或者传空字符串默认使用
	Cursor string `json:"cursor,omitempty"`
	// Count 页面数据量，默认10，最大值100
	Count int `json:"count,omitempty"`
}

CarouselAwemeGetRequest 获取创编可用的抖音图文素材 API Request

func (CarouselAwemeGetRequest) Encode added in v1.28.2 

func (r CarouselAwemeGetRequest) Encode() string

Encode implements GetRequest interface

type CarouselAwemeGetResponse added in v1.28.2 

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

CarouselAwemeGetResponse 获取创编可用的抖音图文素材 API Response

type CarouselAwemeGetResult added in v1.28.2 

type CarouselAwemeGetResult struct {
	// CursorInfo 分页信息
	CursorInfo *model.CursorInfo `json:"cursor_info,omitempty"`
	// AwemeCarouseList 抖音图文素材列表
	AwemeCarouseList []AwemeCarousel `json:"aweme_carouse_list,omitempty"`
}

type CarouselCreateRequest added in v1.18.6 

type CarouselCreateRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Images 图片信息，包含图片id和图片主题
	Images []CarouselImage `json:"images,omitempty"`
	// VideoID 音频id（旧版）（该字段将在12月19日下线，暂不对您的调用产生影响。请及时调整，使用下方audio_id来搭建图文素材）
	VideoID string `json:"video_id,omitempty"`
	// AudioID 音频id，根据「上传图文内的音频素材」接口获取
	// 非必填，不传系统将自动匹配一段纯音乐
	AudioID string `json:"audio_id,omitempty"`
	// FileName 文件名，可自定义素材名，不传则默认取文件名，最长255个字符
	FileName string `json:"file_name,omitempty"`
	// CarouselType 可选值:
	// INFORMATION_FLOW_IMAGE 信息流图集
	// SEARCH_DISPLAY_WINDOW_IMAGE 搜索橱窗橱窗
	// TOUTIAO_SEARCH_AD_IMAGE 搜索大图图集
	CarouselType enum.ImageMode `json:"carousel_type,omitempty"`
}

CarouselCreateRequest 上传图集 API Request

func (CarouselCreateRequest) Encode added in v1.18.6 

func (r CarouselCreateRequest) Encode() []byte

Encode implement PostRequest interface

type CarouselCreateResponse added in v1.18.6 

type CarouselCreateResponse struct {
	model.BaseResponse
	Data struct {
		// Carousel 图集信息
		Carousel *Carousel `json:"carousel,omitempty"`
	} `json:"data,omitempty"`
}

CarouselCreateResponse 上传图集 API Response

type CarouselDeleteRequest added in v1.18.6 

type CarouselDeleteRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CarouselIDs 图集id
	CarouselIDs []uint64 `json:"carousel_ids,omitempty"`
}

CarouselDeleteRequest 批量删除图集 API Request

func (CarouselDeleteRequest) Encode added in v1.18.6 

func (r CarouselDeleteRequest) Encode() []byte

Encode implement GetRequest interface

type CarouselDeleteResponse added in v1.18.6 

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

CarouselDeleteResponse 批量删除图集 API Response

type CarouselDeleteResult added in v1.18.6 

type CarouselDeleteResult struct {
	// FailedIDs 批量删除失败列表
	FailedIDs []uint64 `json:"failed_ids,omitempty"`
	// SuccessList 批量删除成功列表
	SuccessList []uint64 `json:"success_list,omitempty"`
}

CarouselDeleteResult 批量删除图集结果

type CarouselImage added in v1.18.6 

type CarouselImage struct {
	// ImageID 图片id，根据上传广告图片接口获取
	ImageID string `json:"image_id,omitempty"`
	// MaterialID 素材id
	MaterialID uint64 `json:"material_id,omitempty"`
	// Ratio 图片比例
	Ratio float64 `json:"ratio,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"`
	// ImageSubject 图片主题
	ImageSubject *ImageSubject `json:"image_subject,omitempty"`
}

CarouselImage 图集图片信息，包含图片id和图片主题

type CarouselListFilter added in v1.18.6 

type CarouselListFilter struct {
	// CarouselIDs 图集id
	CarouselIDs []uint64 `json:"carousel_ids,omitempty"`
	// FileName 文件名
	FileName string `json:"file_name,omitempty"`
	// CarouselType 图集素材类型
	CarouselType []enum.ImageMode `json:"carousel_type,omitempty"`
	// ImageIDs 图片id
	ImageIDs []string `json:"image_ids,omitempty"`
	// VideoID 音频id（旧版）（该字段将在12月19日下线，暂不对您的调用产生影响，请及时调整，使用下方audio_id）
	VideoID string `json:"video_id,omitempty"`
	// AudioID 音频id
	AudioID string `json:"audio_id,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"`
	// Source 图文素材来源，可选值:
	// 本地上传：AD_SITE
	// 组织共享：BP
	// 账户推送：ACCOUNT_PUSH
	// 即创：AIC
	// MarketingAPI：OPEN_API
	// 抖音主页：CEWEBRITY_CAROUSEL
	Source string `json:"source,omitempty"`
}

CarouselListFilter 图集过滤信息

type CarouselListRequest added in v1.18.6 

type CarouselListRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 图集过滤信息
	Filtering *CarouselListFilter `json:"filtering,omitempty"`
	// Page 页码，默认值1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，默认值20
	PageSize int `json:"page_size,omitempty"`
}

CarouselListRequest 获取图集素材 API Request

func (CarouselListRequest) Encode added in v1.18.6 

func (r CarouselListRequest) Encode() string

Encode implement GetRequest interface

type CarouselListResponse added in v1.18.6 

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

CarouselListRespones 获取图集素材 API Response

type CarouselListResult added in v1.18.6 

type CarouselListResult struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// Carousels 图集信息
	Carousels []Carousel `json:"carousels,omitempty"`
}

type CarouselUpdateImage added in v1.18.6 

type CarouselUpdateImage struct {
	// ImageID 图片id
	ImageID string `json:"image_id,omitempty"`
	ImageSubject
}

type CarouselUpdateItem added in v1.18.6 

type CarouselUpdateItem struct {
	// ID 图集id
	ID uint64 `json:"id,omitempty"`
	// FileName 更新文件名
	FileName string `json:"file_name,omitempty"`
	// Images 图片主题
	Images []CarouselUpdateImage `json:"images,omitempty"`
}

type CarouselUpdateRequest added in v1.18.6 

type CarouselUpdateRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Carousels 需要更新的图集信息
	Carousels []CarouselUpdateItem `json:"carousels,omitempty"`
}

CarouselUpdateRequest 批量更新图集 API Request

func (CarouselUpdateRequest) Encode added in v1.18.6 

func (r CarouselUpdateRequest) Encode() []byte

Encode implement PostRequest interface

type CarouselUpdateResponse added in v1.18.6 

type CarouselUpdateResponse struct {
	model.BaseResponse
	Data struct {
		// Carousels 图集信息
		Carousels []CarouselUpdateResult `json:"carousels,omitempty"`
	} `json:"data,omitempty"`
}

CarouselUpdateResponse 批量更新图集 API Response

type CarouselUpdateResult added in v1.18.6 

type CarouselUpdateResult struct {
	// ID 图片id
	ID uint64 `json:"id,omitempty"`
	// StatusCode 状态码
	StatusCode int `json:"status_code,omitempty"`
	// Message 返回信息
	Message string `json:"message,omitempty"`
}

type CursorInfo added in v1.19.7 

type CursorInfo struct {
	HasMore bool   `json:"has_more"`
	Cursor  string `json:"cursor"`
}

type FailedMaterialBind 

type FailedMaterialBind struct {
	// VideoID 推送失败的视频id
	VideoID string `json:"video_id,omitempty"`
	// ImageID 推送失败的图片id
	ImageID string `json:"image_id,omitempty"`
	// CarouselID 推送失败的图集id
	CarouselID uint64 `json:"carousel_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"`
	// Aigc 素材是否是aigc生成
	Aigc bool `json:"aigc,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"`
	// IsAigc 图片素材是否为AIGC生成
	IsAigc bool `json:"is_aigc,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 ImageSubject added in v1.18.6 

type ImageSubject struct {
	// Description 图片详述
	Description string `json:"description,omitempty"`
	// Brand 品牌信息
	Brand string `json:"brand,omitempty"`
	// Text 图片文字
	Text string `json:"text,omitempty"`
	// Comment 备注
	Comment string `json:"comment,omitempty"`
}

ImageSubject 图片主题

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"`
	// Aigc 素材是否是aigc生成
	Aigc bool `json:"aigc,omitempty"`
}

Material 低效素材

type MaterialAttribute added in v1.22.7 

type MaterialAttribute struct {
	// MaterialID 素材id
	MaterialID uint64 `json:"material_id,omitempty"`
	// AdLowQualitySuggestions 当该素材为AD低质素材时，返回低质原因，仅当return_lowquality_suggestions = true时，会返回此参数
	AdLowQualitySuggestions []string `json:"ad_low_quality_suggestions,omitempty"`
	// EcpLowQualitySuggestions 当该素材为千川低质素材时，返回低质原因，仅当return_lowquality_suggestions = true时，会返回此参数
	EcpLowQualitySuggestions []string `json:"ecp_low_quality_suggestions,omitempty"`
	// IsAdHighQualityMaterial 是否AD优质素材
	IsAdHighQualityMaterial bool `json:"is_ad_high_quality_material,omitempty"`
	// IsAdLowQualityMaterial 是否AD低质素材
	IsAdLowQualityMaterial bool `json:"is_ad_low_quality_material,omitempty"`
	// IsEcpHighQualityMaterial 是否千川优质素材
	IsEcpHighQualityMaterial bool `json:"is_ecp_high_quality_material,omitempty"`
	// IsEcpLowQualityMaterial 是否千川低质素材
	IsEcpLowQualityMaterial bool `json:"is_ecp_low_quality_material,omitempty"`
	// IsFirstPublishMaterial 是否是首发素材
	IsFirstPublishMaterial bool `json:"is_first_publish_material,omitempty"`
	// IsInefficientMaterial 是否低效素材
	IsInefficientMaterial bool `json:"is_inefficient_material,omitempty"`
	// IsCarryMaterial 是否存在搬运风险，建议入参account_type = AD 或 QIANCHUAN查询
	IsCarryMaterial bool `json:"is_carry_material,omitempty"`
	// IsSimilarMaterial 是否同质化挤压严重素材
	// 方舟/工作台账户不支持
	IsSimilaryMaterial bool `json:"is_similary_material,omitempty"`
	// IsSimilaryQueueMaterial 是否同质化素材风险-排队投放素材
	// 方舟/工作台账户不支持
	IsSimilaryQueueMaterial bool `json:"is_similary_queue_material,omitempty"`
	// IsSimilaryExpectedQueueMaterial 是否同质化素材风险-未投放预计排队素材
	// 方舟/工作台账户不支持
	IsSimilaryExpectedQueueMaterial bool `json:"is_similary_expected_queue_material,omitempty"`
	// AttributesModifyTime 存在搬运打压风险」属性最后一次更新时间，如素材未被标记为搬运，则不会返回该时间。格式为yyyy-mm-dd HH:MM:SS
	AttributesModifyTime string `json:"attributes_modify_time,omitempty"`
}

素材及素材属性

type MaterialAttributesListFilter added in v1.22.7 

type MaterialAttributesListFilter struct {
	// MaterialIDs 按素材ID过滤，范围为1-1000
	MaterialIDs []uint64 `json:"material_ids,omitempty"`
	// MaterialProperties 素材标签过滤项，如果不传，则默认返回广告主ID下所有素材。
	// 传入多个允许值，该参数多个值之间为「或」的关系，只要素材存在某一种类型的标签，都会在应答参数中返回。
	// 允许值：
	// FIRST_PUBLISH_MATERIAL 首发素材
	// AD_HIGH_QUALITY_MATERIAL  AD优质素材
	// ECP_HIGH_QUALITY_MATERIAL 千川优质素材
	// AD_LOW_QUALITY_MATERIAL AD低质素材
	// ECP_LOW_QUALITY_MATERIAL 千川低质素材
	// INEFFICIENT_MATERIAL 低效素材
	// SIMILAR_MATERIAL 同质化挤压素材
	// SIMILAR_QUEUE_MATERIAL 同质化排队素材
	// CARRY_MATERIAL存在搬运打压风险
	MaterialProperties []enum.MaterialProperty `json:"material_properties,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"`
	// AttributesModifyTime 「存在搬运打压风险」属性最后一次更新时间，格式为yyyy-mm-dd ，筛选传入代表筛选出当天「存在搬运打压风险」发生过变化的素材信息
	AttributesModifyTime string `json:"attributes_modify_time,omitempty"`
}

type MaterialAttributesListRequest added in v1.22.7 

type MaterialAttributesListRequest struct {
	// AccountID 各平台账户id，必须同时选择account_type类型
	AccountID uint64 `json:"account_id,omitempty"`
	// AccountType 账户类型， 可选值:
	// BP 巨量引擎工作台（纵横）
	// AGENT 巨量方舟
	// AD 巨量广告
	// QIANCHUAN 巨量千川
	AccountType enum.AccountType `json:"account_type,omitempty"`
	// Filtering 过滤条件
	// 不同条件之间为「且」的关系，只有同时满足传入的多个条件，才会返回信息
	Filtering *MaterialAttributesListFilter `json:"filtering,omitempty"`
	// ReturnLowqualitySuggestions 应答参数是否返回低质原因，不传或传入false时，应答参数不返回低质原因
	// 当素材为低质素材时，可查询素材低质原因，允许值：
	//  返回：true
	//  不返回：false
	ReturnLowqualitySuggestions bool `json:"return_lowquality_suggestions,omitempty"`
	// Page 页码，默认值: 1，page*page_size 最大1000
	Page int `json:"page,omitempty"`
	// PageSize 页面数据量，默认值: 100，page*page_size 最大1000
	PageSize int `json:"page_size,omitempty"`
}

MaterialAttributesListRequest 获取视频素材评估标签（新版） API Request

func (MaterialAttributesListRequest) Encode added in v1.22.7 

func (r MaterialAttributesListRequest) Encode() string

Encode implement GetRequest interface

type MaterialAttributesListResponse added in v1.22.7 

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

MaterialAttributesListResponse 获取视频素材评估标签（新版） API Response

type MaterialAttributesListResult added in v1.22.7 

type MaterialAttributesListResult struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// Materials 素材及素材属性列表
	Materials []MaterialAttribute `json:"materials,omitempty"`
}

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"`
	// CarouselIDs 图集ID，数量限制：<=50 注意：跟image_ids、video_ids必须三选一
	CarouselIDs []uint64 `json:"carousel_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 MaterialClearResult added in v1.20.6 

type MaterialClearResult struct {
	// MaterialID 素材ID
	MaterialID uint64 `json:"material_id,omitempty"`
	// IsCleared 素材是否被暂停（存在内部错误导致素材没有被暂停)
	IsCleared bool `json:"is_cleared,omitempty"`
	// CreativeSuccessList 暂停成功的适用该素材创意ID
	CreativeSuccessList []uint64 `json:"creative_success_list,omitempty"`
	// CreativeFailureList 暂停失败的适用该素材创意ID
	CreativeFailureList []uint64 `json:"creative_failure_list,omitempty"`
	// PromotionSuccessList 暂停成功的适用该素材广告ID
	PromotionSuccessList []uint64 `json:"promotion_success_list,omitempty"`
	// PromotionFailureList 暂停失败的适用该素材广告ID
	PromotionFailureList []uint64 `json:"promotion_failure_list,omitempty"`
}

MaterialClearResult 暂停结果明细

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 RebateMaterial added in v1.20.6 

type RebateMaterial struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// OperatorTag 运营标签
	OperatorTag int `json:"operator_tag,omitempty"`
	// RebateCalcPolicyType 政策类型
	RebateCalcPolicyType int `json:"rebate_calc_policy_type,omitempty"`
	// RebateCalcSettlementStatsType 结算行业统计类型
	RebateCalcSettlementStatsType int `json:"rebate_calc_settlement_stats_type,omitempty"`
	// RebateCalcFirstIndustryName 一级结算行业
	RebateCalcFirstIndustryName string `json:"rebate_calc_first_industry_name,omitempty"`
	// RebateCalcSecondIndustryName 二级结算行业
	RebateCalcSecondIndustryName string `json:"rebate_calc_second_industry_name,omitempty"`
	// CustomerName 客户名称
	CustomerName string `json:"customer_name,omitempty"`
	// OptimizerName 代理商优化师
	OptimizerName string `json:"optimizer_name,omitempty"`
	// AgentSaleName 代理商销售
	AgentSaleName string `json:"agent_sale_name,omitempty"`
	// SecondAdAgentID 二级代理商账户ID
	SecondAdAgentID uint64 `json:"second_ad_agent_id,omitempty"`
	// MaterialInfo 素材信息
	MaterialInfo *RebateMaterialInfo `json:"material_info,omitempty"`
	// UpdateDate 数据更新日期
	UpdateDate string `json:"update_date,omitempty"`
}

RebateMaterial 低效素材

type RebateMaterialInfo added in v1.20.6 

type RebateMaterialInfo struct {
	// MaterialID 素材ID
	MaterialID uint64 `json:"material_id,omitempty"`
	// MaterialIsEffective 素材是否有效
	MaterialIsEffective int `json:"material_is_effective,omitempty"`
	// IsValidVideoMaterial [政策粒度] 是否有效素材
	IsValidVideoMaterial int `json:"is_valid_video_material,omitempty"`
	// PolicyCost [政策力度] 消耗
	PolicyCost float64 `json:"policy_cost,omitempty"`
	// Cost 消耗
	Cost float64 `json:"cost,omitempty"`
	// MaterialCreateTime 素材创建时间
	MaterialCreateTime string `json:"material_create_time,omitempty"`
	// MaterialTag 素材属性标签
	MaterialTag []enum.MaterialProperty `json:"material_tag,omitempty"`
	// AdIDs 计划ID数组
	AdIDs []uint64 `json:"ad_ids,omitempty"`
	// CdpPromotionIDs 广告ID数组
	CdpPromotionIDs []uint64 `json:"cdp_promotion_ids,omitempty"`
}

RebateMaterialInfo 素材信息

type RebateMaterialSearchFilter added in v1.20.6 

type RebateMaterialSearchFilter struct {
	// AdvertierID 广告主ID
	AdvertierID uint64 `json:"advertier_id,omitempty"`
	// CustomerName  客户名称: 需转为英文括号
	CustomerName string `json:"customer_name,omitempty"`
	// MaterialTag 素材标签筛选: 若传入多个标签，则会取交集
	// INEFFICIENT_MATERIAL 低效素材
	// AD_HIGH_QUALITY 广告高质量
	// FIRST_PUBLISH_MATERIAL 首发素材
	MaterialTag []enum.MaterialProperty `json:"material_tag,omitempty"`
	// MaterialIsEffective 当月最新一天素材是否在投, 允许值:
	// 1: 是, 2: 否
	MaterialIsEffective int `json:"material_is_effective,omitempty"`
	// IsValidVideoMaterial [政策粒度] 是否有效素材, 允许值:
	// 1: 是, 2: 否 (默认值 2)
	IsValidVideoMaterial int `json:"is_valid_video_material,omitempty"`
	// PolicyCostMin [政策力度] 小号范围下限, 格式限制: 正数
	PolicyCostMin int64 `json:"policy_cost_min,omitempty"`
	// PolicyCostMax [政策力度] 大号范围上限, 格式限制: 正数
	PolicyCostMax int64 `json:"policy_cost_max,omitempty"`
	// OperatorTag 运营标签
	// 1: 自运营
	// 2: 走量
	// 3: 收量
	OperatorTag int `json:"operator_tag,omitempty"`
	// RebateCalcPolicyType 政策类型
	// 1: 综代政策
	// 2: 优待政策
	RebateCalcPolicyType int `json:"rebate_calc_policy_type,omitempty"`
	// RebateCalcSettlementStatsType 结算行业统计类型
	// 1: 行业类目
	// 2: 引流电商
	// 4: 任务激励
	// 5: 微信加粉
	RebateCalcSettlementStatsType int `json:"rebate_calc_settlement_stats_type,omitempty"`
	// RebateCalcFirstIndustryName 一级结算行业
	RebateCalcFirstIndustryName string `json:"rebate_calc_first_industry_name,omitempty"`
	// RebateCalcSecondIndustryName 二级结算行业
	RebateCalcSecondIndustryName string `json:"rebate_calc_second_industry_name,omitempty"`
	// MaterialCreateStartDate 素材创建日期范围开始时间, 格式: yyyy-MM-dd
	MaterialCreateStartDate string `json:"material_create_start_date,omitempty"`
	// MaterialCreateEndDate 素材创建日期范围结束时间, 格式: yyyy-MM-dd
	MaterialCreateEndDate string `json:"material_create_end_date,omitempty"`
}

type RebateMaterialSearchRequest added in v1.20.6 

type RebateMaterialSearchRequest struct {
	// AgentID 代理商账户ID
	AgentID uint64 `json:"agent_id,omitempty"`
	// Period 年月
	Period string `json:"period,omitempty"`
	// Filtering 过滤条件
	Filtering *RebateMaterialSearchFilter `json:"filtering,omitempty"`
	// Page 页码
	Page int `json:"page,omitempty"`
	// PageSize 页面大小, 默认10, 最大值500
	PageSize int `json:"page_size,omitempty"`
}

RebateMaterialSearchRequest 获取低效素材List API Request

func (RebateMaterialSearchRequest) Encode added in v1.20.6 

func (r RebateMaterialSearchRequest) Encode() string

Encode implement GetRequest interface

type RebateMaterialSearchResponse added in v1.20.6 

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

RebateMaterialSearchResponse 获取低效素材List API Response

type RebateMaterialSearchResult added in v1.20.6 

type RebateMaterialSearchResult struct {
	// PageInfo 翻页信息
	PageInfo  *model.PageInfo  `json:"page_info,omitempty"`
	Materials []RebateMaterial `json:"materials,omitempty"`
}

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"`
	// VideoSignature 视频md5
	VideoSignature string `json:"video_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"`
	// StarAuthorID 星图达人ID
	StarAuthorID string `json:"star_author_id,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"`
	// UploadType 图片上传方式; 默认值：UPLOAD_BY_FILE; 允许值：UPLOAD_BY_FILE、UPLOAD_BY_URL
	UploadType enum.UploadType `json:"upload_type,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"`
	// Label 标签
	Label []string `json:"label,omitempty"`
	// VideoUrl 视频 url地址，如http://xxx.xxx，upload_type为UPLOAD_BY_URL必填
	VideoUrl string `json:"video_url,omitempty"`
	// IsAigc 图片素材是否为AIGC生成
	IsAigc bool `json:"is_aigc,omitempty"`
	// isGuideVideo 上传视频场景是否是引导视频（此功能仅游戏行业白名单客户可用，如需使用请联系运营）
	IsGuideVideo bool `json:"is_guide_video,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 VideoAgentRequest added in v1.22.8 

type VideoAgentRequest struct {
	// AgentID 代理商id
	AgentID uint64 `json:"agent_id,omitempty"`
	// UploadType 视频上传方式，暂仅支持文件上传，可选值:
	// UPLOAD_BY_FILE 文件上传（默认值）
	UploadType enum.UploadType `json:"upload_type,omitempty"`
	// Filename 视频上传名称
	Filename string `json:"filename,omitempty"`
	// VideoFile 视频文件数据，upload_type为UPLOAD_BY_FILE必填
	VideoFile *model.UploadField `json:"video_file,omitempty"`
	// VideoUrl 图片url地址，如http://xxx.xxx，upload_type为UPLOAD_BY_URL必填
	VideoUrl string `json:"video_url,omitempty"`
	// IsAigc 标注是否为AIGC生成
	IsAigc bool `json:"is_aigc,omitempty"`
	// IsNeedAuth 标注是否允许生效授权保护（前提素材需要是自产！！），目前只支持true 默认值: True
	IsNeedAuth bool `json:"is_need_auth,omitempty"`
}

VideoAgentRequest 【代理商】上传自产首发素材至方舟（搬运治理） API Request

func (VideoAgentRequest) Encode added in v1.22.8 

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

Encode implement UploadRequest interface

type VideoAgentResponse added in v1.22.8 

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

VideoAgentResponse 【代理商】上传自产首发素材至方舟（搬运治理） 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"`
	// 页码游标值，第一次拉取，请传入0
	Cursor string `json:"cursor,omitempty"`
	// 页面数据量
	Count int `json:"count,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"`
	CursorInfo CursorInfo      `json:"cursor_info"`
}

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"`
	// MaterialIDs 待删除的素材id列表，长度范围：1 ~ 100
	MaterialIDs []uint64 `json:"material_ids,omitempty"`
}

VideoDeleteRequest 批量删除视频素材 API Request 注意: video_ids和material_ids至少填一个

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"`
		// FailMaterialIDs 操作失败的素材id列表，不在此列表内的素材表示删除成功
		FailMaterialIDs []uint64 `json:"fail_material_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"`
	// Labels 视频标签
	Labels []string `json:"labels,omitempty"`
	// Source 素材来源，详见【附录-素材来源】
	// 枚举值大小写敏感，请严格按照定义的名称传参
	Source []enum.MaterialSource `json:"source,omitempty"`
	// StarAuthorIDs 星图达人 id 检索，仅当source = STAR 时，支持通过星图达人ID进行筛选，单次最多支持传入20 个id进行检索
	StarAuthorIDs []string `json:"star_author_ids,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"之前的素材，不包括这一天
	CreateTimeUpper string `json:"create_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 VideoPauseRequest added in v1.20.6 

type VideoPauseRequest struct {
	// AdvertiserID 素材归属的广告主
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// MaterialIDs 待暂停素材ID
	MaterialIDs []uint64 `json:"material_ids,omitempty"`
}

VideoPauseRequest 按账户暂停素材 API Request

func (VideoPauseRequest) Encode added in v1.20.6 

func (r VideoPauseRequest) Encode() []byte

Encode implement PostRequest interface

type VideoPauseResponse added in v1.20.6 

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

VideoPauseResponse 按账户暂停素材 API Response

type VideoPauseResult added in v1.20.6 

type VideoPauseResult struct {
	// MaterialClearRes1ult 暂停结果明细
	MaterialClearResult *MaterialClearResult `json:"material_clear_result,omitempty"`
	// Status 暂停结果, 允许值:
	// SUCCESS 成功
	// PART_SUCCESS 部分成功
	// FAIL 失败
	Status enum.VideoPauseStatus `json:"status,omitempty"`
	// FailMaterialIDs 暂停失败的素材ID(素材ID下仍然有至少一个可投创意)
	FailMaterialIDs []uint64 `json:"fail_material_ids,omitempty"`
}

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
Package rebate 【代理】返点明点化素材数据
 Package rebate 【代理】返点明点化素材数据

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.