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: 6 Imported by: 1

Documentation

Overview

Package file 素材管理API models

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ImageDeleteRequest added in v1.16.0 

type ImageDeleteRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ImageIDs 待删除的image_id列表，长度范围：1 ~ 100
	ImageIDs []string `json:"image_ids,omitempty"`
}

ImageDeleteRequest 批量删除图片素材 API Request

func (ImageDeleteRequest) Encode added in v1.16.0 

func (r ImageDeleteRequest) Encode() []byte

Encode implement PostRequest interface

type ImageDeleteResponse added in v1.16.0 

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

ImageDeleteResponse 批量删除图片素材 API Response

type ImageGetFilter added in v1.16.0 

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 []string `json:"material_ids,omitempty"`
	// Sigatures md5值列表，可以根据素材的md5进行过滤数量限制：<=100
	// 注意：image_ids、material_ids、signatures只能选择一个进行过滤
	Sigatures []string `json:"signatures,omitempty"`
	// ImageMode 素材类型
	ImageMode []enum.MaterialMode `json:"image_mode,omitempty"`
	// Tags 素材标签
	Tags []string `json:"tags,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 added in v1.16.0 

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

func (r ImageGetRequest) Encode() string

Encode implement GetRequest interface

type VideoAwemeGetFiltering 

type VideoAwemeGetFiltering struct {
	//ProductID 商品ID，查询关联商品的相应视频，仅短视频带货场景需入参
	ProductID uint64 `json:"product_id,omitempty"`
	// AwemeItemURL 抖音主页视频url
	AwemeItemURL string `json:"aweme_item_url,omitempty"`
}

VideoAwemeGetFiltering 筛选条件

type VideoAwemeGetRequest 

type VideoAwemeGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AwemeID 需拉取视频的抖音号
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// Filtering 视频过滤条件
	Filtering *VideoAwemeGetFiltering `json:"filtering,omitempty"`
	// Cursor 页码游标值，第一次拉取，无需入参
	Cursor int `json:"cursor,omitempty"`
	// Count 页面大小，默认值30，限制1-50
	Count int `json:"count,omitempty"`
}

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

func (VideoAwemeGetRequest) Encode 

func (r VideoAwemeGetRequest) Encode() string

Encode implement GetRequest interface

type VideoAwemeGetResponse 

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

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

type VideoAwemeGetResponseData 

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

VideoAwemeGetResponseData json返回值

type VideoDeleteRequest added in v1.16.0 

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

VideoDeleteRequest 批量删除视频素材 API Request

func (VideoDeleteRequest) Encode added in v1.16.0 

func (r VideoDeleteRequest) Encode() []byte

Encode implement PostRequest interface

type VideoDeleteResponse added in v1.16.0 

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.16.0 

type VideoEffeciencyGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// MaterialIDs 需要查询的素材id，不超过100个
	MaterialIDs []string `json:"material_ids,omitempty"`
}

VideoEfficiencyGetRequest 获取低效素材 API Request

func (VideoEffeciencyGetRequest) Encode added in v1.16.0 

func (r VideoEffeciencyGetRequest) Encode() string

Encode implement GetRequest interface

type VideoEffeciencyGetResponse added in v1.16.0 

type VideoEffeciencyGetResponse struct {
	model.BaseResponse
	Data struct {
		// InEffecientMaterialIDs 低效素材id列表
		InEffecientMaterialIDs []string `json:"in_effecient_material_ids,omitempty"`
	} `json:"data,omitempty"`
}

VideoEffeciencyGetResponse 获取低效素材 API Response

type VideoGetFilter added in v1.16.0 

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 []string `json:"material_ids,omitempty"`
	// Sigatures md5值列表，可以根据素材的md5进行过滤数量限制：<=100
	// 注意：image_ids、material_ids、signatures只能选择一个进行过滤
	Sigatures []string `json:"signatures,omitempty"`
	// ImageMode 素材类型
	ImageMode []enum.MaterialMode `json:"image_mode,omitempty"`
	// Tags 素材标签
	Tags []string `json:"tags,omitempty"`
	// Sources 素材来源，允许值：
	// ARTHUR 亚瑟共享素材
	// BP 巨量纵横共享素材
	// CREATIVE_CENTER 巨量创意PC共享素材
	// E_COMMERCE 本地上传
	// LIVE_HIGHLIGHT 直播剪辑素材
	// STAR 星图&即合共享素材
	// TADA tada共享素材
	// VIDEO_CAPTURE 易拍APP共享素材
	Sources []enum.MaterialSource `json:"sources,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"`
}

ImageVideoFilter 视频过滤条件

type VideoGetRequest added in v1.16.0 

type VideoGetRequest 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"`
}

VideoGetRequest 获取千川素材库视频 API Request

func (VideoGetRequest) Encode added in v1.16.0 

func (r VideoGetRequest) Encode() string

Encode implement GetRequest interface

type VideoOriginalGetRequest added in v1.16.0 

type VideoOriginalGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// MaterialIDs 需要查询的素材id，不超过100个
	MaterialIDs []string `json:"material_ids,omitempty"`
}

VideoOriginalGetRequest 获取首发素材 API Request

func (VideoOriginalGetRequest) Encode added in v1.16.0 

func (r VideoOriginalGetRequest) Encode() string

Encode implement GetRequest interface

type VideoOriginalGetResponse added in v1.16.0 

type VideoOriginalGetResponse struct {
	model.BaseResponse
	Data struct {
		// OriginalMaterialIDs 首发素材id列表
		OriginalMaterialIDs []string `json:"original_material_ids,omitempty"`
	} `json:"data,omitempty"`
}

VideoOriginalGetResponse 获取首发素材 API Response

Source Files

View all Source files

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.