adconvert

Documentation

Overview

Package adconvert 转化目标管理 API Models

Index

• type AdConvert
• type Convert
• type CreateRequest
  • func (r CreateRequest) Encode() []byte
• type CreateResponse
• type DeepExternalAction
• type DeepbidReadRequest
  • func (r DeepbidReadRequest) Encode() string
• type DeepbidReadResponse
• type ExternalAction
• type OptimizeTarget
• type OptimizeTargetGetRequest
  • func (r OptimizeTargetGetRequest) Encode() string
• type OptimizeTargetGetResponse
• type PushRequest
  • func (r PushRequest) Encode() []byte
• type QueryRequest
  • func (r QueryRequest) Encode() string
• type QueryResponse
• type ReadRequest
  • func (r ReadRequest) Encode() string
• type ReadResponse
• type SelectRequest
  • func (r SelectRequest) Encode() string
• type SelectResponse
• type SelectResponseData
• type TrackURLUpdateRequest
  • func (r TrackURLUpdateRequest) Encode() []byte
• type UpdateStatusRequest
  • func (r UpdateStatusRequest) Encode() []byte

Types

type AdConvert

type AdConvert struct {
	// ConvertType 跟踪方式, 即原转化接口中转化来源
	ConvertType enum.AdConvertSource `json:"convert_type,omitempty"`
	// Disabled 是否禁用, true 表示已经禁用，false 表示可用
	Disabled bool `json:"disabled,omitempty"`
	// ExternalActions 转化来源下的转化目标列表
	ExternalActions []ExternalAction `json:"external_actions,omitempty"`
}

AdConvert 转化数据

type Convert

type Convert struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ID 转化id
	ID uint64 `json:"id,omitempty"`
	// AppType 应用类型
	AppType string `json:"app_type,omitempty"`
	// PackageName 包名
	PackageName string `json:"package_name,omitempty"`
	// DownloadURL 下载地址
	DownloadURL string `json:"download_url,omitempty"`
	// OptStatus 转化工具操作状态
	OptStatus enum.AdConvertOptStatus `json:"opt_status,omitempty"`
	// ConvertSourceType 转化来源
	ConvertSourceType enum.AdConvertSource `json:"convert_source_type,omitempty"`
	// Status 转化状态
	Status enum.AdConvertStatus `json:"status,omitempty"`
	// ConvertType 转化类型
	ConvertType enum.AdConvertType `json:"convert_type,omitempty"`
	// ActionTrackURL 点击监测链接
	ActionTrackURL string `json:"action_track_url,omitempty"`
	// DisplayTrackURL 展示监测链接
	DisplayTrackURL string `json:"display_track_url,omitempty"`
	// VideoPlayEffectiveTrackURL 视频有效播放监测链接
	VideoPlayEffectiveTrackURL string `json:"video_play_effective_track_url,omitempty"`
	// VideoPlayDoneTrackURL 视频播放完毕监测链接
	VideoPlayDoneTrackURL string `json:"video_play_done_track_url,omitempty"`
	// VideoPlayTrackURL 视频播放监测链接
	VideoPlayTrackURL string `json:"video_play_track_url,omitempty"`
	// ConvertActivateCallbackURL 激活回传地址
	ConvertActivateCallbackURL string `json:"convert_activate_callback_url,omitempty"`
	// AppID APP ID
	AppID string `json:"app_id,omitempty"`
	// ExternalURL 落地页链接
	ExternalURL string `json:"external_url,omitempty"`
	// ConvertTrackParams 监测参数
	ConvertTrackParams string `json:"convert_tarck_params,omitempty"`
	// ConvertBaseCode 转化基础代码
	ConvertBaseCode string `json:"convert_base_code,omitempty"`
	// ConvertJSCode 转化代码（JS方式）
	ConvertJSCode string `json:"convert_js_code,omitempty"`
	// ConvertHTMLCode 转化代码（HTML方式）
	ConvertHTMLCode string `json:"convert_html_code,omitempty"`
	// ConvertXPathURL 转化页面
	ConvertXPathURL string `json:"convert_xpath_url,omitempty"`
	// ConvertXPathValue 转化路径
	ConvertXPathValue string `json:"convert_xpath_value,omitempty"`
	// OpenURL 直达链接
	OpenURL string `json:"open_url,omitempty"`
	// CreateTime 创建时间
	CreateTime string `json:"create_time,omitempty"`
	// ModifyTime 更新时间
	ModifyTime string `json:"modify_time,omitempty"`
	// IgnoreParams 转化类型下匹配规则字段
	IgnoreParams []string `json:"ignore_params,omitempty"`
	// ConvertDataType 转化统计方式
	ConvertDataType enum.AdConvertDataType `json:"convert_data_type,omitempty"`
}

Convert 转化目标详细信息

type CreateRequest

type CreateRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Name 转化名称
	Name string `json:"name,omitempty"`
	// AppName 应用中文名
	AppName string `json:"app_name,omitempty"`
	// ConvertSourceType 转化来源
	ConvertSourceType enum.AdConvertSource `json:"convert_source_type,omitempty"`
	// ConvertType 转化类型
	ConvertType enum.AdConvertType `json:"convert_type,omitempty"`
	// DownloadURL 下载地址
	DownloadURL string `json:"download_url,omitempty"`
	// AppType 应用类型
	AppType string `json:"app_type,omitempty"`
	// ActionTrackURL 点击监测链接
	ActionTrackURL string `json:"action_track_url,omitempty"`
	// DisplayTrackURL 展示监测链接
	DisplayTrackURL string `json:"display_track_url,omitempty"`
	// VideoPlayEffectiveTrackURL 视频有效播放监测链接
	VideoPlayEffectiveTrackURL string `json:"video_play_effective_track_url,omitempty"`
	// VideoPlayDoneTrackURL 视频播放完毕监测链接
	VideoPlayDoneTrackURL string `json:"video_play_done_track_url,omitempty"`
	// VideoPlayTrackURL 视频播放监测链接
	VideoPlayTrackURL string `json:"video_play_track_url,omitempty"`
	// PackageName 包名
	PackageName string `json:"package_name,omitempty"`
	// DeepExternalAction 深度转化目标，转化类型不同允许深度转化目标也不同，具体参考下方的【转化目标与深度转化目标关系】介绍
	DeepExternalAction enum.DeepExternalAction `json:"deep_external_action,omitempty"`
	// ConvertDataType 转化统计方式，针对每次付费广告，投放范围是站内和穿山甲，转化来源是应用下载SDK/API这两种方式，广告平台统计该转化目标是否发生的方式，默认“仅一次”（即，每个用户最多仅统计一次转化行为）。
	// 允许值：
	// ONLY_ONE（仅一次）：对于每位转化的用户，仅统计其首次“目标事件”的转化行为，即每位用户最多仅记录一次转化。
	// EVERY_ONE（每一次）：对于每位转化的用户，统计其每次“目标事件”的发生次数，即每位用户可记录多次发生的转化；该统计方式下，创建广告计划时deep_bid_type须为BID_PER_ACTION
	// 注意：如果广告主ID不在白名单里面，且统计方式选择EVERY_ONE，请求会失败，报错信息“convertDataType not in whiteList”。
	ConvertDataType string `json:"convert_data_type,omitempty"`
	// ConvertXPathURL 转化页面
	ConvertXPathURL string `json:"convert_xpath_url,omitempty"`
	// ConvertXPathValue 转化路径
	ConvertXPathValue string `json:"convert_xpath_value,omitempty"`
	// XPathIgnoreParams 匹配规则字段(xpath下可传)，允许值:
	// "UTM_ID"、"CID"、"ADID"
	XPathIgnoreParams []string `json:"xpath_ignore_params,omitempty"`
	// ExternalURL 落地页链接
	ExternalURL string `json:"external_url,omitempty"`
	// AppID APP ID
	AppID string `json:"app_id,omitempty"`
	// OpenURL 直达链接
	OpenURL string `json:"open_url,omitempty"`
}

CreateRequest 创建转化目标 API Request

func (CreateRequest) Encode

func (r CreateRequest) Encode() []byte

Encode implement PostRequest interface

type CreateResponse

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

CreateResponse 创建转化目标 API Response

type DeepExternalAction

type DeepExternalAction struct {
	// DeepExternalAction 深度转化的转化目标
	DeepExternalAction enum.DeepExternalAction `json:"deep_external_action,omitempty"`
	// DeepExternalName 深度转化转化名称
	DeepExternalName string `json:"deep_external_name,omitempty"`
	// Disabled 深度转化是否禁用,true 表示已经禁用，false 表示可用
	Disabled bool `json:"disabled,omitempty"`
}

DeepExternalAction 深度转化转化目标

type DeepbidReadRequest

type DeepbidReadRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignID 广告组id
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// DeepExternalAction 深度转化目标
	DeepExternalAction enum.DeepExternalAction `json:"deep_external_action,omitempty"`
	// DeliveryRange 投放范围
	DeliveryRange enum.AdDeliveryRange `json:"delivery_range,omitempty"`
	// ConvertID 转化id，convert_id和external_action二选一
	ConvertID uint64 `json:"convert_id,omitempty"`
	// ExternalAction 转化类型，convert_id和external_action二选一
	ExternalAction enum.AdConvertType `json:"external_action,omitempty"`
	// FlowControlMode 竞价策略(投放方式)
	FlowControlMode enum.FlowControlMode `json:"flow_control_mode,omitempty"`
	// SmartBidType 投放场景(出价方式)
	SmartBidType enum.SmartBidType `json:"smart_bid_type,omitempty"`
}

DeepbidReqdRequest 查询深度优化方式 API Request

func (DeepbidReadRequest) Encode

func (r DeepbidReadRequest) Encode() string

Encode implement GetRequest interface

type DeepbidReadResponse

type DeepbidReadResponse struct {
	model.BaseResponse
	Data struct {
		// SuccessList 可用的深度转化方式列表
		SuccessList []enum.DeepBidType `json:"success_list,omitempty"`
	} `json:"data,omitempty"`
}

DeepbidReadResponse 查询深度优化方式 API Response

type ExternalAction

type ExternalAction struct {
	// ConvertID 转化目标ID，返回自定义转化目标ID，预定义转化目标返回为Null，对应数字值可根据external_action参考【枚举值-转化类型】
	ConvertID model.FlexUint64 `json:"convert_id,omitempty"`
	// ActionTrackURL 转化监测连接
	ActionTrackURL string `json:"action_track_url,omitempty"`
	// Disabled 转化是否禁用,true 表示已经禁用，false 表示可用
	Disabled bool `json:"disabled,omitempty"`
	// ExternalAction 转化目标，返回预定义的转化类型，详见【附录-枚举值-转化类型】，即原转化接口中 convert_type
	ExternalAction enum.AdConvertType `json:"external_action,omitempty"`
	// ExternalActionName 转化类型名称
	ExternalActionName string `json:"external_action_name,omitempty"`
	// ExternalActions 多转化目标
	ExternalActions []enum.AdConvertType `json:"external_actions,omitempty"`
	// ExternalName 自定义转化名称
	ExternalName string `json:"external_name,omitempty"`
	// Source 转化目标创建来源
	Source enum.ExternalActionSource `json:"source,omitempty"`
	// Belong 线索通来源
	Belong []enum.ExternalActionBelong `json:"belong,omitempty"`
	// ConvertDataType 转化统计方式
	ConvertDataType []enum.AdConvertDataType `json:"convert_data_type,omitempty"`
	// DeepExternalActions 深度转化转化目标
	DeepExternalActions []DeepExternalAction `json:"deep_external_actions,omitempty"`
}

ExternalAction 转化来源下的转化目标

type OptimizeTarget

type OptimizeTarget struct {
	// MarketingPurpose 营销目的，允许值：UNLIMITED不限，CONVERSION行动转化， INTENTION用户意向，ACKNOWLEDGE品牌认知
	MarketingPurpose enum.MarketingPurpose `json:"marketing_purpose,omitempty"`
	// Disabled 是否禁用, true 表示已经禁用，false 表示可用
	Disabled bool `json:"disabled,omitempty"`
	// Converts 优化来源下的转化目标列表
	Converts []AdConvert `json:"converts,omitempty"`
}

OptimizeTarget 转化数据

type OptimizeTargetGetRequest

type OptimizeTargetGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// LandingType 广告组推广目的
	LandingType enum.LandingType `json:"landing_type,omitempty"`
	// MarketingPurpose 营销目的，可选值：UNLIMITED不限，CONVERSION行动转化， INTENTION用户意向，ACKNOWLEDGE品牌认知
	MarketingPurpose enum.MarketingPurpose `json:"marketing_purpose,omitempty"`
	// PromotionContent 投放内容，根据不同推广目的对应的不同的投放内容，详情可参考下方的【联动关系】对照表格
	// 允许值:
	// AWEME_HOME_PAGE、DOUYIN、DOWNLOAD_URL、EXTERNAL_URL、GOODS_LINK、LIVE_ROOM、MICRO_APP、NORMAL、QUICK_APP_URL、SHOP、THIRD_PARTY
	PromotionContent enum.PromotionContent `json:"promotion_content,omitempty"`
	// ExternalURL 落地页链接
	ExternalURL string `json:"external_url,omitempty"`
	// PackageName Android应用包名
	PackageName string `json:"package_name,omitempty"`
	// AppType 应用下载类型
	AppType string `json:"app_type,omitempty"`
	// ItunesURL iOS应用下载链接
	ItunesURL string `json:"itunes_url,omitempty"`
	// AppSchema 小程序app_schema
	AppSchema string `json:"app_schema,omitempty"`
	// CampaignType 广告组类型，允许值：FEED信息流广告，SEARCH搜索广告
	CampaignType enum.CampaignType `json:"campaign_type,omitempty"`
	// ConvertType 跟踪方式
	ConvertType enum.AdConvertSource `json:"convert_type,omitempty"`
	// ConvertID 自定义转化id
	ConvertID uint64 `json:"convert_id,omitempty"`
	// DeepExternalAction 深度转化目标
	DeepExternalAction enum.DeepExternalAction `json:"deep_external_action,omitempty"`
	// ConvertName 转化名称
	ConvertName string `json:"convert_name,omitempty"`
	// DedicateType IOS14.5专属广告入参标识，可选值："UNSET"、"DEDICATED"，查询IOS14.5专属广告可用转化目标时必填"DEDICATED"
	DedicateType string `json:"dedicate_type,omitempty"`
	// LaunchTargetType 投放类型，允许值：LIVE_CONVERT 直播间转化、APP 应用下载、EXTERNAL 线索收集
	LaunchTargetType enum.LaunchTargetType `json:"launch_target_type,omitempty"`
	// Page 页数
	Page int `json:"page,omitempty"`
	// PageSize 页面大小
	PageSize int `json:"page_size,omitempty"`
}

OptimizeTargetGetRequest 查询广告计划可用优化目标 API Request

func (OptimizeTargetGetRequest) Encode

func (r OptimizeTargetGetRequest) Encode() string

Encode implement GetRequest interface

type OptimizeTargetGetResponse

type OptimizeTargetGetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data struct {
		// List 转化数据列表
		List []OptimizeTarget `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

OptimizeTargetGetResponse 查询广告计划可用优化目标 API Response

type PushRequest

type PushRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ConvertID 转化目标ID
	ConvertID uint64 `json:"convert_id,omitempty"`
	// TargetAdvertiserIDs 推送的广告主ID列表，上限：50
	TargetAdvertiserIDs []uint64 `json:"target_advertiser_ids,omitempty"`
}

PushRequest 转化目标推送 API Request

func (PushRequest) Encode

func (r PushRequest) Encode() []byte

Encode implement PostRequest interface

type QueryRequest

type QueryRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// LandingType 广告组推广目的
	LandingType enum.LandingType `json:"landing_type,omitempty"`
	// PromotionContent 投放内容，根据不同推广目的对应的不同的投放内容，详情可参考下方的【联动关系】对照表格
	// 允许值:
	// AWEME_HOME_PAGE、DOUYIN、DOWNLOAD_URL、EXTERNAL_URL、GOODS_LINK、LIVE_ROOM、MICRO_APP、NORMAL、QUICK_APP_URL、SHOP、THIRD_PARTY
	PromotionContent enum.PromotionContent `json:"promotion_content,omitempty"`
	// DeliveryRange 广告投放范围
	DeliveryRange enum.AdDeliveryRange `json:"delivery_range,omitempty"`
	// ExternalURL 落地页链接
	ExternalURL string `json:"external_url,omitempty"`
	// AppType 应用下载类型
	AppType string `json:"app_type,omitempty"`
	// PackageName Android应用包名
	PackageName string `json:"package_name,omitempty"`
	// ItunesURL iOS应用下载链接
	ItunesURL string `json:"itunes_url,omitempty"`
	// AppSchema 小程序app_schema
	AppSchema string `json:"app_schema,omitempty"`
	// AdvancedCreativeType 附加创意类型
	AdvancedCreativeType enum.AdvancedCreativeType `json:"advanced_creative_type,omitempty"`
	// MarketingScene 游戏预约场景，附加创意类型为ATTACHED_CREATIVE_GAME_SUBSCRIBE游戏预约时填写，允许值:
	// GAME_PROMOTION（游戏大推）、GAME_SUBSCRIBE（游戏预约 ）、NORMAL（普通场景）
	MarketingScene enum.MarketingScene `json:"marketing_scene,omitempty"`
}

QueryRequest 查询广告计划可用转化目标 API Request

func (QueryRequest) Encode

func (r QueryRequest) Encode() string

Encode implement GetRequest interface

type QueryResponse

type QueryResponse struct {
	model.BaseResponse
	Data struct {
		// List 转化数据列表
		List []AdConvert `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

QueryResponse 查询广告计划可用转化目标 API Response

type ReadRequest

type ReadRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ConvertID 转化id，其中较小数值convert_id为预定义转化
	ConvertID uint64 `json:"convert_id,omitempty"`
}

ReadRequest 查询转化目标详细信息 API Request

func (ReadRequest) Encode

func (r ReadRequest) Encode() string

Encode implement GetRequest interface

type ReadResponse

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

ReadResponse 查询转化目标详细信息 API Response

type SelectRequest

type SelectRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ConvertIDs 指定需要查询的转化目标ID，如不填写默认返回所有的转化目标ID
	ConvertIDs []uint64 `json:"convert_id,omitempty"`
	// OptStatus 转化工具操作状态
	OptStatus enum.AdConvertOptStatus `json:"opt_status,omitempty"`
	// Page 页数
	Page int `json:"page,omitempty"`
	// PageSize 页面大小
	PageSize int `json:"page_size,omitempty"`
}

SelectRequest 转化目标列表 API Request

func (SelectRequest) Encode

func (r SelectRequest) Encode() string

Encode implement GetRequest interface

type SelectResponse

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

SelectResponse 转化目标列表 API Response

type SelectResponseData

type SelectResponseData struct {
	// PageInfo 分页相关信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// List 转化的数据list
	List []Convert `json:"ad_convert_list,omitempty"`
}

SelectResponseData json返回值

type TrackURLUpdateRequest

type TrackURLUpdateRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ConvertID 转化id
	ConvertID uint64 `json:"convert_id,omitempty"`
	// TrackURL 展示（监测链接）
	TrackURL string `json:"track_url,omitempty"`
	// ActionTrackURL 点击监测链接
	ActionTrackURL string `json:"action_track_url,omitempty"`
	// VideoPlayEffectiveTrackURL 视频有效播放监测链接
	VideoPlayEffectiveTrackURL string `json:"video_play_effective_track_url,omitempty"`
	// VideoPlayDoneTrackURL 视频播放完毕监测链接
	VideoPlayDoneTrackURL string `json:"video_play_done_track_url,omitempty"`
	// VideoPlayTrackURL 视频播放监测链接
	VideoPlayTrackURL string `json:"video_play_track_url,omitempty"`
}

TrackURLUpdateRequest 修改转化监测链接 API Request

func (TrackURLUpdateRequest) Encode

func (r TrackURLUpdateRequest) Encode() []byte

Encode implement GetRequest interface

type UpdateStatusRequest

type UpdateStatusRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ConvertID 转化id，其中较小数值convert_id为预定义转化
	ConvertID uint64 `json:"convert_id,omitempty"`
	// OptStatus 转化工具操作状态
	OptStatus enum.AdConvertOptStatus `json:"opt_status,omitempty"`
}

UpdateStatusRequest 更新转化目标操作状态

func (UpdateStatusRequest) Encode

func (r UpdateStatusRequest) Encode() []byte

Encode implement PostRequest interface