unipromotion

package
v1.28.5 Latest Latest
Warning

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

 Go to latest Published: Oct 14, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package unipromotion 全域推广

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types 

type Ad struct {
	// AdInfo 广告信息
	AdInfo *AdInfo `json:"ad_info,omitempty"`
	// StatsInfo 消耗指标
	StatsInfo *report.UniPromotionStats `json:"stats_info,omitempty"`
	// RoomInfo 主播信息
	RoomInfo []live.Room `json:"room_info,omitempty"`
}

Ad 全域推广

type AdDetail added in v1.26.1 

type AdDetail struct {
	// DeliverySetting 投放设置
	DeliverySetting *DeliverySetting `json:"delivery_setting,omitempty"`
	// CreativeSetting 创意设置
	CreativeSetting *CreativeSetting `json:"creative_setting,omitempty"`
	// RoomInfo 主播信息
	RoomInfo []live.Room `json:"room_info,omitempty"`
	// ProgrammaticCreativeMediaList 程序化创意信息
	ProgrammaticCreativeMediaList []ProgrammaticCreativeMedia `json:"programmatic_creative_media_list,omitempty"`
	// Name 推广名称
	Name string `json:"name,omitempty"`
	// ModifyTime 修改时间
	ModifyTime string `json:"modify_time,omitempty"`
	// CreateTime 创建时间
	CreateTime string `json:"create_time,omitempty"`
	// MarketingGoal 营销目标
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// Status 投放状态
	Status qianchuan.AdStatus `json:"status,omitempty"`
	// OptStatus 操作状态，详见【附录-枚举值】
	OptStatus qianchuan.AdOptStatus `json:"opt_status,omitempty"`
	// AdID 计划id
	AdID uint64 `json:"ad_id,omitempty"`
}

AdDetail 广告详情

type AdInfo 

type AdInfo struct {
	// StartTime 当前周期开始时间，用来返回周期内数据
	StartTime string `json:"start_time,omitempty"`
	// EndTime 当前周期结束时间
	EndTime string `json:"end_time,omitempty"`
	// ModifyTime 修改时间
	ModifyTime string `json:"modify_time,omitempty"`
	// CreateTime 创建时间
	CreateTime string `json:"create_time,omitempty"`
	// MarketingGoal  营销目标
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// BudgetMode  预算类型
	BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"`
	// Status 投放状态
	Status qianchuan.AdStatus `json:"status,omitempty"`
	// OptStatus 操作状态，详见【附录-枚举值】
	OptStatus qianchuan.AdOptStatus `json:"opt_status,omitempty"`
	// SmartBidType  投放方式，可选值:
	// SMART_BID_CONSERVATIVE 放量投放
	// SMART_BID_CUSTOM 控成本投放
	SmartBidType enum.SmartBidType `json:"smart_bid_type,omitempty"`
	// Roi2Goal 支付ROI目标，最多支持两位小数
	Roi2Goal float64 `json:"roi2_goal,omitempty"`
	// Budget 预算
	Budget float64 `json:"budget,omitempty"`
	// ID 推广id
	ID uint64 `json:"id,omitempty"`
	// DeliverySecond 投放时长
	DeliverySecond int64 `json:"delivery_second,omitempty"`
}

AdInfo 广告信息

type AuthorizedGetRequest added in v1.18.5 

type AuthorizedGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Page 页码
	// 默认值： 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小
	// 默认值：10，最大值：100
	PageSize int `json:"page_size,omitempty"`
}

AuthorizedGetRequest 获取可投全域推广抖音号列表 API Request

func (AuthorizedGetRequest) Encode added in v1.18.5 

func (r AuthorizedGetRequest) Encode() string

Encode implement GetRequest interface

type AuthorizedGetResponse added in v1.18.5 

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

AuthorizedGetResponse 获取可投全域推广抖音号列表 API Response

type AuthorizedGetResult added in v1.18.5 

type AuthorizedGetResult struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// AwemeIDList 抖音号列表
	AwemeIDList []aweme.Aweme `json:"aweme_id_list,omitempty"`
}

type CreateRequest added in v1.26.1 

type CreateRequest struct {
	// AdvertiserID 千川广告账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AwemeID 抖音号id
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// MarketingGoal 营销目标，可选值:
	// LIVE_PROM_GOODS 直播间带货
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// DeliverySetting 投放设置
	DeliverySetting *DeliverySetting `json:"delivery_setting,omitempty"`
	// CreativeSetting 创意设置
	CreativeSetting *CreativeSetting `json:"creative_setting,omitempty"`
	// ProgrammaticCreativeMediaList 程序化创意信息
	ProgrammaticCreativeMediaList []ProgrammaticCreativeMedia `json:"programmatic_creative_media_list,omitempty"`
}

CreateRequest 新建全域推广计划 API Request

func (CreateRequest) Encode added in v1.26.1 

func (r CreateRequest) Encode() []byte

Encode implements PostRequest interface

type CreateResponse added in v1.26.1 

type CreateResponse struct {
	model.BaseResponse
	Data struct {
		// AdID 计划id
		AdID uint64 `json:"ad_id,omitempty"`
	} `json:"data,omitempty"`
}

CreateResponse 创建全域推广计划 API Response

type CreativeSetting added in v1.26.1 

type CreativeSetting struct {
	// SmartSelectMaterial 智能优选视频
	// true 开启（默认）
	// false 不开启
	SmartSelectMaterial bool `json:"smart_select_material,omitempty"`
	// HideInAweme 抖音主页可见性设置，和抖音号关系类型相关，返回值参考【附录-抖音号授权类型】
	// 仅单次展示可见 true
	// 主页始终可见 false
	// 官方+自运营（bind_type为OFFICIAL或SELF）
	// 1、全是抖音号主页视频，无需传，传了亦无效
	// 2、存在非抖音号主页原生视频，支持设置
	// 达人（bind_type不为OFFICIAL或SELF）
	// 1、不支持设置，传了亦无效
	HideInAweme bool `json:"hide_in_aweme,omitempty"`
	// CreativeCombineTypelive 直播间画面是否开启
	CreativeCombineTypeLive bool `json:"creative_combine_type_live,omitempty"`
	// CreativeCombineType 自选投放视频
	CreativeCombineType bool `json:"creative_combine_type,omitempty"`
}

CreativeSetting 创意设置

type DeliverySetting added in v1.26.1 

type DeliverySetting struct {
	// SmartBidType 投放场景（出价方式），可选值:
	// SMART_BID_CUSTOM 控成本投放
	SmartBidType enum.SmartBidType `json:"smart_bid_type,omitempty"`
	// Roi2Goal 支付ROI目标，单位元，最多支持两位小数
	Roi2Goal float64 `json:"roi2_goal,omitempty"`
	// QcpxMode 是否开启智能优惠券，可选值:
	// QCPX_MODE_OFF 关闭
	// QCPX_MODE_ON 开启
	QcpxModel qianchuan.QcpxMode `json:"qcpx_mode,omitempty"`
	// Budget 预算，单位元，最多支持两位小数
	Budget float64 `json:"budget,omitempty"`
	// LiveScheduleType 投放时间选择方式，可选值:
	// SCHEDULE_FROM_NOW从今天起长期投放
	// SCHEDULE_START_END设置开始和结束日期
	LiveScheduleType enum.LiveScheduleType `json:"live_schedule_type,omitempty"`
	// StartTime 投放开始时间
	// 注意：当schedule_type=SCHEDULE_START_END时必填
	StartTime string `json:"start_time,omitempty"`
	// EndTime 投放结束时间
	// 注意：当schedule_type=SCHEDULE_START_END时必填
	EndTime string `json:"end_time,omitempty"`
	// ExternalAction 转化目标
	// AD_CONVERT_TYPE_LIVE_SUCCESSORDER_PAY 直播间成交
	ExternalAction qianchuan.ExternalAction `json:"external_action,omitempty"`
	// DeepExternalAction 深度转化目标
	// AD_CONVERT_TYPE_LIVE_PAY_ROI 支付ROI
	DeepExternalAction qianchuan.ExternalAction `json:"deep_external_action,omitempty"`
	// DeepBidType 深度出价方式
	DeepBidType qianchuan.DeepBidType `json:"deep_bid_type,omitempty"`
	// PricingType 出价方式，可选值:
	// OCPM OCPM 按照展示进行计费
	PricingType enum.PricingType `json:"pricing_type,omitempty"`
	// BudgetMode  预算类型，可选值:
	// BUDGET_MODE_DAY 日预算
	BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"`
}

DeliverySetting 投放设置

type DetailRequest added in v1.26.1 

type DetailRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 全域推广计划id
	AdID uint64 `json:"ad_id,omitempty"`
}

DetailRequest 获取全域推广计划详情 API Request

func (DetailRequest) Encode added in v1.26.1 

func (r DetailRequest) Encode() string

Encode implement GetRequest interface

type DetailResponse added in v1.26.1 

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

DetailResponse 获取全域推广计划详情 API Response

type Error added in v1.26.1 

type Error struct {
	// ObjectID 错误对象id
	ObjectID uint64 `json:"object_id,omitempty"`
	// ObjectType 错误对象类型
	ObjectType int `json:"object_type,omitempty"`
	// OptType 操作类型
	OptType int `json:"opt_type,omitempty"`
	// ErrorCode 错误码
	ErrorCode int `json:"error_code,omitempty"`
	// ErrorMessage 错误信息
	ErrorMessage string `json:"error_message,omitempty"`
	// Extra 额外信息
	Extra map[string]interface{} `json:"extra,omitempty"`
}

Error 错误信息

func (Error) Error added in v1.26.1 

func (e Error) Error() string

Error implements error interface

type ListFilter added in v1.26.1 

type ListFilter struct {
	// SmartBidType 投放方式 可选值:
	// SMART_BID_CONSERVATIVE 放量投放
	// SMART_BID_CUSTOM 控成本投放
	//  默认值: SMART_BID_CUSTOM
	SmartBidType enum.SmartBidType `json:"smart_bid_type,omitempty"`
}

ListFilter 过滤

type ListRequest 

type ListRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// StartTime 开始时间，格式 2021-04-05 00:00:00
	StartTime string `json:"start_time,omitempty"`
	// EndTime 结束时间，格式 2021-04-06 00:00:00
	EndTime string `json:"end_time,omitempty"`
	// MarketingGoal 按营销目标过滤，允许值
	// LIVE_PROM_GOODS：直播带货
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// Fields 需要查询的消耗指标，见返回参数
	Fields []string `json:"fields,omitempty"`
	// OrderType 排序方式，允许值：
	// ASC 升序（默认）
	// DESC 降序
	OrderType enum.OrderType `json:"order_type,omitempty"`
	// OrderField  排序字段，默认create_time，同时支持根据消耗指标排序
	// create_time
	// stat_cost
	// total_cost_per_pay_order_for_roi2
	// total_pay_order_count_for_roi2
	// total_pay_order_gmv_for_roi2
	// total_prepay_and_pay_order_roi2
	// total_prepay_order_count_for_roi2
	OrderField string `json:"order_field,omitempty"`
	// Page 页码，默认值：1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，允许值：10, 20, 50, 100, 200，默认值：10
	PageSize int `json:"page_size,omitempty"`
	// Filtering 过滤
	Filtering *ListFilter `json:"filtering,omitempty"`
}

ListRequest 获取全域推广列表 API Request

func (ListRequest) Encode 

func (r ListRequest) Encode() string

Encode implement GetRequest interface

type ListResponse 

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

ListResponse 获取全域推广列表 API Response

type ListResult 

type ListResult struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// AdList 全域推广列表
	AdList []Ad `json:"ad_list,omitempty"`
}

type Material added in v1.26.1 

type Material struct {
	// MaterialInfo 素材信息
	MaterialInfo *MaterialInfo `json:"material_info,omitempty"`
}

Material 素材

type MaterialDeleteRequest added in v1.26.1 

type MaterialDeleteRequest struct {
	// AdvertiserID 千川广告账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// MaterialIDs 素材id list
	// 注意：最多支持100个素材
	MaterialIDs []uint64 `json:"material_ids,omitempty"`
	// Titles 需要删除的title list
	// 注意：完全匹配，最多支持100个title
	Titles []string `json:"titles,omitempty"`
}

MaterialDeleteRequest 删除全域推广计划下素材 API Request

func (MaterialDeleteRequest) Encode added in v1.26.1 

func (r MaterialDeleteRequest) Encode() []byte

Encode implements PostRequest inteface

type MaterialGetFilter added in v1.26.1 

type MaterialGetFilter struct {
	// MaterialType 素材类型，可选值:
	// IMAGE 图片，图文
	// LIVE_ROOM 直播间画面
	// TITLE 标题
	// VIDEO 视频
	MaterialType string `json:"material_type,omitempty"`
	// VideoType  视频类型，仅material_type=VIDEO时支持，可选值:
	// ALL 全部
	// CUSTOM 自选投放视频
	// AUTO 智能优选视频
	VideoType string `json:"video_type,omitempty"`
	// MaterialStatus  投放状态，仅material_type=VIDEO/TITLE时支持，可选值:
	// DELIVERY_OK 投放中，默认
	// DELETED 已删除
	// ALL 全部
	MaterialStatus string `json:"material_status,omitempty"`
	// AnalysisType 素材评估，仅material_type=VIDEO时支持
	// 首发素材 FIRST_PUBLISH_MATERIAL
	// 优质素材 HIGH_QUALITY_MATERIAL
	// 低质素材 LOW_QUALITY_MATERIAL
	// 低效素材 INEFFICIENT_MATERIAL
	// 搬运素材 CARRY_MATERIAL
	// 同质化素材 SIMILAR_MATERIAL
	AnalysisType enum.MaterialProperty `json:"analysis_type,omitempty"`
	// SearchKeyword 搜索关键词，支持根据视频mid进行搜索
	// 注意：仅material_type=VIDEO时支持
	SearchKeyword string `json:"search_keyword,omitempty"`
}

MaterialGetFilter 过滤条件

type MaterialGetRequest added in v1.26.1 

type MaterialGetRequest struct {
	// Filtering 过滤条件
	Filtering *MaterialGetFilter `json:"filtering,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"`
}

MaterialGetRequest 获取全域推广计划下素材 API Request

func (MaterialGetRequest) Encode added in v1.26.1 

func (r MaterialGetRequest) Encode() string

Encode implements GetRequest interface

type MaterialGetResponse added in v1.26.1 

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

MaterialGetResponse 获取全域推广计划下素材 API Response

type MaterialGetResult added in v1.26.1 

type MaterialGetResult struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// AdMaterialInfos 素材列表
	AdMaterialInfos []Material `json:"ad_material_infos,omitempty"`
}

type MaterialInfo added in v1.26.1 

type MaterialInfo struct {
	// MaterialStatus 素材状态，可选值:
	// DELIVERY_OK 投放中
	// DELETED 已删除
	MaterialStatus string `json:"material_status,omitempty"`
	// AuditStatus 审核状态，可选值:
	// PASS 审核通过
	// REJECT 审核拒绝
	// IN_PROGRESS 审核中
	AuditStatus string `json:"audit_status,omitempty"`
	// IsDeleted 是否已删除
	IsDeleted bool `json:"is_deleted,omitempty"`
}

MaterialInfo 素材信息

type ProgrammaticCreativeMedia added in v1.26.1 

type ProgrammaticCreativeMedia struct {
	// VideoMaterial 视频信息
	VideoMaterial []VideoMaterial `json:"video_material,omitempty"`
	// TitleMaterial 标题信息
	// 注意：如果视频全部为抖音主页视频，不支持设置title
	TitleMaterial []TitleMaterial `json:"title_material,omitempty"`
	// BlockVideoMaterial 排除抖音主页视频列表
	BlockVideoMaterial []VideoMaterial `json:"block_video_material,omitempty"`
}

ProgrammaticCreativeMedia 程序化创意信息

type StatusUpdateRequest added in v1.26.1 

type StatusUpdateRequest struct {
	// AdvertiserID 千川广告账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdIDs 全域推广计划id
	// 注意：目前仅支持一个
	AdIDs []uint64 `json:"ad_ids,omitempty"`
	// OptStatus 更新推广计划状态，可选值:
	// DISABLE 暂停计划
	// ENABLE 启用计划
	OptStatus qianchuan.AdOptStatus `json:"opt_status,omitempty"`
}

StatusUpdateRequest 更改全域推广计划状态 API Request

func (StatusUpdateRequest) Encode added in v1.26.1 

func (r StatusUpdateRequest) Encode() []byte

Encode implements PostRequest interface

type StatusUpdateResponse added in v1.26.1 

type StatusUpdateResponse struct {
	model.BaseResponse
	Data struct {
		// Results 更新结果
		Results []StatusUpdateResult `json:"results,omitempty"`
	} `json:"data,omitempty"`
}

StatusUpdateResponse 编辑全域推广计划 API Response

type StatusUpdateResult added in v1.26.1 

type StatusUpdateResult struct {
	// AdID 计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// Flag 是否更新成功
	Flag bool `json:"flag,omitempty"`
	// Error 错误信息
	Error *Error `json:"error,omitempty"`
}

type TitleMaterial added in v1.26.1 

type TitleMaterial struct {
	// Title 标题
	Title string `json:"title,omitempty"`
}

TitleMaterial 标题信息

type UpdateRequest added in v1.26.1 

type UpdateRequest struct {
	// DeliverySetting 投放设置
	DeliverySetting *DeliverySetting `json:"delivery_setting,omitempty"`
	// CreativeSetting 创意设置
	CreativeSetting *CreativeSetting `json:"creative_setting,omitempty"`
	// ProgrammaticCreativeMediaList 程序化创意信息
	ProgrammaticCreativeMediaList []ProgrammaticCreativeMedia `json:"programmatic_creative_media_list,omitempty"`
	// AdvertiserID 千川广告账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 全域推广计划id
	AdID uint64 `json:"ad_id,omitempty"`
}

UpdateRequest 编辑全域推广计划 API Request

func (UpdateRequest) Encode added in v1.26.1 

func (r UpdateRequest) Encode() []byte

Encode implements PostRequest interface

type UpdateResponse added in v1.26.1 

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

UpdateResponse 编辑全域推广计划 API Response

type UpdateResult added in v1.26.1 

type UpdateResult struct {
	// ErrorList 错误信息
	ErrorList []Error `json:"error_list,omitempty"`
	// AdID 计划id
	AdID uint64 `json:"ad_id,omitempty"`
}

type VideoMaterial added in v1.26.1 

type VideoMaterial struct {
	// ImageMode 素材类型，支持视频
	// VIDEO_LARGE 横版视频
	// VIDEO_VERTICAL 竖版视频
	// 注意：当视频素材选择抖音号下视频时，image_mode必须传竖版视频
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// VideoID 视频ID，可通过【获取视频素材】接口获得视频素材id
	VideoID string `json:"video_id,omitempty"`
	// VideoCoverID 视频封面ID，可通过【获取图片素材】接口获得图片素材id
	VideoCoverID string `json:"video_cover_id,omitempty"`
	// AwemeItemID 抖音视频ID，可通过【获取抖音号下视频素材】接口获得视频id，使用抖音视频的时候默认忽略video_id
	AwemeItemID uint64 `json:"aweme_item_id,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.