campaign

package
v1.3.4 Latest Latest
Warning

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

 Go to latest Published: Apr 28, 2024 License: Apache-2.0 Imports: 2 Imported by: 1

Documentation

Overview

Package campaign 计划

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddCampaignRequest added in v1.2.5 

type AddCampaignRequest struct {
	// CampaignTypes 新增推广计划物料;集合长度限制：[1, 100]
	CampaignTypes []Campaign `json:"campaignFeedTypes,omitempty"`
}

AddCampaignRequest 添加计划 API Request

func (AddCampaignRequest) Url added in v1.2.5 

func (r AddCampaignRequest) Url() string

type AddCampaignResponse added in v1.2.5 

type AddCampaignResponse struct {
	Data []Campaign `json:"data,omitempty"`
}

AddCampaignResponse 添加计划 API Response

type AppInfo added in v1.2.7 

type AppInfo struct {
	// AppName 应用名称，最多20个字符。
	AppName string `json:"appName,omitempty"`
	// ApkName 应用包名，仅Android有效，最多1024个字符
	ApkName string `json:"apkName,omitempty"`
	// AppUrl 推广应用链接。仅支持IOS app，链接必须为iTunes链接。
	AppUrl string `json:"appUrl,omitempty"`
	// DocId 仅支持Android app
	DocId uint64 `json:"docId,omitempty"`
	// ChannelId 仅支持Android app, 请登录移动开发者平台查看推广APP对应的channelId信息
	ChannelId uint64 `json:"channelId,omitempty"`
	// ChannelPackage 渠道包名称
	// 渠道包名称，仅Android有效
	ChannelPackage string `json:"channelPackage,omitempty"`
	// AppStatus 应用审核状态
	// 仅Android有效
	// 取值范围：枚举值，列表如下
	// 0 - 审核拒绝
	// 1 - 审核通过
	// 2 - 审核中
	AppStatus int `json:"appStatus,omitempty"`
	// OpenUrl 应用商店直投链接，选填，须以market://details?或apps://ProductDetail/开头；或者"0"表示关闭,“1”表示开启. 更新时不填表示清除已有链接
	OpenUrl string `json:"openUrl,omitempty"`
	// DownloadType 下载方式。0: 直接下载 1：落地页下载
	DownloadType int `json:"downloadType,omitempty"`
}

AppInfo 推广app信息

type AppInfoShadow added in v1.2.7 

type AppInfoShadow struct {
	// AppInfo 计划的影子APP信息
	AppInfo *AppInfo `json:"appInfo,omitempty"`
	// Status 计划的影子状态
	Status int `json:"status,omitempty"`
}

AppInfoShadow 应用推广营销目标下的影子计划

type Campaign 

type Campaign struct {
	// CampaignId 计划ID
	CampaignId uint64 `json:"campaignFeedId,omitempty"`
	// CampaignName 计划名称。长度限制最大100个字节，1个中文及中文符号按2个字节计算
	CampaignName string `json:"campaignFeedName,omitempty"`
	// Subject 推广对象
	// 取值范围：枚举值，列表如下
	// 1 - 网站链接
	// 2 - 应用下载（IOS）
	// 3 - 应用下载（Android）
	// 4 - 小程序（需要开通小流量名单，目前仅支持微信小游戏）
	// 7 - 电商店铺
	// 8 - 销售线索
	// 9- 应用调起
	Subject int `json:"subject,omitempty"`
	// AppInfo 推广app信息。subject=1时，该字段无效。对象定义参考下文推广app信息
	AppInfo *AppInfo `json:"appInfo,omitempty"`
	// Budget 推广计划预算。默认为0,表示不限预算。正常取值范围为[50 - 9999999.99]
	Budget float64 `json:"budget,omitempty"`
	// StartTime 推广开始日期。默认为null，表示长期投放。格式示例：'2016-12-15'不能早于当天的日期
	StartTime string `json:"starttime,omitempty"`
	// EndTime 推广结束日期。默认为null，表示长期投放。例如：'2016-12-18'不能早于开始日期
	EndTime string `json:"endtime,omitempty"`
	// Schedule 暂停时段设置，对象定义参考下文暂停时段设置
	Schedule []model.Schedule `json:"schedule,omitempty"`
	// Pause 是否暂停推广。默认为false。true：推广计划暂停 false：推广计划启用
	Pause *bool `json:"pause,omitempty"`
	// Status 推广计划状态。
	// 取值范围：枚举值，列表如下
	// 0 - 有效
	// 1 - 处于暂停时段
	// 2 - 暂停推广
	// 3 - 推广计划预算不足
	// 4 - 账户待激活
	// 11 - 账户预算不足
	// 20 - 账户余额为零
	// 23 - 被禁推
	// 24 - app已下线
	// 25 - 应用审核中
	// 26 - RTA计划暂停
	// 27 - 计划绑定的新游预约包预约过期
	// 28 - 项目暂停
	Status int `json:"status,omitempty"`
	// BsType 物料类型
	// 1：普通计划 3：闪投计划 7：原生RTA 注：不支持修改
	BsType int `json:"bstype,omitempty"`
	// CampaignType 信息流计划类型。
	// 1： 普通模式 4：放量模式
	CampaignType int `json:"campaignType,omitempty"`
	// AddTime 添加时间
	AddTime string `json:"addtime,omitempty"`
	// EshopType 交易所在平台。
	// 取值范围：枚举值，列表如下
	// 1 - 基木鱼
	// 3-1 - 淘宝店铺（含天猫）
	// 3-2 - 京东店铺
	// 3-3 - 拼多多店铺
	// 3-4 - 苏宁店铺
	// 4 - 百度健康商城
	// 仅推广对象为电商店铺时需传该字段
	// 交易平台为基木鱼（度小店）、百度健康商城需要使用电商广告投放接口进行新建投放
	EshopType string `json:"eshopType,omitempty"`
	// Shadow 应用推广营销目标下的影子计划
	Shadow *AppInfoShadow `json:"shadow,omitempty"`
	// BudgetOfflineTime 当天计划预算下线最近一次的时间
	BudgetOfflineTime string `json:"budgetOfflineTime,omitempty"`
	// RtaStatus RTA状态
	// 取值范围：枚举值，列表如下
	// 1 - 已开通
	// 0 - 未开通
	RtaStatus int `json:"rtaStatus,omitempty"`
	// FtTypes 流量类型
	// 取值范围：枚举值，列表如下
	// 1 - 自定义类-百度信息流
	// 2 - 自定义类-贴吧
	// 4 - 百青藤（小程序营销目标-微信小游戏不支持）
	// 8 - 自定义类-好看视频（好看视频流量目前在实验阶段，仅限已开通该流量的账户使用）
	// 64 - 自定义类-百度小说
	// 空数组（[]）表示默认。默认、自定义、百青藤不可以同时选择，出价上移名单使用字段，名单外使用无效。
	FtTypes []int `json:"ftTypes,omitempty"`
	// BidType 出价方式
	// 默认值：1
	// 取值范围：枚举值，列表如下
	// 1 - 点击（CPC）
	// 2 - 曝光（CPM）
	// 3 - 转化（oCPC/oCPM） 出价上移名单使用字段，名单外使用无效。
	BidType int `json:"bidType,omitempty"`
	// Bid 出价，根据优化目标不同，具体含义如下：
	// CPC：单次点击出价
	// CPM：千次展现出价
	// oCPC：第一阶段单次点击出价
	// 出价为元，可精确到分。取值范围如下
	// 当优化目标选择CPC/oCPC，投放流量选择优选流量或者自定义流量且包含百青藤以外的流量时：[0.3,999.99]
	// 当优化目标选择CPC/oCPC，投放流量选择自定义流量且仅选择百青藤流量时：[0.2,999.99]
	// 当优化目标选择CPM时：[2.0,9999.99]
	// 出价上移名单使用字段，名单外使用无效。
	Bid float64 `json:"bid,omitempty"`
	// Ocpc oCPC相关设置
	// 本字段只有当bidtype=3有效，出价上移名单使用字段，名单外使用无效。
	Ocpc *OcpcModel `json:"ocpc,omitempty"`
	// UneffecientCampaign 低效计划标识
	// 取值范围：枚举值，列表如下
	// 1 - 低效计划
	// 0 - 非低效计划
	UneffecientCampaign int `json:"uneffecientCampaign,omitempty"`
	// BmcUserId 商品中心用户ID
	// 请使用“商品中心账号列表” 接口获取用户ID
	BmcUserId uint64 `json:"bmcUserId,omitempty"`
	// CategoryId 	商品目录ID产品分组ID,根据catalogSource字段决定
	// 请使用“产品组/商品目录列表” 接口获取商品目录ID
	CategoryId uint64 `json:"categoryId,omitempty"`
	// CatalogSource 	商品目录来源
	// 取值范围：枚举值，列表如下
	// 1 - 商品中心(BMC)
	// 2 - 基木鱼内容中心
	CatalogSource int `json:"catalogSource,omitempty"`
	// ProductType 产品库类型
	// 取值范围：枚举值，列表如下
	// 1 - 小说库
	// 2 - 短剧库
	// 3 - 长视频库
	// 4 - 课程中心
	// 5 - 医美项目
	// 6 - 零售库
	// 7 - 资讯库
	// 10001 - 内容中心
	// 关联产品库时必填
	ProductType int `json:"productType,omitempty"`
	// ProjectFeedId 项目ID
	// 传0表示解绑
	ProjectFeedId *uint64 `json:"projectFeedId,omitempty"`
	// InheritAscriptionType 继承归属类型
	// 取值范围：枚举值，列表如下
	// 1 - 当前账户
	// 2 - 同客户中心
	// 3 - 当前账户内的计划
	// 4 - 同客户中心的计划
	InheritAscriptionType int `json:"inheritAscriptionType,omitempty"`
	// InheritUserIds 继承优质计划账户ID集合
	// 当inheritAscriptionType为1时，只能传当前账户ID
	// 当inheritAscriptionType为2时需要传同客户中心的账户ID，数量限制为100
	InheritUserIds []uint64 `json:"inheritUserIds,omitempty"`
	// InheritCampaignInfos 继承计划信息集合
	// 当inheritAscriptionType为3时，只能传当前账户下的计划，计划数量限制为100个
	// 当inheritAscriptionType为4时需要传同客户中心的账户ID，单个账户下的计划数量限制为100个
	InheritCampaignInfos []InheritCampaignInfo `json:"inheritCampaignInfos,omitempty"`
	// CampaignOcpxStatus 计划学习状态
	// 取值范围：枚举值，列表如下
	// 1 - 正在学习
	// 2 - 学习成功
	// 3 - 学习失败
	CampaignOcpxStatus int `json:"campaignOcpxStatus,omitempty"`
	// UseLiftBudget 是否开启一键起量
	// 取值范围：枚举值，列表如下
	// 0 - 不开启
	// 1 - 开启
	UseLiftBudget *int `json:"useLiftBudget,omitempty"`
	// LiftBudget 起量预算
	// 起量预算最小值设置需要为出价10倍或计划预算的20%，最大值不能超过计划预算
	LiftBudget float64 `json:"liftBudget,omitempty"`
	// LiftStatus 起量状态
	// 取值范围：枚举值，列表如下
	// 0 - 未开启起量预算
	// 1 - 起量中
	// 2 - 起量完成
	LiftStatus int `json:"liftStatus,omitempty"`
	// DeliveryType 投放场景
	// 取值范围：枚举值，列表如下
	// 0 - 不限
	// 1 - 开屏
	// 2 - 激励
	// 4 - 原生
	// 开屏/激励/原生仅在投放范围选择百青藤时有效
	DeliveryType []int `json:"deliveryType,omitempty"`
	// AppSubType 应用推广子类型
	// 取值范围：枚举值，列表如下
	// 0 - 应用下载
	// 1 - 新游预约
	// 2 - 应用调起
	AppSubType *int `json:"appSubType,omitempty"`
	// MiniProgramType 小程序子类型
	// 取值范围：枚举值，列表如下
	// 1 - 百度小程序
	// 3 - 微信小程序
	// 4 - 微信小游戏
	MiniProgramType *int `json:"miniProgramType,omitempty"`
	// BidMode 出价模式
	// 取值范围：枚举值，列表如下
	// 1 - 目标转化成本
	BidMode int `json:"bidMode,omitempty"`
	// ProductIds 产品ID
	// 计划加入项目后，在项目上关联的产品ID
	ProductIds string `json:"productIds,omitempty"`
}

Campaign 计划对象

type CampaignFeedFilter 

type CampaignFeedFilter struct {
	// BsType 计划类型
	//     取值范围：枚举值，列表如下
	// 1 - 普通计划
	// 3 - 商品计划
	// 7 - 原生RTA
	// 不填返回全部
	BsType []int `json:"bstype,omitempty"`
}

CampaignFeedFilter 计划查询过滤条件

type CampaignIdName added in v1.2.7 

type CampaignIdName struct {
	// CampaignId 计划ID
	CampaignId uint64 `json:"campaignId,omitempty"`
	// CampaignName 计划名称
	CampaignName string `json:"campaignName,omitempty"`
}

type DeleteCampaignRequest added in v1.2.5 

type DeleteCampaignRequest struct {
	// CampaignIds 计划ID
	CampaignIds []uint64 `json:"campaignFeedIds,omitempty"`
}

DeleteCampaignRequest 删除计划 API Request

func (DeleteCampaignRequest) Url added in v1.2.5 

func (r DeleteCampaignRequest) Url() string

type DeleteCampaignResponse added in v1.2.7 

type DeleteCampaignResponse struct {
	Data []Campaign `json:"data,omitempty"`
}

DeleteCampaignResponse 删除计划 API Response

type GetCampaignFeedRequest 

type GetCampaignFeedRequest struct {
	// CampaignFeedFields 需要查询的计划属性
	// 取值范围：枚举值，列表如下
	// campaignFeedId - 信息流计划Id
	// campaignFeedName - 信息流计划名称
	// subject - 营销目标
	// appinfo - 推广app信息
	// budget - 推广计划预算
	// starttime - 推广开始时间
	// endtime - 推广结束时间
	// schedule - 推广计划暂停时段
	// pause - 计划启停
	// status - 推广计划状态
	// bstype - 物料类型
	// campaignType - 计划类型
	// addtime - 添加时间
	// eshopType - 交易所在平台
	// shadow - 计划影子的APP信息
	// budgetOfflineTime - 当天计划预算下线最近一次的时间
	// rtaStatus - 是否开通RTA
	// bid - 出价
	// bidtype - 出价方式
	// ftypes - 投放范围
	// ocpc - oCPC信息
	// unefficientCampaign - 低效计划
	// campaignOcpxStatus - 计划学习状态
	// inheritAscriptionType - 继承归属
	// inheritUserids - 继承优质计划账户id集合
	// inheritCampaignInfos - 继承优质计划的计划信息集合
	// bmcUserId - 商品中心用户ID
	// catalogId - 商品目录ID
	// productType - 产品库类型
	// projectFeedId - 项目ID
	// useLiftBudget - 是否开启一键起量
	// liftBudget - 起量预算
	// liftStatus - 起量状态
	// deliveryType - 投放场景
	// appSubType - 应用推广子类型
	// miniProgramType - 小程序子类型
	// bidMode - 出价模式
	// productIds - 产品ID
	CampaignFeedFields []string `json:"campaignFeedFields,omitempty"`
	// CampaignFeedIds 查询推广计划ID集合
	// 集合长度限制：[0, 100]
	// 输入空返回整个账户的计划ID
	CampaignFeedIds []uint64 `json:"campaignFeedIds,omitempty"`
	// CampaignFeedFilter 计划查询过滤条件
	CampaignFeedFilter *CampaignFeedFilter `json:"campaignFeedFilter,omitempty"`
}

GetCampaignFeedRequest 查询计划 API Request

func (GetCampaignFeedRequest) Url 

func (r GetCampaignFeedRequest) Url() string

type GetCampaignFeedResponse added in v1.0.4 

type GetCampaignFeedResponse struct {
	Data []Campaign `json:"data,omitempty"`
}

GetCampaignFeedResponse 查询计划 API Response

type GetJsKpAppListRequest added in v1.2.7 

type GetJsKpAppListRequest struct {
}

GetJsKpAppListRequest 查询APP信息 API Request

func (GetJsKpAppListRequest) Url added in v1.2.7 

func (r GetJsKpAppListRequest) Url() string

type GetJsKpAppListResponse added in v1.2.7 

type GetJsKpAppListResponse struct {
	Data []AppInfo `json:"data,omitempty"`
}

GetJsKpAppListResponse 查询APP信息 API Response

type InheritCampaignInfo added in v1.2.7 

type InheritCampaignInfo struct {
	// UserId 账户ID
	UserId uint64 `json:"userId,omitempty"`
	// Campaigns 继承的计划信息集合
	Campaigns []CampaignIdName `json:"campaigns,omitempty"`
}

InheritCampaignInfo 继承计划信息集合

type OcpcModel added in v1.2.7 

type OcpcModel struct {
	// OcpcBid 目标转化出价
	// 取值范围：[0.1, 99999.99]
	// 单位为元
	OcpcBid float64 `json:"ocpcBid,omitempty"`
	// TransType 目标转化
	// 取值范围：枚举值，列表如下
	// 1 - 咨询按钮点击
	// 2 - 电话按钮点击
	// 3 - 表单提交成功
	// 4 - 激活
	// 5 - 表单按钮点击
	// 6 - 下载（预约）按钮点击（小流量）
	// 10 - 购买成功
	// 14 - 订单提交成功
	// 17 - 三句话咨询
	// 18 - 留线索
	// 19 - 一句话咨询
	// 20 - 关键页面浏览
	// 25 - 注册（小流量）
	// 26 - 付费（小流量）
	// 30 - 电话拨通
	// 35 - 微信复制按钮点击（小流量）
	// 41 - 申请（小流量）
	// 42 - 授信（小流量）
	// 45 - 商品下单成功
	// 46 - 加入购物车
	// 47 - 商品收藏
	// 48 - 商品详情页到达
	// 49 - 登录（注册激活后登录）
	// 56 - 到店（小流量）
	// 57 - 店铺调起
	// 67 - 微信调起按钮点击
	// 68 - 粉丝关注成功
	// 71 - 应用调起
	// 72 - 聊到相关业务（小流量）
	// 73 - 回访-电话接通（小流量）
	// 74 - 回访-信息确认（小流量）
	// 75 - 回访-发现意向（小流量）
	// 76 - 回访-高潜成交（小流量）
	// 77 - 回访-成单客户（小流量）
	// 79 - 微信加粉成功（小流量）
	// 80 - 直播间成单（小流量）
	// 82 - 直播间观看（小流量）
	// 83 - 直播间商品按钮点击（小流量）
	// 84 - 直播间停留（小流量）
	// 85 - 直播间评论（小流量）
	// 86 - 直播间打赏（小流量）
	// 87 - 直播间购物袋点击（小流量）
	// 90 - 商品支付成功
	// 93 - 付费阅读(小流量)
	// 118 - 付费观剧（小流量）
	// 119 - 关键行为（小流量）
	// 小程序-微信小游戏仅支持登录和付费转化目标。
	// 对于小流量字段仅部分名单客户可用，如果要申请可通过客服和销售同学反馈
	// 更新推广单元时不允许修改该字段
	// 计划选择网站链接营销目标后，无法选择应用推广的转化目标
	TransType int `json:"transType,omitempty"`
	// TransFrom 接入方式
	// 取值范围：枚举值，列表如下
	// 1 - 应用API
	// 2 - 基木鱼营销页
	// 4 - API激活
	// 5 - 网页JS布码
	// 7 - 线索API
	// 8 - 咨询工具授权
	// 13 - 应用SDK
	// 25 - 百度健康商城
	// 30 - 百度小程序导入
	TransFrom int `json:"transFrom,omitempty"`
	// AppTransId 转化追踪ID
	// 营销目标为应用推广Android的单元，仅能绑定应用操作系统为Android的转化追踪；
	// 营销目标为应用推广iOS的单元，仅能绑定应用操作系统为iOS的转化追踪
	AppTransId uint64 `json:"appTransId,omitempty"`
	// DeepOcpcBid 深度转化出价
	// 取值范围：[0.4, 99999.99]
	// 单位为元，取值需要大于ocpcBid，optimizeDeepTrans=true时必填
	DeepOcpcBid float64 `json:"deepOcpcBid,omitempty"`
	// DeepTransType 深度转化类型
	// 取值范围：枚举值，列表如下
	// 10 - 购买成功
	// 18 - 留线索（小流量）
	// 25 - 注册（小流量）
	// 26 - 付费（小流量）
	// 27 - 客户自定义（小流量）
	// 28 - 次日留存（小流量）
	// 42 - 授信（小流量）
	// 45 - 商品下单成功
	// 53 - 订单核对成功
	// 54 - 收货成功
	// 56 - 到店（小流量）
	// 72 - 聊到相关业务（小流量）
	// 73 - 回访-电话接通（小流量）
	// 74 - 回访-信息确认（小流量）
	// 75 - 回访-发现意向（小流量）
	// 76 - 回访-高潜成交（小流量）
	// 77 - 回访-成单客户（小流量）
	// 79 - 微信加粉成功（小流量）
	// optimizeDeepTrans=true时必填。对于小流量字段仅部分名单客户可用，如果要申请可通过客服和销售同学反馈
	// 更新推广单元时不允许修改该字段
	DeepTransType int `json:"deepTransType,omitempty"`
	// UseRoi 使用ROI优化
	// 默认值：false
	// 不能与optimizeDeepTrans同时使用。目前仅支持部分目标转化，列表如下
	// 14 - 订单提交成功
	// 26 - 付费
	UseRoi *bool `json:"useRoi,omitempty"`
	// RoiRatio ROI转化率
	// 取值范围：[0.00, 100.00]
	// useRoi=true时必填，保留两位小数
	RoiRatio float64 `json:"roiRatio,omitempty"`
	// TransTypeAttribute 付费次数优化
	// 默认值：1
	// 取值范围：枚举值，列表如下
	// 1 - 表示按照付费人数优化
	// 2 - 表示按照付费次数优化
	// 该字段必须搭配transType=26使用，否则会报错，更新单元时该字段不可修改
	// 该功能目前正在小流量测试，如需使用请向营销顾问申请
	TransTypeAttribute int `json:"transTypeAttribute,omitempty"`
	// OptimizeDeepTrans 优化深度转化
	// 默认值：false
	// 仅当appTransId对应的转化追踪具有可选的深度转化类型时有效
	OptimizeDeepTrans *bool `json:"optimizeDeepTrans,omitempty"`
	// MiniProgramType 小程序子类型
	// 取值范围：枚举值，列表如下4 - 微信小游戏（需要开通小流量名单）
	MiniProgramType int `json:"miniProgramType,omitempty"`
}

OcpcModel oCPC相关设置

type UpdateCampaignRequest added in v1.2.5 

type UpdateCampaignRequest struct {
	// CampaignTypes 更新推广计划字段;集合长度限制：[1, 100]
	CampaignTypes []Campaign `json:"campaignFeedTypes,omitempty"`
}

UpdateCampaignRequest 更新计划 API Request

func (UpdateCampaignRequest) Url added in v1.2.5 

func (r UpdateCampaignRequest) Url() string

type UpdateCampaignResponse added in v1.2.5 

type UpdateCampaignResponse struct {
	Data []Campaign `json:"data,omitempty"`
}

UpdateCampaignResponse 更新计划 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.