aweme

package
v1.29.9 Latest Latest
Warning

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

 Go to latest Published: Dec 5, 2024 License: Apache-2.0 Imports: 7 Imported by: 1

Documentation

Overview

Package aweme 千川授权抖音号相关API models

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Audience added in v1.15.1 

type Audience struct {
	// AudienceMode 想吸引的观众类型，可选值:
	// ATUO: 系统智能推荐
	// CUSTOM: 自定义
	// FANS: 达人相似粉丝
	// LIVEFANS: 达人相似观众
	AudienceMode enum.AudienceMode `json:"audience_mode,omitempty"`
	// Gender 性别，可选值:
	// GENDER_FEMALE: 女性
	// GENDER_MALE: 男性
	// 若不传值，则默认为不限
	// 注意：仅想吸引的观众类型为“自定义”时，有效
	Gender enum.AudienceGender `json:"gender,omitempty"`
	// Age 年龄，允许值：若不传值，则默认为不限
	// AGE_BETWEEN_18_23：18-23岁、
	// AGE_BETWEEN_24_30：24-30岁、
	// AGE_BETWEEN_31_40：31-40岁、
	// AGE_BETWEEN_41_50：41-50岁
	// 注意：仅想吸引的观众类型为“自定义”时，有效
	Age enum.AudienceAge `json:"age,omitempty"`
	// ExcludeLimitedRegion 排除限运地区，允许值：
	// 0 ：否，默认值；1 ：是
	// 注意：
	// 1、当营销目标为VIDEO_PROM_GOODS时，audience_mode为“ATUO”&“FANS”时，有效
	// 2、当营销目标为LIVE_PROM_GOODS时，audience_mode为“ATUO”&“LIVEFANS”时，有效
	ExcludeLimitedRegion int `json:"exclude_limited_region,omitempty"`
	// District 地域定向类型，配合 city 字段使用，允许值：
	// 若不传值，则默认为不限
	// CITY ：省市
	// COUNTY ：区县
	// 注意：仅营销目标为VIDEO_PROM_GOODS且想吸引的观众类型为“自定义”时，有效
	District enum.District `json:"district,omitempty"`
	// City 具体定向的城市列表，当 district 为COUNTY、CITY为必填。
	// 省市的传法："city" : [12], "district" : "CITY"，不能超过200个省
	// 区县的传法："city" : [130102], "district" : "COUNTY"，不能超过100和区县
	// 注意：仅营销目标为VIDEO_PROM_GOODS且想吸引的观众类型为“自定义”时，有效
	City []uint64 `json:"city,omitempty"`
	// InterestCategories 兴趣类目词，可以通过【随心推投放-获取随心推兴趣标签】接口获取
	// 注意：仅营销目标为VIDEO_PROM_GOODS且想吸引的观众类型为“自定义”时，有效
	InterestCategories []uint64 `json:"interest_categories,omitempty"`
	// AuthorIDs 抖音达人ID列表，可通过【工具-抖音达人-查询抖音类目下的推荐达人】接口获取
	// 注意：限制20个
	// 仅想吸引的观众类型为“达人相似观众”和“达人相似粉丝”时，必填
	AuthorIDs []uint64 `json:"author_ids,omitempty"`
	// Behaviors 抖音用户行为类型 ，允许值：
	// 1、当吸引的观众类型为“达人相似观众”且营销目标为LIVE_PROM_GOODS时，允许值
	// ALL全部，默认
	// FOLLOWED_USER 关注过此人
	// LIVE_WATCH 观看过直播
	// GOODS_SHARE 下单过商品
	// 2、当吸引的观众类型为“达人相似粉丝”且营销目标为VIDEO_PROM_GOODS时，允许值
	// ALL全部，默认
	// FOLLOWED_USER 关注过达人
	// LIKED_USER 点赞过视频
	// GOODS_SHARE 下单过商品
	Behaviors []enum.Behavior `json:"behaviors,omitempty"`
	// AwemeFanAccounts 抖音达人ID列表
	AwemeFanAccounts []uint64 `json:"aweme_fan_accounts,omitempty"`
	// AwemeFanBehaviors 抖音用户行为类型
	AwemeFanBehaviors []enum.Behavior `json:"aweme_fan_behaviors,omitempty"`
}

Audience 定向设置

type AuditRecord added in v1.15.1 

type AuditRecord struct {
	// DetailDescList 建议内容列表
	DetailDescList []string `json:"detail_desc_list,omitempty"`
	// StatusAttachDesp 订单状态附加描述
	StatusAttachDesp string `json:"status_attach_desp,omitempty"`
}

AuditRecord 审核详细内容

type AuthorizedGetRequest 

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 

func (r AuthorizedGetRequest) Encode() string

Encode implement GetRequest interface

type AuthorizedGetResponse 

type AuthorizedGetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *AuthorizedGetResponseData `json:"data,omitempty"`
}

AuthorizedGetResponse 获取千川账户下已授权抖音号 API Response

type AuthorizedGetResponseData 

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

AuthorizedGetResponseData json返回值

type Aweme 

type Aweme struct {
	// ID 抖音id，用于创建计划，拉取抖音号视频素材时入参
	ID uint64 `json:"aweme_id,omitempty"`
	// Avatar 抖音头像
	Avatar string `json:"aweme_avatar,omitempty"`
	// ShowID 抖音号，即客户在手机端上看到的抖音号，若向客户披露抖音号请使用该字段
	ShowID string `json:"aweme_show_id,omitempty"`
	// Name 抖音号名称
	Name string `json:"aweme_name,omitempty"`
	// Status 抖音号带货状态，返回值：NORMAL 可以正常投放;ANCHOR_FORBID 带货口碑分过低，暂时无法创建计划;ANCHOR_REACH_UPPER_LIMIT_TODAY 带货分过低或暂无带货分，可以创建计划，但无法产生消耗，带货分恢复正常后可正常消耗
	Status enum.AwemeStatus `json:"aweme_status,omitempty"`
	// BindType 抖音号关系类型
	BindType []enum.AwemeBindType `json:"bind_type,omitempty"`
	// HasRoi2DeliveryLimit 该抖音号是否有全域推广计划投放，如果开启了投放，那么该抖音号不可以用来投放其他直播带货广告
	// 允许值：
	// true：存在全域推广计划投放
	// false：暂无全域推广计划投放
	HasRoi2DeliveryLimit bool `json:"has_roi2_delivery_limit,omitempty"`
	// HasRoi2GroupCreate 当前抖音号是否创建过全域推广计划
	// false：未创建过计划, 可以新建
	// true：已经创建过计划，不支持新建
	HasRoi2GroupCreate bool `json:"has_roi2_group_create,omitempty"`
	// HasShopPermission 是否有推商品全域推广权限
	HasShopPermission bool `json:"has_shop_permission,omitempty"`
	// HasLivePermission 是否有直播全域推广权限
	HasLivePermission bool `json:"has_live_permission,omitempty"`
	// CanControlUniprom 当前账户是该抖音号的官方巨量千川账户,对其他账户解除授权即可正常使用直播全域推广,是否需要解除授权
	CanControlUniprom bool `json:"can_control_uniprom,omitempty"`
	// CanApplyUniprom 抖音号是否可申请
	CanApplyUniprom bool `json:"can_apply_uniprom,omitempty"`
	// AnchorForbidden 抖音号是否禁用
	AnchorForbidden bool `json:"anchor_forbidden,omitempty"`
}

Aweme 抖音号

type Coupon added in v1.15.1 

type Coupon struct {
	// CouponAmount 券的总金额
	CouponAmount float64 `json:"coupon_amount,omitempty"`
	// CouponType 券类型。1表示满减券；4表示满赠券
	CouponType int `json:"coupon_type,omitempty"`
}

Coupon 优惠券信息

type DeliverySetting added in v1.15.1 

type DeliverySetting struct {
	// ExternalAction 优化目标
	// 当营销目标为直播带货时，允许值为：
	// AD_CONVERT_TYPE_LIVE_CLICK_PRODUCT_ACTION: 直播间商品点击
	// AD_CONVERT_TYPE_LIVE_COMMENT_ACTION: 直播间评论
	// AD_CONVERT_TYPE_LIVE_ENTER_ACTION: 进入直播间
	// AD_CONVERT_TYPE_LIVE_ROI: 支付ROI
	// AD_CONVERT_TYPE_LIVE_SUCCESSORDER_ACTION: 直播间下单
	// AD_CONVERT_TYPE_LIVE_SUCCESSORDER_PAY: 直播间成交
	// AD_CONVERT_TYPE_NEW_FOLLOW_ACTION: 直播间粉丝提升
	// 当营销目标为短视频带货时，允许值：
	// AD_CONVERT_TYPE_QC_FOLLOW_ACTION: 粉丝提升
	// AD_CONVERT_TYPE_QC_MUST_BUY: 点赞评论
	// AD_CONVERT_TYPE_SHOPPING: 商品购买
	// AD_CONVERT_TYPE_LIVE_ROI: 商品支付ROI
	ExternalAction qianchuan.ExternalAction `json:"external_action,omitempty"`
	// 期望曝光时长，允许值：
	// 当营销目标为VIDEO_PROM_GOODS时，支持2、6、12、24、72、120
	// 当营销目标为LIVE_PROM_GOODS时，支持0.5、1、1.5、2、2.5、3、3.5、4、4.5、5、5.5、6、12、24
	DeliveryTime float64 `json:"delivery_time,omitempty"`
	// BidMode 出价模式，可选值:
	// PRICING_ACTION: 按优化目标出价
	// PRICING_PLAY: 按播放量出价
	// 注意：
	// 1. 当营销目标为VIDEO_PROM_GOODS时，两者均支持；当视频为图文时，仅支持PRICING_ACTION
	// 2. 当营销目标为LIVE_PROM_GOODS时，仅支持PRICING_ACTION
	BidMode qianchuan.BidMode `json:"bid_mode,omitempty"`
	// BidType 出价类型，可选值:
	// AUTO_BID: 自动出价
	// MANUAL_BID: 手动出价
	// 注意：
	// 出价模式为“按优化目标出价”时，必填
	// 当营销目标为LIVE_PROM_GOODS&优化目标不是AD_CONVERT_TYPE_LIVE_ROI时，仅支持AUTO_BID
	// 当marketing_goal=VIDEO_PROM_GOODS&external_action=AD_CONVERT_TYPE_LIVE_ROI时，仅支持MANUAL_BID
	// 当marketing_goal=LIVE_PROM_GOODS&external_action=AD_CONVERT_TYPE_LIVE_ROI时，支持自动出价和手动出价
	BidType qianchuan.BidType `json:"bid_type,omitempty"`
	// CpaBid 手动出价金额，0.1～10000，不高于投放金额
	// 注意：仅出价方式为“手动出价”时，必填
	CpaBid float64 `json:"cpa_bid,omitempty"`
	// RoiGoal 支付ROI目标，最多支持两位小数，0.01～100
	// 注意：仅出价方式为“手动出价”且external_action=AD_CONVERT_TYPE_LIVE_ROI时必填
	RoiGoal float64 `json:"roi_goal,omitempty"`
	// LiveroomHeatMode 直播间加热方式，可选值:
	// BY_ROOM: 直接加热直播间
	// BY_VIDEO: 选择视频加热直播间
	// 注意：仅营销目标为LIVE_PROM_GOODS时，必填
	LiveroomHeatMode qianchuan.LiveroomHeatMode `json:"liveroom_heat_mode,omitempty"`
	// Amount 投放金额
	// 注意：1、 数值需为100-5000000之间的10的倍数
	Amount int64 `json:"amount,omitempty"`
	// PaymentAmount 实际支付金额
	PaymentAmount float64 `json:"payment_amount,omitempty"`
	// PayRoi 支付ROI目标，最多支持两位小数，0.01～100
	// 注意：仅出价方式为“手动出价”且external_action=AD_CONVERT_TYPE_LIVE_ROI时必填
	PayRoi float64 `json:"pay_roi,omitempty"`
}

DeliverySetting 投放设置

type EstimateProfit added in v1.15.1 

type EstimateProfit struct {
	// MinProfit 最小效果
	MinProfit float64 `json:"min_profit,omitempty"`
	// MaxProfit 最大效果
	MaxProfit float64 `json:"max_profit,omitempty"`
}

type EstimateProfitRequest added in v1.15.1 

type EstimateProfitRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// MarketingGoal 营销目标，可选值:
	// LIVE_PROM_GOODS: 直播间带货
	// VIDEO_PROM_GOODS: 短视频带货
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// DeliverySetting 投放设置
	DeliverySetting *DeliverySetting `json:"delivery_setting,omitempty"`
	// Audience 定向设置
	Audience *Audience `json:"audience,omitempty"`
}

EstimateProfitRequest 获取随心推投放效果预估 API Request

func (EstimateProfitRequest) Encode added in v1.15.1 

func (r EstimateProfitRequest) Encode() string

Encode implement GetRequest interface

type EstimateProfitResponse added in v1.15.1 

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

EstimateProfitResponse 获取随心推投放效果预估 API Response

type InterestActionInterestKeywordRequest added in v1.15.1 

type InterestActionInterestKeywordRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
}

InterestActionInterestKeywordRequest 获取随心推兴趣标签 API Request

func (*InterestActionInterestKeywordRequest) Encode added in v1.15.1 

func (r *InterestActionInterestKeywordRequest) Encode() string

Encode implement GetRequest interface

type InterestActionInterestKeywordResponse added in v1.15.1 

type InterestActionInterestKeywordResponse struct {
	model.BaseResponse
	Data struct {
		List []InterestKeyword `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

InterestActionInterestKeywordResponse 获取随心推兴趣标签 API Response

type InterestKeyword added in v1.15.1 

type InterestKeyword struct {
	// ID 兴趣ID，详见【附录-随心推兴趣标签】
	ID uint64 `json:"id,omitempty"`
	// Name 兴趣名称
	Name string `json:"name,omitempty"`
}

type Order added in v1.15.1 

type Order struct {
	// OrderID 订单id
	OrderID uint64 `json:"order_id,omitempty"`
	// AdID 广告计划id，获取订单数据时使用
	AdID uint64 `json:"ad_id,omitempty"`
	// MarketingGoal 营销目标
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// Status 订单状态 可选值:
	// AUDIT: 审核中
	// BOOK: 未开播
	// CREATING: 已支付，计划创建中
	// DELIVERY_OK: 投放中
	// FAILED: 计划创建失败
	// FINISHED: 投放完成
	// FROZEN: 投放终止
	// OFFLINE_AUDIT: 审核不通过
	// OVER: 投放结束
	// TIMEOUT: 未支付超过15分钟，订单关闭
	// UNPAID: 未支付
	// UNPAIDCANCEL: 未支付取消订单
	Status qianchuan.OrderStatus `json:"status,omitempty"`
	// OrderCreateTime 订单创建时间
	OrderCreateTime string `json:"order_create_time,omitempty"`
	// AwemeInfo 素材作者信息
	AwemeInfo *Aweme `json:"aweme_info,omitempty"`
	// ProductInfo 商品信息
	Product *product.Product `json:"product,omitempty"`
	// RoomInfo 直播间信息
	RoomInfo *live.Room `json:"room_info,omitempty"`
	// VideoInfo 视频信息
	VideoInfo *Video `json:"video_info,omitempty"`
	// DeliverySetting 投放设置
	DeliverySetting *DeliverySetting `json:"delivery_setting,omitempty"`
	// Audience 人群定向
	Audience *Audience `json:"audience,omitempty"`
	// AuditRecord 建议详细内容
	AuditRecord *AuditRecord `json:"audit_record,omitempty"`
	// CouponInfo 优惠券信息
	CouponInfo *Coupon `json:"coupon_info,omitempty"`
}

Order 订单详情

type OrderBudgetAddRequest added in v1.20.7 

type OrderBudgetAddRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// OrderID 需要追加预算的订单id
	OrderID uint64 `json:"order_id,omitempty"`
	// RenewalBudget 追加的预算
	RenewalBudget float64 `json:"renewal_budget,omitempty"`
	// RenewvalDeliverySeconds 延长的投放时间
	// 短视频订单，0-7天（步进单位为1天）
	// 直播订单，0-24小时（步进单位为0.5小时）
	RenewvalDeliverySeconds float64 `json:"renewval_delivery_seconds,omitempty"`
}

OrderBudgetAddRequest 追加随心推订单预算 API Request

func (OrderBudgetAddRequest) Encode added in v1.20.7 

func (r OrderBudgetAddRequest) Encode() []byte

Encode implement PostRequest interface

type OrderCreateRequest added in v1.15.1 

type OrderCreateRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// MarketingGoal 营销目标，可选值:
	// LIVE_PROM_GOODS: 直播间带货
	// VIDEO_PROM_GOODS: 短视频带货
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// AwemeID 推广对象的抖音id，可通过【查询可推广抖音号列表】接口获取名下可推广抖音号
	// 1. 视频加热和视频加热直播间：传递视频作者的抖音uid
	// 2. 直接加热直播间：传递主播的抖音uid
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// AwemeItemID 音视频ID，可通过【随心推投放-获取随心推可投视频】接口获得视频， 视频加热和视频加热直播间：传递视频ID；
	// 1.当marketing_goal= VIDEO_PROM_GOODS时 必填
	// 2.当marketing_goal= LIVE_PROM_GOODS &liveroom_heat_mode= BY_VIDEO 时必填，不支持图文视频
	// 注意：当为图文视频时，仅支持短视频投放-商品购买/商品支付ROI场景
	AwemeItemID uint64 `json:"aweme_item_id,omitempty"`
	// DeliverySetting 投放设置
	DeliverySetting *DeliverySetting `json:"delivery_setting,omitempty"`
	// Audience 定向设置
	Audience *Audience `json:"audience,omitempty"`
}

OrderCreateRequest 创建随心推订单 API Request

func (OrderCreateRequest) Encode added in v1.15.1 

func (r OrderCreateRequest) Encode() []byte

Encode implement PostRequest interface

type OrderCreateResponse added in v1.15.1 

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

OrderCreateResponse 创建随心推订单 API Response

type OrderDetailGetRequest added in v1.15.1 

type OrderDetailGetRequest struct {
	// AdvertiserID 千川广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// OrderID 千川小店订单id
	OrderID uint64 `json:"order_id,omitempty"`
}

OrderDetailGetRequest 获取随心推订单详情 API Request

func (OrderDetailGetRequest) Encode added in v1.15.1 

func (r OrderDetailGetRequest) Encode() string

Encode implement GetRequest interface

type OrderDetailGetResponse added in v1.15.1 

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

OrderDetailGetResponse 获取随心推订单详情 API Response

type OrderGetFilter added in v1.15.1 

type OrderGetFilter struct {
	// MarketingGoal 按营销目标过滤，允许值：
	// VIDEO_PROM_GOODS：短视频带货
	// LIVE_PROM_GOODS：直播带货
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// Status 小店订单状态 可选值:
	// AUDIT 审核中
	// BOOK 未开播
	// CREATING 已支付，计划创建中
	// DELIVERY_OK 投放中
	// FAILED 计划创建失败
	// FINISHED 投放完成
	// FROZEN 投放终止
	// OFFLINE_AUDIT 审核不通过
	// OVER 投放结束
	// TIMEOUT 未支付超过15分钟，订单关闭
	// UNPAID 未支付
	// UNPAIDCANCEL 未支付取消订单
	Status qianchuan.OrderStatus `json:"status,omitempty"`
}

type OrderGetRequest added in v1.15.1 

type OrderGetRequest struct {
	// Filtering
	Filtering *OrderGetFilter `json:"filtering,omitempty"`
	// OrderField 排序字段。默认升序 可选值:
	// order_create_time 按照创建时间排序
	// pay_order_amount 按照成交金额排序
	// prepay_and_pay_order_roi 按照支付roi排序
	// stat_cost 按照消耗排序
	OrderField string `json:"order_field,omitempty"`
	// OrderCreateStartTime 计划创建开始时间，格式："yyyy-mm-dd"
	OrderCreateStartTime string `json:"order_create_start_time,omitempty"`
	// OrderCreateEndTime 计划创建结束时间，与order_create_start_date搭配使用，格式："yyyy-mm-dd"，时间跨度不能超过180天
	OrderCreateEndTime string `json:"order_create_end_time,omitempty"`
	// AdvertiserID 千川广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Cursor 页码，默认值：0
	Cursor int `json:"cursor,omitempty"`
	// Count 页面大小，允许值：10, 20, 50，默认值：10
	Count int `json:"count,omitempty"`
}

OrderGetRequest 获取随心推订单列表 API Request

func (OrderGetRequest) Encode added in v1.15.1 

func (r OrderGetRequest) Encode() string

Encode implement GetRequest interface

type OrderGetResponse added in v1.15.1 

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

OrderGetResponse 获取随心推订单列表 API Response

type OrderGetResult added in v1.15.1 

type OrderGetResult struct {
	// PageInfo
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// List
	List []Order `json:"list,omitempty"`
	// FailList 获取失败的订单id列表
	FailList []uint64 `json:"fail_list,omitempty"`
}

type OrderQuota added in v1.15.1 

type OrderQuota struct {
	// UsedQuota 使用中订单数
	UsedQuota int64 `json:"used_quota,omitempty"`
	// SumQuota 订单配额
	SumQuota int64 `json:"sum_quota,omitempty"`
	// MaxCost 最高月消耗
	MaxCost float64 `json:"max_cost,omitempty"`
	// QuotaGear 当前所在配额档位：1,2,3,4,5,6
	QuotaGear int `json:"quota_gear,omitempty"`
	// TerminateQuotaInfo 终止订单配额信息
	TerminateQuotaInfo *TerminateQuotaInfo `json:"terminate_quota_info,omitempty"`
}

OrderQuota 随心推使用中订单配额信息

type OrderQuotaGetRequest added in v1.15.1 

type OrderQuotaGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
}

OrderQuotaGetRequest 查询随心推使用中订单配额信息 API Request

func (OrderQuotaGetRequest) Encode added in v1.15.1 

func (r OrderQuotaGetRequest) Encode() string

Encode implement GetRequest interface

type OrderQuotaGetResponse added in v1.15.1 

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

OrderQuotaGetResponse 查询随心推使用中订单配额信息 API Response

type OrderSuggestDeliveryTimeGetRequest added in v1.20.7 

type OrderSuggestDeliveryTimeGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// OrderID 需要追加预算的订单id
	OrderID uint64 `json:"order_id,omitempty"`
	// AddAmount 追加的预算
	AddAmount float64 `json:"add_amount,omitempty"`
}

OrderSuggestDeliveryTimeGetRequest 获取建议延长时长 API Request

func (OrderSuggestDeliveryTimeGetRequest) Encode added in v1.20.7 

func (r OrderSuggestDeliveryTimeGetRequest) Encode() string

Encode implement GetRequest interface

type OrderSuggestDeliveryTimeGetResponse added in v1.20.7 

type OrderSuggestDeliveryTimeGetResponse struct {
	model.BaseResponse
	Data struct {
		// SuggestDeliveryTime 建议追加投放时长
		// 短视频：xx天
		// 直播：xx小时
		SuggestDeliveryTime float64 `json:"suggest_delivery_time,omitempty"`
	} `json:"data,omitempty"`
}

OrderSuggestDeliveryTimeGetResponse 获取建议延长时长 API Response

type OrderTerminateRequest added in v1.15.1 

type OrderTerminateRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// OrderIDs 需要终止的订单id
	// 注意：目前仅支持一个
	OrderIDs []uint64 `json:"order_ids,omitempty"`
}

OrderTerminateRequest 终止随心推订单 API Request

func (OrderTerminateRequest) Encode added in v1.15.1 

func (r OrderTerminateRequest) Encode() []byte

Encode implement PostRequest interface

type OrderTerminateResponse added in v1.15.1 

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

OrderTerminateResponse 终止随心推订单 API Response

type OrderTerminateResult added in v1.15.1 

type OrderTerminateResult struct {
	// OrderIDs 终止成功的订单ID
	OrderIDs []uint64 `json:"order_ids,omitempty"`
	// TerminateQuotaInfo 终止订单配额信息
	TerminateQuotaInfo *TerminateQuotaInfo `json:"terminate_quota_info,omitempty"`
}

type ProductAvailableGetRequest added in v1.19.5 

type ProductAvailableGetRequest struct {
	// 千川广告主账户id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AwemeID 需要拉取商品列表的抖音id
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// Cursor 页码游标值，第一次拉取，无需入参
	Cursor int `json:"cursor,omitempty"`
}

ProductAvailableGetRequest 达人获取可投商品列表 API Request

func (ProductAvailableGetRequest) Encode added in v1.19.5 

func (r ProductAvailableGetRequest) Encode() string

Encode implement GetRequest interface

type ProductAvailableGetResponse added in v1.19.5 

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

type ProductAvailableGetResult added in v1.19.5 

type ProductAvailableGetResult struct {
	// ProductList 商品列表
	ProductList []product.Product `json:"product_list,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

type SuggestBidRequest added in v1.15.1 

type SuggestBidRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// DeliverySetting 投放设置
	DeliverySetting *DeliverySetting `json:"delivery_setting,omitempty"`
	// Audience 定向设置
	Audience *Audience `json:"audience,omitempty"`
}

SuggestBidRequest 获取随心推短视频建议出价 API Request

func (SuggestBidRequest) Encode added in v1.15.1 

func (r SuggestBidRequest) Encode() string

Encode implement GetRequest interface

type SuggestBidResponse added in v1.15.1 

type SuggestBidResponse struct {
	model.BaseResponse
	Data struct {
		// SuggestBid 建议出价
		SuggestBid float64 `json:"suggest_bid,omitempty"`
	} `json:"data,omitempty"`
}

SuggestBidResponse 获取随心推短视频建议出价 API Response

type SuggestRoiGoalRequest added in v1.15.1 

type SuggestRoiGoalRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AwemeID 推广对象的抖音id，可通过【查询可推广抖音号列表】接口获取名下可推广抖音号
	// 视频加热直播间：传递视频作者的抖音uid
	// 直接加热直播间：传递主播的抖音uid
	AwemeID uint64 `json:"aweme_id,omitempty"`
}

SuggestRoiGoalRequest 获取随心推ROI建议出价 API Request

func (SuggestRoiGoalRequest) Encode added in v1.15.1 

func (r SuggestRoiGoalRequest) Encode() string

Encode implement GetRequest interface

type SuggestRoiGoalResponse added in v1.15.1 

type SuggestRoiGoalResponse struct {
	model.BaseResponse
	Data struct {
		// EcpRoiGoal roi建议出价
		EcpRoiGoal float64 `json:"ecp_roi_goal,omitempty"`
	} `json:"data,omitempty"`
}

SuggestRoiGoalResponse 获取随心推ROI建议出价 API Response

type TerminateQuotaInfo added in v1.15.1 

type TerminateQuotaInfo struct {
	// TerminateQuotaUsed 已终止订单数
	TerminateQuotaUsed int64 `json:"terminate_quota_used,omitempty"`
	// TerminateQuotaSum 终止订单配额
	TerminateQuotaSum int64 `json:"terminate_quota_sum,omitempty"`
}

TerminateQuotaInfo 终止订单配额信息

type Video added in v1.15.1 

type Video struct {
	// AwemeItemID 视频id
	AwemeItemID uint64 `json:"aweme_item_id,omitempty"`
	// AwemiItemTitle 视频标题
	AwemeItemTitle string `json:"aweme_item_title,omitempty"`
	// AwemeItemCover 视频封面
	AwemeItemCover string `json:"aweme_item_cover,omitempty"`
	// ItemType 视频类型
	// 1：图文视频
	// 0：普通视频
	ItemType int `json:"item_type,omitempty"`
	// VideoCoverURL 视频封面图片url
	VideoCoverURL string `json:"video_cover_url,omitempty"`
	// Width 视频宽度
	Width int `json:"width,omitempty"`
	// Height 视频高度
	Height int `json:"height,omitempty"`
	// URL 视频地址，链接1小时过期
	URL string `json:"url,omitempty"`
	// Duration 视频时长
	Duration float64 `json:"duration,omitempty"`
	// Title 抖音中的视频标题
	Title string `json:"title,omitempty"`
	// IsRecommend 是否推荐 :
	// 0: 不推荐
	// 1: 推荐
	IsRecommend int `json:"is_recommend,omitempty"`
	// ImgURL 图文预览链接
	ImgURL string `json:"img_url,omitempty"`
	// IsImg 是否图文视频
	// 1：是
	// 0：否
	IsImg int `json:"is_img,omitempty"`
	// 是否AI生成
	// false：不是AI生成
	// true：AI生成
	IsAiCreate bool `json:"is_ai_create,omitempty"`
}

Video 视频信息

type VideoGetRequest added in v1.15.1 

type VideoGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AwemeID 需要拉取视频的抖音号uid
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// MarketingGoal 营销目标，可选值:
	// LIVE_PROM_GOODS: 直播间带货
	// VIDEO_PROM_GOODS: 短视频带货
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// Cursor 页码游标值，第一次拉取，无需入参
	Cursor int `json:"cursor,omitempty"`
	// Count 页面大小，限制1-20，默认值：10
	Count int `json:"count,omitempty"`
}

VideoGetRequest 获取随心推可投视频列表 API Request

func (VideoGetRequest) Encode added in v1.15.1 

func (r VideoGetRequest) Encode() string

Encode implement GetRequest interface

type VideoGetResponse added in v1.15.1 

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

VideoGetResponse 获取随心推可投视频列表 API Response

type VideoGetResult added in v1.15.1 

type VideoGetResult struct {
	PageInfo  *model.PageInfo `json:"page_info,omitempty"`
	VideoList []Video         `json:"video_list,omitempty"`
}

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.