adgroup

Documentation

Overview

Package adgroup 商品单元

Index

• type AddAdgroupRequest
  • func (r AddAdgroupRequest) Url() string
• type AddAdgroupResponse
• type Adgroup
• type DeleteAdgroupRequest
  • func (r DeleteAdgroupRequest) Url() string
• type DeleteAdgroupResponse
• type GetAdgroupFeedRequest
  • func (r GetAdgroupFeedRequest) Url() string
• type GetAdgroupFeedResponse
• type Ocpc
• type ProductSetRule
• type UnitProducts
• type UpdateAdgroupRequest
  • func (r UpdateAdgroupRequest) Url() string
• type UpdateAdgroupResponse

Types

type AddAdgroupRequest

type AddAdgroupRequest struct {
	// AdgroupFeedTypes 新增推广单元物料
	AdgroupFeedTypes []Adgroup `json:"adgroupFeedTypes"`
}

AddAdgroupRequest 添加单元 API Request

func (AddAdgroupRequest) Url

func (r AddAdgroupRequest) Url() string

type AddAdgroupResponse

type AddAdgroupResponse struct {
	Data []Adgroup `json:"data,omitempty"`
}

AddAdgroupResponse 添加单元 API Response

type Adgroup

type Adgroup struct {
	// AdgroupId 推广单元ID
	AdgroupId uint64 `json:"adgroupFeedId,omitempty"`
	// AdgroupName 推广单元名称
	AdgroupName string `json:"adgroupFeedName,omitempty"`
	// CampaignId 推广计划ID
	CampaignId uint64 `json:"campaignFeedId,omitempty"`
	// Pause 暂停/启用推广单元
	Pause *bool `json:"pause,omitempty"`
	// Status 推广单元状态
	// 取值范围：枚举值，列表如下
	// 0 - 有效
	// 1 - 暂停推广
	// 2 - 推广计划暂停推广
	// 3 - 直播结束后暂停
	// 4 - 转化追踪异常暂停
	// 5 - 基木鱼落地页暂停
	Status int `json:"status,omitempty"`
	// Audience 此字段为对象类型，对象内每个字段表示一种定向设置，所有字段的值均为String类型。每个单元可以设置0至多个定向设置。全部定向字段列表和详细说明请参考原生定向设置列表。
	Audience map[string]string `json:"audience,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"`
	// FTypes 投放范围
	// 取值范围：枚举值，列表如下
	// 1 - 自定义类-百度信息流
	// 2 - 自定义类-贴吧
	// 4 - 百青藤（小程序营销目标-微信小游戏不支持）
	// 8 - 自定义类-好看视频（好看视频流量目前在实验阶段，仅限已开通该流量的账户使用）
	// 64 - 自定义类-百度小说
	// 空数组（[]）表示默认。默认、自定义、百青藤不可以同时选择
	FTypes []int `json:"ftypes,omitempty"`
	// BidType 优化目标和付费模式; 1 - 点击（CPC）(应用推广营销目标下不支持，不影响存量物料投放); 2 - 曝光（CPM）(应用推广营销目标下不支持，不影响存量物料投放); 3 - 转化（oCPC/oCPM）; 5 - eCPC
	BidType int `json:"bidtype,omitempty"`
	// Ocpc oCPC信息; 本字段只有当bidtype=3有效。请参考oCPC设置对象;
	Ocpc *Ocpc `json:"ocpc,omitempty"`
	// AtpFeedId 定向包ID; 定向包的优先级高于audience字段设置的定向信息。已绑定定向包单元解除绑定需传0
	AtpFeedId *int64 `json:"atpFeedId,omitempty"`
	// DeliveryType 投放场景
	// 默认值：0
	// 取值范围：枚举值，列表如下
	// 0 - 不限
	// 1 - 开屏
	// 2 - 激励
	// 4 - 原生
	// 开屏/激励/原生选项仅在投放范围选择百青藤时有效
	DeliveryType []int `json:"deliveryType,omitempty"`
	// UneffecientAdgroup 低效单元标识
	// 取值范围：枚举值，列表如下
	// 1 - 低效单元
	// 0 - 非低效单元
	UneffecientAdgroup int `json:"uneffecientAdgroup,omitempty"`
	// ProductSetId 商品组id；仅商品目录营销目标单元可用，新增时与unitProducts至少填写一个，与unitProducts同时使用时unitProducts优先生效。参照商品组管理。
	ProductSetId int64 `json:"productSetId,omitempty"`
	// UnitProducts 单元商品筛选设置；仅商品目录营销目标单元可用，新增时与productSetId至少填写一个，与productSetId同时使用时unitProducts优先生效
	UnitProducts []UnitProducts `json:"unitProducts,omitempty"`
	// FtypeSelection 流量来源
	// 取值范围：枚举值，列表如下
	// 1 - 单元单独设置流量
	// 2 - 使用计划流量设置
	// 使用计划流量设置时会忽略传参中的ftypes，优先使用计划流量
	// 单元单独设置流量时单元流量需要为计划流量的子集
	// 出价上移名单使用字段，名单外使用无效。
	FtypeSelection int `json:"ftypeSelection,omitempty"`
	// BidSource 出价来源
	// 取值范围：枚举值，列表如下
	// 1 - 单元单独设置出价
	// 2 - 使用计划出价
	// 使用计划出价时，不需要传bid、bidtype以及oCPC中的出价相关字段，优先使用计划出价设置
	// 出价上移名单使用字段，名单外使用无效。
	BidSource int `json:"bidSource,omitempty"`
	// UrlType 落地页类型
	// 取值范围：枚举值，列表如下
	// 1 - 普通落地页
	// 2 - 百度小程序
	// 3 - 直播间
	// 使用计划出价后，落地页类型可以直接使用urlType字段，优先级高于oCPC字段
	UrlType int `json:"urlType,omitempty"`
	// MiniProgram 小程序信息
	// 该字段是json字符串类型
	// 使用计划出价后，落地页类型为百度小程序时miniProgramType、appKey、pagePath可以直接使用miniProgram，优先级高于oCPC字段
	MiniProgram string `json:"miniProgram,omitempty"`
	// BroadCastInfo 直播间信息
	// 该字段是json字符串类型
	// 使用计划出价后，落地页类型为直播间时broadCastMode、anchorId、roomId可以直接使用broadCastInfo，优先级高于oCPC字段
	BroadCastInfo string `json:"broadCastInfo,omitempty"`
	// Url 落地页
	// 使用计划出价后，落地页可以直接使用url字段，优先级高于oCPC字段；
	// 营销目标为小程序，子类型为微信小游戏时，仅支持基木鱼落地页
	Url string `json:"url,omitempty"`
	// UnitOcpxStatus 	单元学习状态
	// 取值范围：枚举值，列表如下
	// 1 - 正在学习
	// 2 - 学习成功
	// 3 - 学习失败
	UnitOcpxStatus int `json:"unitOcpxStatus,omitempty"`
	// CreateAtp 是否创建定向包
	// 默认为false
	// 取值范围：枚举值，列表如下
	// true - 创建定向包
	// false - 不创建定向包
	CreateAtp *bool `json:"createAtp,omitempty"`
	// AtpName 定向包名称
	AtpName string `json:"atpName,omitempty"`
	// AtpDesc 定向包描述
	AtpDesc string `json:"atpDesc,omitempty"`
}

Adgroup 推广单元

type DeleteAdgroupRequest

type DeleteAdgroupRequest struct {
	// AdgroupFeedIds 推广单元ID
	AdgroupFeedIds []uint64 `json:"adgroupFeedIds"`
}

DeleteAdgroupRequest 删除单元 API Request

func (DeleteAdgroupRequest) Url

func (r DeleteAdgroupRequest) Url() string

type DeleteAdgroupResponse

type DeleteAdgroupResponse struct {
	Data []Adgroup `json:"data,omitempty"`
}

type GetAdgroupFeedRequest

type GetAdgroupFeedRequest struct {
	// AdgroupFeedFields 待查询的单元属性
	// 取值范围：枚举值，列表如下
	// adgroupFeedId - 推广单元ID
	// campaignFeedId - 推广计划ID
	// adgroupFeedName - 推广单元名称
	// pause - 暂停/启用推广单元
	// status - 推广单元状态
	// bid - 出价
	// ftypes - 投放范围
	// bidtype - 优化目标和付费模式
	// ocpc - oCPC信息
	// atpFeedId - 定向包ID
	// addtime - 添加时间
	// modtime - 修改时间
	// deliveryType - 投放场景
	// unefficientAdgroup - 低效单元
	// productSetId - 商品组ID（仅商品推广）
	// ftypeSelection - 是否使用计划流量
	// bidSource - 是否使用计划出价
	// unitOcpxStatus - 单元学习状态
	// atpName - 定向包名称
	// 注意：查询定向设置时，不应传"audience"，而是传原生定向设置列表中需要的字段名称。
	// 某些定向信息内容可能较长（如意图词），请按照实际需要查询，以提高响应速度
	AdgroupFeedFields []string `json:"adgroupFeedFields,omitempty"`
	// Ids 待查询计划/单元ID集合
	// 集合长度限制：[0, 100]
	Ids []uint64 `json:"ids,omitempty"`
	// IdType ID类型; 1 - 计划类型; 2 - 单元类型
	IdType int `json:"idType,omitempty"`
}

GetAdgroupFeedRequest 查询推广单元 API Request

func (GetAdgroupFeedRequest) Url

func (r GetAdgroupFeedRequest) Url() string

type GetAdgroupFeedResponse

type GetAdgroupFeedResponse struct {
	Data []Adgroup `json:"data,omitempty"`
}

GetAdgroupFeedResponse 查询推广单元 API Response

type Ocpc

type Ocpc struct {
	// AppTransId 转化ID; 营销目标为应用推广Android的单元，仅能绑定应用操作系统为Android的转化追踪；营销目标为应用推广iOS的单元，仅能绑定应用操作系统为iOS的转化追踪。
	AppTransId uint64 `json:"appTransId,omitempty"`
	// TransFrom 接入方式; 1 - 应用API 2 - 基木鱼营销页; 4 - API激活; 5 - 网页JS布码; 7 - 线索API; 8 - 咨询工具授权; 13 - 应用SDK
	TransFrom int `json:"transFrom,omitempty"`
	// OcpcBid 目标转化出价; 取值范围：[0.3，999.99] 单位为元
	OcpcBid float64 `json:"ocpcBid,omitempty"`
	// LpUrl 推广URL; 必须以“http”或“https”开头
	LpUrl string `json:"lpUrl,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 - 登录（注册激活后登录）
	// 57 - 店铺调起
	// 67 - 微信调起按钮点击
	// 68 - 粉丝关注成功
	// 71 - 应用调起
	// 72 - 聊到相关业务（小流量）
	// 73 - 回访-电话接通（小流量）
	// 56 - 到店（小流量）
	// 74 - 回访-信息确认（小流量）
	// 75 - 回访-发现意向（小流量）
	// 76 - 回访-高潜成交（小流量）
	// 77 - 回访-成单客户（小流量）
	// 79 - 微信加粉成功（小流量）
	// 80 - 直播间成单（小流量）
	// 82 - 直播间观看（小流量）
	// 83 - 直播间商品按钮点击（小流量）
	// 84 - 直播间停留（小流量）
	// 85 - 直播间评论（小流量）
	// 86 - 直播间打赏（小流量）
	// 87 - 直播间购物袋点击（小流量）
	// 90 - 商品支付成功
	// 93 - 付费阅读(小流量)
	// 118 - 付费观剧（小流量）
	// 119 - 关键行为（小流量）
	// 小程序-微信小游戏仅支持登录和付费转化目标。
	// 对于小流量字段仅部分名单客户可用，如果要申请可通过客服和销售同学反馈
	// 更新推广单元时不允许修改该字段
	TransType int `json:"transType,omitempty"`
	// OptimizeDeepTrans 优化深度转化;
	OptimizeDeepTrans *bool `json:"optimizeDeepTrans,omitempty"`
	// DeepOcpcBid 深度转化出价
	DeepOcpcBid float64 `json:"deepOcpcBid,omitempty"`
	// DeepTransType 深度转化类型
	// 取值范围：枚举值，列表如下
	// 10 - 购买成功
	// 18 - 留线索（小流量）
	// 25 - 注册（小流量）
	// 26 - 付费（小流量）
	// 27 - 客户自定义（小流量）
	// 28 - 次日留存（小流量）
	// 42 - 授信（小流量）
	// 45 - 商品下单成功
	// 53 - 订单核对成功
	// 54 - 收货成功
	// 72 - 聊到相关业务（小流量）
	// 73 - 回访-电话接通（小流量）
	// 56 - 到店（小流量）
	// 74 - 回访-信息确认（小流量）
	// 75 - 回访-发现意向（小流量）
	// 76 - 回访-高潜成交（小流量）
	// 77 - 回访-成单客户（小流量）
	// 79 - 微信加粉成功（小流量）
	// optimizeDeepTrans=true时必填。对于小流量字段仅部分名单客户可用，如果要申请可通过客服和销售同学反馈
	// 更新推广单元时不允许修改该字段
	DeepTransType int `json:"deepTransType,omitempty"`
	// UrlType 落地页类型
	// 取值范围：枚举值，列表如下
	// 1 - 普通落地页
	// 2 - 百度小程序
	// 3 - 直播间
	UrlType int `json:"urlType,omitempty"`
	// UseRoi 使用ROI优化
	// 不能与optimizeDeepTrans同时使用。目前仅支持部分目标转化，列表如下
	// 14 - 订单提交成功
	// 26 - 付费
	UseRoi *bool `json:"useRoi,omitempty"`
	// RoiRatio ROI转化率
	// 取值范围：[0.00, 100.00]
	// useRoi=true时必填，保留两位小数
	RoiRatio *float64 `json:"roiRatio,omitempty"`
	// MiniProgramType 百度小程序类型
	// 取值范围：枚举值，列表如下
	// 1 - 小程序
	// 2 - 小游戏
	// 落地页类型为百度小程序时必填
	MiniProgramType int `json:"miniProgramType,omitempty"`
	// AppKey 百度小程序appkey
	// 取值范围：[1, 32]
	// 落地页类型为百度小程序时必填
	AppKey string `json:"appKey,omitempty"`
	// PagePath 百度小程序页面路径
	// 落地页类型为百度小程序时必填
	PagePath string `json:"pagePath,omitempty"`
	// BroadCastMode 直播间投放模式
	//     取值范围：枚举值，列表如下
	// 1 - 默认
	// 2 - 仅直播时投放
	// 3 - 连续投放
	// 落地页为直播间时必填
	BroadCastMode int `json:"broadCastMode,omitempty"`
	// AnchorId 主播连续投放时的主播ID
	// 直播间投放模式为连续投放时必填
	AnchorId int64 `json:"anchorId,omitempty"`
	// TransTypeAttribute 付费次数优化
	// 取值范围：枚举值，列表如下
	// 1 - 表示按照付费人数优化
	// 2 - 表示按照付费次数优化
	// 该字段必须搭配transType=26使用，否则会报错，更新单元时该字段不可修改
	// 该功能目前正在小流量测试，如需使用请向营销顾问申请
	TransTypeAttribute int `json:"transTypeAttribute,omitempty"`
}

Ocpc oCPC设置对象

type ProductSetRule

type ProductSetRule struct {
	// Field 字段名；参照查询商品库字段返回的字段value
	Field string `json:"field,omitempty"`
	// Operator 操作符。
	// 取值范围：枚举值，列表如下
	// EQUAL - 等于
	// NOT_EQUAL - 不等于
	// CONTAIN - 包含
	// NOT_CONTAIN - 不包含
	// GREATER - 大于
	// LESS - 小于
	// GREATER_EQUAL - 大于等于
	// LESS_EQUAL - 小于等于
	Operator string `json:"operator,omitempty"`
	// Values 操作值。 操作字段值，多个操作值使用'|'分隔，多个之间取并集，最多15个值
	Values []string `json:"values,omitempty"`
}

ProductSetRule 商品组规则

type UnitProducts

type UnitProducts struct {
	// CatalogId 商品目录id；商品目录管理请登录百度商品中心
	CatalogId uint64 `json:"catalogId,omitempty"`
	// RuleProducts 商品组规则
	RuleProducts []ProductSetRule `json:"ruleProducts,omitempty"`
}

UnitProducts 单元商品筛选设置

type UpdateAdgroupRequest

type UpdateAdgroupRequest struct {
	// AdgroupTypes 更新推广单元字段;集合长度限制：[1, 5000]
	AdgroupFeedTypes []Adgroup `json:"adgroupFeedTypes,omitempty"`
}

UpdateAdgroupRequest 更新推广单元 API Request

func (UpdateAdgroupRequest) Url

func (r UpdateAdgroupRequest) Url() string

type UpdateAdgroupResponse

type UpdateAdgroupResponse struct {
	Data []Adgroup `json:"data,omitempty"`
}

UpdateAdgroupResponse 更新推广单元API Response