material

package
v1.30.4 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: 6 Imported by: 0

Documentation

Overview

Package material 广告素材管理

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AdGetRequest added in v1.29.8 

type AdGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// MaterialID 素材id
	MaterialID uint64 `json:"material_id,omitempty"`
	// MaterialType 素材类型，可选值:
	// IMAGE 图片，图文
	// LIVE_ROOM 直播间画面
	// TITLE 标题
	// VIDEO 视频
	MaterialType MaterialType `json:"material_type,omitempty"`
	// MarketingScene 广告类型，可选值:
	// FEED 通投
	// SEARCH 搜索
	// SHOPPING_MALL 商城广告
	MarketingScene qianchuan.MarketingScene `json:"marketing_scene,omitempty"`
	// MarketingGoal 营销场景，可选值:
	// VIDEO_PROM_GOODS：推商品
	// LIVE_PROM_GOODS：推直播间
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// StartTime 计划数据开始时间，格式“YYYY-MM-DD”
	// 注意：最早开始时间不大于“当前时间-180天”
	StartTime string `json:"start_time,omitempty"`
	// EndTime 计划数据结束时间，格式“YYYY-MM-DD”
	EndTime string `json:"end_time,omitempty"`
	// Fields 需要查询的消耗指标，取值见返回值中metric相关指标
	Fields []string `json:"fields,omitempty"`
	// OrderField 排序字段
	OrderField string `json:"order_field,omitempty"`
	// OrderType 排序方式 可选值:
	// ASC 升序
	// DESC 降序
	OrderType enum.OrderType `json:"order_type,omitempty"`
}

AdGetRequest 获取素材关联计划 API Request

func (AdGetRequest) Encode added in v1.29.8 

func (r AdGetRequest) Encode() string

Encode implements GetRequest interface

type AdGetResponse added in v1.29.8 

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

AdGetResponse 获取素材关联计划 API Response

type AdGetResult added in v1.29.8 

type AdGetResult struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// AdList 计划列表
	AdList []MaterialAd `json:"ad_list,omitempty"`
}

type AdMaterialDeleteRequest 

type AdMaterialDeleteRequest struct {
	// MaterialIDs 待删除素材ID
	// 注意：最大支持100个素材
	MaterialIDs []uint64 `json:"material_ids,omitempty"`
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 计划ID
	AdID uint64 `json:"ad_id,omitempty"`
}

AdMaterialDeleteRequest 删除广告计划下素材 API Request

func (AdMaterialDeleteRequest) Encode 

func (r AdMaterialDeleteRequest) Encode() []byte

Encode implement PostRequest interface

type AdMaterialGetFiltering 

type AdMaterialGetFiltering struct {
	// MaterialType 素材类型 可选值:
	// IMAGE 图片，图文
	// TITLE 标题
	// LIVE_ROOM 直播间画面
	// VIDEO 视频
	MaterialType MaterialType `json:"material_type,omitempty"`
	// ImageMode 素材样式，仅material_type=VIDEO/IMAGE时支持
	// 当material_type=VIDEO时，支持如下
	// 横版视频 VIDEO_LARGE
	// 竖版视频  VIDEO_VERTICAL
	// 当material_type=IMAGE时，支持如下
	// 横版小图 SMALL
	// 横版大图 LARGE
	// 竖版图片LARGE_VERTICAL
	// 图文CAROUSEL
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// HavingCost 消耗情况，仅material_type=VIDEO/IMAGE时支持
	// 全部 ALL
	// 有消耗 YES
	// 默认查询全部
	HavingCost string `json:"having_cost,omitempty"`
	// SearchKeyword 搜索关键词
	// 支持查询直播间/视频/标题/图片名称、直播间/视频/图片id
	SearchKeyword string `json:"search_keyword,omitempty"`
	// StartTime 数据开始时间
	// 注意：仅having_cost入参时，该筛选项生效
	StartTime string `json:"start_time,omitempty"`
	// EndTime 数据结束时间
	// 注意：仅having_cost入参时，该筛选项生效
	EndTime string `json:"end_time,omitempty"`
	// VideoSource 视频来源，仅material_type=VIDEO时支持
	// AWEME 抖音主页视频
	// E_COMMERCE 本地上传
	// LIVE_HIGHLIGHT 直播剪辑素材
	// BP 巨量纵横共享素材
	// VIDEO_CAPTURE 易拍APP共享素材
	// ARTHUR 亚瑟共享素材
	// STAR 星图&即合共享素材
	// TADA tada共享素材
	// CREATIVE_CENTER 巨量创意PC共享素材
	// JIANYING 剪映共享素材
	// JI_CHUANG 即创共享素材
	VideoSource []enum.MaterialSource `json:"material_source,omitempty"`
	// AnalysisType 素材建议，仅material_type=VIDEO时支持
	//  CARRY_MATERIAL 搬运风险素材
	// LOW_EFFICIENCY_MATERIAL 低效素材
	// FIRST_PUBLISH_MATERIAL 首发素材
	// SIMILAR_RISK_MATERIAL 同质化素材
	// HIGH_QUALITY_MATERIAL 优质素材
	// POOR_QUALITY_MATERIAL 低质素材
	AnalysisType []enum.MaterialProperty `json:"analysis_type,omitempty"`
}

AdMaterialGetFiltering 过滤条件

type AdMaterialGetRequest 

type AdMaterialGetRequest struct {
	// Filtering 过滤条件
	Filtering *AdMaterialGetFiltering `json:"filtering,omitempty"`
	// OrderType 排序方式 可选值:
	// ASC 升序
	// DESC 降序 默认
	OrderType enum.OrderType `json:"order_type,omitempty"`
	// OrderField 排序字段，支持根据消耗等数据指标排序
	OrderField string `json:"order_field,omitempty"`
	// AdvertiserID 千川广告账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// Page 页码，默认值：1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，允许值：10, 20, 50, 100，默认值：10
	PageSize int `json:"page_size,omitempty"`
}

AdMaterialGetRequest 获取计划下素材列表 API Request

func (AdMaterialGetRequest) Encode 

func (r AdMaterialGetRequest) Encode() string

Encode implements GetRequest interface

type AdMaterialGetResponse 

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

AdMaterialGetResponse 获取计划下素材列表 API Response

type AdMaterialGetResult 

type AdMaterialGetResult struct {
	// PageInfo 分页结果
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// AdMaterialInfos 返回的素材信息列表
	AdMaterialInfos []AdMaterialInfo `json:"ad_material_infos,omitempty"`
}

type AdMaterialInfo 

type AdMaterialInfo struct {
	// MaterialInfo 素材信息
	MaterialInfo *MaterialInfo `json:"material_info,omitempty"`
	// Metrics 指标信息
	Metrics *report.Metrics `json:"metrics,omitempty"`
	// MaterialDeliveryType 素材投放状态
	MaterialDeliveryType string `json:"material_delivery_type,omitempty"`
	// AuditStatus 审核状态 可选值:
	// PASS 审核通过
	// REJECT 审核拒绝
	// IN_PROGRESS 审核中
	AuditStatus string `json:"audit_status,omitempty"`
	// CreativeIDs 关联的创意id
	CreativeIDs []uint64 `json:"creative_ids,omitempty"`
	// IsDel 是否删除
	IsDel bool `json:"is_del,omitempty"`
	// IsAutoGenerate 是否派生
	IsAutoGenerate bool `json:"is_auto_generate,omitempty"`
}

AdMaterialInfo 素材信息

type AuditPlatform added in v1.29.8 

type AuditPlatform string

AuditPlatform 审核平台 

const (
	// AuditPlatform_UNKNOWN 未知
	AuditPlatform_UNKNOWN AuditPlatform = "UNKNOWN"
	// AuditPlatform_AD 广告审核
	AuditPlatform_AD AuditPlatform = "AD"
	// AuditPlatform_CONTENT 内容审核
	AuditPlatform_CONTENT AuditPlatform = "CONTENT"
)

type AuditRecord added in v1.29.8 

type AuditRecord struct {
	// AuditPlatform 审核平台：可选值:
	// UNKNOWN：未知
	// AD：广告审核
	// CONTENT：内容审核
	AuditPlatform AuditPlatform `json:"audit_platform,omitempty"`
	// RejectReason 拒绝原因
	RejectReason []string `json:"reject_reason,omitempty"`
	// Suggestions 建议
	Suggestions []string `json:"suggestions,omitempty"`
}

AuditRecord 审核列表

type GetFilter 

type GetFilter struct {
	// MaterialType 素材类型，可选值:
	// IMAGE 图片，图文
	// LIVE_ROOM 直播间画面
	// TITLE 标题
	// VIDEO 视频
	// 注意：直播间画面 仅支持推直播间计划，图片仅支持推商品计划
	MaterialType MaterialType `json:"material_type,omitempty"`
	// ImageMode 素材样式，仅material_type=VIDEO/IMAGE时支持
	// 当material_type=VIDEO时，支持如下
	// 横版视频 VIDEO_LARGE
	// 竖版视频  VIDEO_VERTICAL
	// 当material_type=IMAGE时，支持如下
	// 横版小图 SMALL
	// 横版大图 LARGE
	// 竖版图片LARGE_VERTICAL
	// 图文CAROUSEL
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// HavingCost  消耗情况，仅material_type=VIDEO/IMAGE时支持
	HavingCost string `json:"having_cost,omitempty"`
	// VideoSource 视频来源，仅material_type=VIDEO时支持
	// AWEME 抖音主页视频
	// E_COMMERCE 本地上传
	// LIVE_HIGHLIGHT 直播剪辑素材
	// BP 巨量纵横共享素材
	// VIDEO_CAPTURE 易拍APP共享素材
	// ARTHUR 亚瑟共享素材
	// STAR 星图&即合共享素材
	// TADA tada共享素材
	// CREATIVE_CENTER 巨量创意PC共享素材
	// JIANYING 剪映共享素材
	// JI_CHUANG 即创共享素材
	// QUNFENG 群峰共享素材
	VideoSource enum.MaterialSource `json:"video_source,omitempty"`
	// AnalysisType 素材建议，仅material_type=VIDEO时支持
	// CARRY_MATERIAL 搬运风险素材
	// LOW_EFFICIENCY_MATERIAL 低效素材
	// FIRST_PUBLISH_MATERIAL 首发素材
	// SIMILAR_RISK_MATERIAL 同质化素材
	// HIGH_QUALITY_MATERIAL 优质素材
	// POOR_QUALITY_MATERIAL 低质素材
	AnalysisType enum.MaterialProperty `json:"analysis_type,omitempty"`
	// SearchKeyword 搜索关键词
	// 支持查询直播间/视频/标题/图片名称、直播间/视频/图片id
	SearchKeyword string `json:"search_keyword,omitempty"`
	// StartTime 数据查询开始时间，精确到秒，yyyy-MM-dd HH:mm:ss
	StartTime string `json:"start_time,omitempty"`
	// EndTime 数据查询结束时间，精确到秒，yyyy-MM-dd HH:mm:s
	EndTime string `json:"end_time,omitempty"`
}

type GetRequest 

type GetRequest struct {
	// AdvertiserID 千川广告账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// MarketingGoal
	// LIVE_PROM_GOODS 推直播间
	// VIDEO_PROM_GOODS 推商品
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// CampaignScene 按营销场景过滤，不传，默认查询全部，允许值：
	// 直播场景
	//   DAILY_SALE: 日常销售
	// LIVE_HEAT: 直播间加热
	// 推商品场景
	//   DAILY_SALE: 日常销售
	//   PLANT_GRASS: 人群种草
	CampaignScene qianchuan.CampaignScene `json:"campaign_scene,omitempty"`
	// MarketingScene 广告类型过滤，可选值:
	// FEED：通投
	// SEARCH：搜索
	// SHOPPING_MALL ：商城广告
	MarketingScene qianchuan.MarketingScene `json:"marketing_scene,omitempty"`
	// Filtering 过滤器
	Filtering *GetFilter `json:"filtering,omitempty"`
	// Fields 需要查询的消耗指标
	// 注意：不同素材类型支持的指标有所差异，具体见返回metrics指标
	Fields []string `json:"fields,omitempty"`
	// Page 页码，默认值：1
	Page int `json:"page,omitempty"`
	// PageSize  页面大小，允许值：10, 20, 50, 100，默认值：10
	PageSize int `json:"page_size,omitempty"`
	// OrderType 排序方式 可选值:
	// ASC升序
	// DESC降序（默认）
	OrderType enum.OrderType `json:"order_type,omitempty"`
	// OrderField 排序字段
	// 注意：仅支持根据metrics中字段进行排序，默认stat_cost
	OrderField string `json:"order_field,omitempty"`
}

GetRequest 获取账户下素材列表 API Request

func (GetRequest) Encode 

func (r GetRequest) Encode() string

Encode implements GetRequest interface

type GetResponse 

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

GetResponse 获取素材列表 API Response

type GetResult 

type GetResult struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// AdMateriaInfos 返回的素材信息列表             l
	AdMaterialInfos []AdMaterialInfo `json:"ad_material_infos,omitempty"`
}

type ImageMaterial 

type ImageMaterial struct {
	// Title 标题
	Title string `json:"title,omitempty"`
	// MusicURL 图文音乐播放链接
	MusicURL string `json:"music_url,omitempty"`
	// Description 图文描述
	Description string `json:"description,omitempty"`
	// ImageMode 素材样式
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// Source 来源
	Source enum.MaterialSource `json:"source,omitempty"`
	// Images 图片
	Images []MaterialImage `json:"images,omitempty"`
	// MaterialID 素材id
	MaterialID uint64 `json:"material_id,omitempty"`
}

ImageMaterial 图片素材

type MaterialAd added in v1.29.8 

type MaterialAd struct {
	// AdID 计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// AdName 计划名称
	AdName string `json:"ad_name,omitempty"`
	// Metrics 指标
	Metrics *report.Metrics `json:"metrics,omitempty"`
}

MaterialAd 素材关联计划

type MaterialImage 

type MaterialImage struct {
	// WebURL 图片url
	WebURL string `json:"web_url,omitempty"`
	// ImageURL 图片url
	ImageURL string `json:"image_url,omitempty"`
	// ID 图片id
	ID string `json:"id,omitempty"`
	// Height 图片高度
	Height int `json:"height,omitempty"`
	// Width 图片宽度
	Width int `json:"width,omitempty"`
}

MaterialImage 图片信息

type MaterialInfo 

type MaterialInfo struct {
	// VideoMaterial 视频素材
	VideoMaterial *VideoMaterial `json:"video_material,omitempty"`
	// ImageMaterial 图片素材
	ImageMaterial *ImageMaterial `json:"image_material,omitempty"`
	// TitleMaterial 标题素材
	TitleMaterial *TitleMaterial `json:"title_material,omitempty"`
	// RoomMaterial 直播间画面用户信息
	RoomMaterial *RoomMaterial `json:"room_material,omitempty"`
	// MaterialType 素材类型
	MaterialType MaterialType `json:"material_type,omitempty"`
}

MaterialInfo 素材信息

type MaterialType 

type MaterialType string

MaterialType 素材类型 

const (
	// MaterialType_IMAGE 图片，图文
	MaterialType_IMAGE MaterialType = "IMAGE"
	// MaterialType_TITLE 标题
	MaterialType_TITLE MaterialType = "TITLE"
	// MaterialType_LIVE_ROOM 直播间画面
	MaterialType_LIVE_ROOM MaterialType = "LIVE_ROOM"
	// MaterialType_VIDEO 视频
	MaterialType_VIDEO MaterialType = "VIDEO"
)

type RoomMaterial 

type RoomMaterial struct {
	// Name 直播间名称
	Name string `json:"name,omitempty"`
	// AwemeAvatar 头像
	AwemeAvatar string `json:"aweme_avatar,omitempty"`
	// ID 直播间id
	ID uint64 `json:"id,omitempty"`
}

RoomMaterial 直播间画面用户信息

type Suggestion added in v1.29.8 

type Suggestion struct {
	// AuditRecords 审核列表
	AuditRecords []AuditRecord `json:"audit_records,omitempty"`
	// MaterialID 素材id
	MaterialID uint64 `json:"material_id,omitempty"`
}

Suggestion 素材审核建议

type SuggestionRequest added in v1.29.8 

type SuggestionRequest struct {
	// MaterialIDs 素材id列表
	MaterialIDs []uint64 `json:"material_ids,omitempty"`
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 计划id
	AdID uint64 `json:"ad_id,omitempty"`
}

SuggestionRequest 计划下素材审核建议 API Request

func (SuggestionRequest) Encode added in v1.29.8 

func (r SuggestionRequest) Encode() string

Encode implements GetRequest interface

type SuggestionResponse added in v1.29.8 

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

SuggestionResponse 计划下素材审核建议 API Response

type SuggestionResult added in v1.29.8 

type SuggestionResult struct {
	List []Suggestion `json:"list,omitempty"`
}

type TitleMaterial 

type TitleMaterial struct {
	// Title 标题
	Title string `json:"title,omitempty"`
	// MaterialID 素材id
	MaterialID uint64 `json:"material_id,omitempty"`
}

TitleMaterial 标题素材

type VideoMaterial 

type VideoMaterial struct {
	// CoverImage 视频封面图片
	CoverImage *MaterialImage `json:"cover_image,omitempty"`
	// VideoID 视频 id
	VideoID string `json:"video_id,omitempty"`
	// Title 视频标题
	Title string `json:"title,omitempty"`
	// Source 视频来源
	Source enum.MaterialSource `json:"source,omitempty"`
	// ImageMode 素材样式
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// MaterialID 素材id
	MaterialID uint64 `json:"material_id,omitempty"`
	// VideoDuration 视频时长
	VideoDuration float64 `json:"video_duration,omitempty"`
}

VideoMaterial 视频素材

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.