ocpc

package
v1.4.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionCbRequest

type ActionCbRequest struct {
	// AKey 双方加密密钥,业务端创建转化时自动生成,同一广告主 akey 唯一
	// 监测 URL 签名:替换通配符后的完整监测 URL(不包含&sign=)+akey 进行标准 32 位 md5,生成签名值,在监测 URL 后添加&sign=签名值;Callback_URL签名:替换通配符后的完整回调URL(不包含&sign=)+ akey 进行标准32位md5,生成签名值,在回调URL后添加&sign=签名值,在百度投放后台获取。
	Akey string `json:"akey,omitempty"`
	// AType 必填,标识用户的转化事件
	// 1. 如您采用【方式一:使用百度提供的转化回调地址】,回调地址已给出a_type={{ATYPE}},替换{{ATYPE}}即可;
	// 2. 如您采用【方式二:自主拼接转化回调地址】,需要您自行拼接a_type参数
	// orders:付费
	// retain_1day:次日留存
	// user_defined:客户自定义
	// ec_buy:商品下单成功
	// deep_page_access:关键页面浏览
	// credit_granting: 授信
	// deeplink:应用调起
	// retain_2day:2日留存
	// retain_3day:3日留存
	// retain_4day:4日留存
	// retain_5day:5日留存
	// retain_6day:6日留存
	// retain_7day:7日留存
	// retain_14day:14日留存
	// pay_to_read:付费阅读
	// enter_bookstore_read:进入书城阅读
	// add_to_desktop:添加至桌面
	// log_in:登录
	// order_submit_success:订单提交成功
	// pay_to_watch:付费观剧
	// key_action:关键行为
	// derived_event:衍生事件
	AType enum.AType `json:"a_type,omitempty"`
	// AValue     必填,标识转化事件的金额信息
	// 1. 如您采用【方式一:使用百度提供的转化回调地址】,回调地址已给出a_type={{AVALUE}},替换{{AVALUE}}即可;
	// 2. 如您采用【方式二:自主拼接转化回调地址】,需要您自行拼接a_value参数
	// 转化类型为“orders:付费”时,此字段定义为“付费金额-单位(分)”。例:转化金额为12.3元,a_value=1230
	// ※注意:①单位是(分);②无需回传转化金额时,a_value数值填写为“0”即可,即a_value=0
	AValue  int64        `json:"a_value,omitempty"`
	ActType enum.ActType `json:"act_type,omitempty"`
	// ATime 用户转化事件发生的具体时间, unix时间戳(精确到秒)
	ATime int64 `json:"a_time,omitempty"`
	// ExtInfo 必填,广告编码信息
	// 1. 如您采用【方式一:使用百度提供的转化回调地址】,回调地址已给出ext_info=xxxx,直接回调即可;
	// 2. 如您采用【方式二:自主拼接转化回调地址】,需要您自行拼接ext_info参数
	// ext_info部分场景较长,建议至少预留3kb存储空间,回调需完整,使用时避免字符串截断
	// callType=v2 用户使用
	ExtInfo string `json:"ext_info,omitempty"`
	// CallbackUrl 效果数据回传URL
	// 由百度 server 端调用监测 URL 时直接传输给广告主,产生转化时广告主替换转化相关参数(a_type、a_value)后生成签名进行回调,callback_url 中的 s,o,ext_info 字段由 baidu 公司 server 负责处理。callType=v2 的用户可以不拼接 s,o参数
	CallbackUrl string `json:"callback_url,omitempty"`
	// CbJoinType 必填,转化数据归因类型,用于辅助百度优化投放效果
	// 例如,使用oaid匹配用户信息成功后,回传百度转化时,回调url增加&join_type=oaid标识该条转化数据使用oaid归因成功
	// · IMEI(通过IMEI_MD5归因成功)
	// · OAID(通过OAID或OAID_MD5归因成功)
	// · ANDROID_ID(通过ANDROID_ID或ANDROID_ID_MD5归因成功)
	// · IP(通过IP和系统信息(UA、OS_VERSION、MODEL)归因成功)
	// · IDFA(通过IDFA归因成功)
	// · CAID(通过CAID归因成功)
	// · MAC(通过MAC或MAC_MD5归因成功)
	// · PAID(通过PAID归因成功,灰度使用,可咨询您的百度SEM顾问如何申请)
	CbJoinType string `json:"cb_join_type,omitempty"`
	// CbIdfa IOS设备标识:原值
	CbIdfa string `json:"cb_idfa,omitempty"`
	// CbImei Android设备标识:原值32
	CbImei string `json:"cb_imei,omitempty"`
	// CbImeiMd5 Android 设备标识
	// Android 设备标识:编码方式:标准32 位 md5 当无 IMEI 传递时为空(此处 imei 使用从客户端获取的原始值进行 md5 加密,不需要做大小写转换)例:imei[10bc955ac2a675d3]imei_md5[f703b39228c8c5cf8069051d86a20747]
	CbImeiMd5 string `json:"cb_imei_md5,omitempty"`
	// CbOaid Android设备标识:原值
	CbOaid string `json:"cb_oaid,omitempty"`
	// CbAndroidId Android设备标识:原值32位小写MD5
	CbAndroidId string `json:"cb_android_id,omitempty"`
	// CbAndroidMd5 Android 设备标识; Android 设备标识:标准 32 位 md5当无 android id 时传递时为 null
	CbAndroidIdMd5 string `json:"cb_android_id_md5,omitempty"`
	// CbEventTime 发生转化时间(精确到毫秒)
	CbEventTime int64 `json:"cb_event_time,omitempty"`
	// OrderType 订单类型
	OrderType string `json:"order_type,omitempty"`
	// PayAmount 付费金额
	PayAmount int64 `json:"pay_amount,omitempty"`
	// OrderId 订单 id
	OrderId string `json:"order_id,omitempty"`
	// ActionType 行为类型
	// 可传多组,逗号分隔,和 action_value 一一对应
	// 1:广告观看(IPU);
	// 2:ARPU;
	// 3:eCPM 均值;
	// 4:通过关卡数;
	// 5:提现次数;
	// 6:使用时长;
	// 7:eCPM 最值;
	// 8:24h ARPU 门槛;
	// 9:预估 LTV 7;
	// 10:预估 LTV all;
	// 0:其他;
	ActionType []int `json:"action_type,omitempty"`
	// ActionValue 行为数值
	// 可传多组,逗号分隔,和 action_type 一一对应
	// action_type 对应的指标门槛值,如:ipu=5则传5
	// ※注意:eCPM和ARPU单位为分
	ActionValue []int64 `json:"action_value,omitempty"`
	// ActionTs 事件实际发生的时间, 时间戳(秒级别)
	ActionTs int64 `json:"action_ts,omitempty"`
	// IsGaConvert 是否关键行为转化
	// 是否把当前的回传作为关键行为转化
	// 1:关键行为,0:衍生行为
	IsGaConvert *int `json:"is_ga_convert,omitempty"`
	// Depth 行为深度
	//     关键行为定义的深度;模型学习其排序结果,不学习其绝对值,辅助样本区分。
	// 可取值为 1-100 之间整数,如 30、50
	Depth int `json:"depth,omitempty"`
}

ActionCbRequest 转化追踪回调 请求

func (ActionCbRequest) Sign

func (r ActionCbRequest) Sign() string

func (ActionCbRequest) Url

func (r ActionCbRequest) Url() string

type ConversionType

type ConversionType struct {
	// LogidUrl logidUrl为带有&bd_vid=xxx的落地页url地址,只有在百度搜索广告里点击进入的落地页url,才会带有&bd_vid,如有相关疑问,可参考文档进行排查
	LogidUrl string `json:"logidUrl"`
	// NewType 转化类型,每次选择一个类型回传,模型可用的转化类型请以推广后台新建转化追踪披露的转化类型为准
	NewType int `json:"newType"`
	// DeviceType 0代表安卓;1代表IOS;2代表其他
	DeviceType int `json:"deviceType,omitempty"`
	// DeviceId 安卓:IMEI 号取;md5 sum 摘要;IOS:IDFA 号原值
	DeviceId string `json:"deviceId,omitempty"`
	// IsConvert 是否发生转化(0或1);0:未发生转化;1:发生转化; 默认为1
	IsConvert *int `json:"isConvert,omitempty"`
	// ConvertTime unix时间戳(精确到秒);转化类型为46时必填
	ConvertTime int64 `json:"convertTime,omitempty"`
	// ConvertValue 转化金额(单位分)
	ConvertValue int64 `json:"convertValue,omitempty"`
	// Confidence 置信度,0-100数字
	Confidence int `json:"confidence,omitempty"`
	// ExtInfo 点击&曝光原始信息,媒体侧进行数据拼接时使用
	ExtInfo string `json:"extInfo,omitempty"`
	// TheaterId 剧场id,广告主短剧剧场id
	TheaterId string `json:"theaterId,omitempty"`
	// TheaterShortPlayId 短剧id,广告主剧场下短剧的唯一id
	TheaterShortPlayId string `json:"theaterShortPlayId,omitempty"`
	// TheaterUserId 剧场内用户注册id,广告主剧场下的用户唯一标识
	TheaterUserId string `json:"theaterUserId,omitempty"`
	// OuterEventId 用户自定义的行为 id 标识,若上报有重复且需要去重,请填写该id,系统会根据该ID进行去重。最大值 255 字节
	OuterEventId string `json:"outerEventId,omitempty"`
	// OuterEventType 外部事件类型:当前需求有两类取值。quality_points_add 表示质量分累加。 custom_dedup 表示自定义去重。
	OuterEventType string `json:"outerEventType,omitempty"`
	// AttributeSource (转化来源:百度(0),自然流量(1),竞媒(2))
	AttributeSource int `json:"attributeSource,omitempty"`
	// InteractionsType (归因请求方式,点击(1), 播放(2), 关注(3), 分享(4), 点赞(5), 曝光(6)不传使用1,默认为点击归因
	InteractionsType int `json:"interactionsType,omitempty"`
}

ConversionType 回转转化数据

type InvalidConversionType

type InvalidConversionType struct {
	// LogidUrl logidUrl为带有&bd_vid=xxx的落地页url地址,只有在百度搜索广告里点击进入的落地页url,才会带有&bd_vid,如有相关疑问,可参考文档进行排查
	LogidUrl string `json:"logidUrl"`
	// ConvertType 转化类型,每次选择一个类型回传,模型可用的转化类型请以推广后台新建转化追踪披露的转化类型为准
	ConvertType int `json:"convertType"`
	// ConvertTime unix时间戳(精确到秒);转化类型为46时必填
	ConvertTime int64 `json:"convertTime"`
	// Ip 无效转化的IP地址
	Ip string `json:"ip,omitempty"`
	// Confidence 置信度,0-100数字
	Confidence int `json:"confidence,omitempty"`
	// InvalidReason 无效转化描述
	InvalidReason string `json:"invalidReason,omitempty"`
}

InvalidConversionType

type UploadConvertDataRequest

type UploadConvertDataRequest struct {
	// Token API接口token,每个推广账号对应一个唯一TOKEN
	Token string `json:"token"`
	// ConversionTypes 回传转化数据数组,每次回传转化数据数组长度需小于100
	ConversionTypes []ConversionType `json:"conversionTypes,omitempty"`
}

UploadConvertDataRequest 广告主回传转化数据 API Request

func (UploadConvertDataRequest) OcpcToken added in v1.2.8

func (r UploadConvertDataRequest) OcpcToken() string

func (*UploadConvertDataRequest) SetOcpcToken added in v1.2.8

func (r *UploadConvertDataRequest) SetOcpcToken(token string)

func (UploadConvertDataRequest) Url added in v1.2.8

type UploadInvalidConvertDataRequest

type UploadInvalidConvertDataRequest struct {
	// Token API接口token,每个推广账号对应一个唯一TOKEN
	Token string `json:"token"`
	// InvalidConversionTypes 回传转化数据数组,每次回传转化数据数组长度需小于100
	InvalidConversionTypes []InvalidConversionType `json:"invalidConversionTypes,omitempty"`
}

UploadInvalidConvertDataRequest

func (UploadInvalidConvertDataRequest) OcpcToken added in v1.2.8

func (*UploadInvalidConvertDataRequest) SetOcpcToken added in v1.2.8

func (r *UploadInvalidConvertDataRequest) SetOcpcToken(token string)

func (UploadInvalidConvertDataRequest) Url added in v1.2.8

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL