adconvert

Documentation

Overview

Package adconvert 转化目标管理 API

Index

• func Create(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*adconvert.Convert, error)
• func DeepbidRead(ctx context.Context, clt *core.SDKClient, accessToken string, ...) ([]enum.DeepBidType, error)
• func OptimizeTargetGet(ctx context.Context, clt *core.SDKClient, accessToken string, ...) ([]adconvert.OptimizeTarget, error)
• func Push(ctx context.Context, clt *core.SDKClient, accessToken string, ...) error
• func Query(ctx context.Context, clt *core.SDKClient, accessToken string, ...) ([]adconvert.AdConvert, error)
• func Read(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*adconvert.Convert, error)
• func Select(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*adconvert.SelectResponseData, error)
• func TrackURLUpdateStatus(ctx context.Context, clt *core.SDKClient, accessToken string, ...) error
• func UpdateStatus(ctx context.Context, clt *core.SDKClient, accessToken string, ...) error

Functions

func Create

func Create(ctx context.Context, clt *core.SDKClient, accessToken string, req *adconvert.CreateRequest) (*adconvert.Convert, error)

Create 创建转化目标 通过工具能力，创建一个能被计划使用的转化跟踪工具。可以通过设定转化目标（比如多少人打开应用）跟踪转化状态，衡量推广转化效果。按照转化跟踪类型目的区分目前支持两种：跟踪线索以及跟踪应用。 如果广告主期望获得销售线索（表单提交、销售线索等）可以使用追踪线索相关，线索追踪中支持JS、Xpath、API（线索） 如果拥有自己的应用，希望获取用户指定行为（下载、安装、激活等）可以使用应用推广相关，应用追踪支持应用API、应用SDK 您可以通过转化ID列表或转化详细信息接口的status参数来查询转化状态 创建后状态为未激活状态，需要前往巨量引擎投放平台激活，再去创建广告计划 转化类型和激活规则对应关系如下： 线索-XPATH：创建后状态默认为激活； 线索-JS：创建后状态为未激活，需要下载代码在自有落地页添加，完成检测转化上报； 线索-API：创建后为状态为未激活，需要完成检测转化上报（过程中需技术人员接收广告点击数据并将相关转化事件回传至回调地址） 应用下载SDK：首次创建成功后状态为未激活，需要检测转化上报，完成后激活； 应用下载API：创建成功后状态为未激活，需要检测转化上报，完成后激活； 其他非应用下载类的转化每次创建都要求激活联调。但是如果你使用转化推送接口，推送已激活的转化，那推送后的转化目标是免联调直接进入激活状态（请注意状态变更有几分钟的延迟） 「convert_data_type」转化统计方式中EVERY_ONE（每一次）为白名单功能，可联系对接销售或运营咨询 创建应用下载类转化目标时，Android类应用必须要填写package_name的应用包名，并且要在平台侧的应用管理中完成上传解析才可以使用。 平台侧操作：投放平台-「资产」-「移动应用」-「新建应用」-「上传」 使用时注意区分应用中文名app_name与包名package_name app_name：应用名称，例如：“计算器”、“记事本” package_name：应用包包名，例如“com.xx.xx” 当前应用下载类转化目标中，仅AD_CONVERT_TYPE_ACTIVE激活、AD_CONVERT_TYPE_PAY付费，支持设置对应深度转化目标

func DeepbidRead

func DeepbidRead(ctx context.Context, clt *core.SDKClient, accessToken string, req *adconvert.DeepbidReadRequest) ([]enum.DeepBidType, error)

DeepbidRead 查询深度优化方式 查询ocpc、ocpm广告计划可使用的深度优化方式及相关信息

func OptimizeTargetGet

func OptimizeTargetGet(ctx context.Context, clt *core.SDKClient, accessToken string, req *adconvert.OptimizeTargetGetRequest) ([]adconvert.OptimizeTarget, error)

OptimizeTargetGet 查询广告计划可用优化目标 查询ocpc、ocpm广告计划可使用的转化目标ID以及对应的转化目标信息（转化目标的相关属性，不包括转化跟踪效果数据） 该接口支持的推广目的有：应用推广、销售线索收集、快应用、抖音号、直播间 影响因素为推广目的、投放范围、投放内容以及附加创意 查询结果都是可用状态的转化，均为激活状态的转化 「convert_id」仅返回自定义转化目标ID，预定义转化目标返回为Null，对应数字值可根据external_action参考【枚举值-转化类型】 游戏预约场景目前只支持落地页，游戏预约场景必传落地页链接external_url 快应用不支持IOS链接 下载方式为下载链接或者快应用+下载链接时，app_type必填 app_type为APP_ANDROID，package_name必填 下载方式为落地页时，external_url必填

func Push

func Push(ctx context.Context, clt *core.SDKClient, accessToken string, req *adconvert.PushRequest) error

Push 转化目标推送 通过当前接口，可以将转化目标ID推送给同公司主体下的其他账号，帮助您解决需要频繁创建转化目标ID的问题。 状态是已激活的转化目标ID才可进行推送，并且推送后的转化目标ID将自动变成已激活状态，帮助您免去繁琐的联调，但是推送后会有一段时间延迟，新的转化目标ID会在几分钟延迟后状态更新为已激活 推送后您可以通过 【查询转化详细信息】接口查询转化的状态 推送的广告主必须与转化目标ID所属广告主的公司主体一致； 一次可推送的广告主target_advertiser_ids上限为50

func Query

func Query(ctx context.Context, clt *core.SDKClient, accessToken string, req *adconvert.QueryRequest) ([]adconvert.AdConvert, error)

Query 查询广告计划可用转化目标 查询ocpc、ocpm广告计划可使用的转化目标ID以及对应的转化目标信息（转化目标的相关属性，不包括转化跟踪效果数据） 影响因素为推广目的、投放范围、投放内容以及附加创意 查询结果都是可用状态的转化，均为激活状态的转化 「convert_id」仅返回自定义转化目标ID，预定义转化目标返回为Null，对应数字值可根据external_action参考【枚举值-转化类型】 游戏预约场景目前只支持落地页，游戏预约场景必传落地页链接external_url 快应用不支持IOS链接 下载方式为下载链接或者快应用+下载链接时，app_type必填 app_type为APP_ANDROID，package_name必填 下载方式为落地页时，external_url必填

func Read

func Read(ctx context.Context, clt *core.SDKClient, accessToken string, req *adconvert.ReadRequest) (*adconvert.Convert, error)

Read 查询转化目标详细信息 查询转化ID的详细信息 整体返回信息依赖于转化来源convert_source_type，不同转化来源返回的详情参数有差异 如果是需要广告计划可用的转化，请使用接口【查询可用转化ID】

func Select

func Select(ctx context.Context, clt *core.SDKClient, accessToken string, req *adconvert.SelectRequest) (*adconvert.SelectResponseData, error)

Select 转化目标列表 查询广告主名义下选定的转化目标信息列表 可通过convert_ids查询指定ID的转化目标，或通过opt_status查询指定状态的转化目标 如果是需要查询广告计划可用的转化请使用接口【查询计划可用转化目标】 转化convert_ids为选填，如果不传，应答参数中默认返回广告主下所有的转化目标ID

func TrackURLUpdateStatus

func TrackURLUpdateStatus(ctx context.Context, clt *core.SDKClient, accessToken string, req *adconvert.TrackURLUpdateRequest) error

TrackURLUpdateStatus 修改转化监测链接 通过本接口可以修改转化目标内的监测链接， 监测链接目前包含5个字段，action_track_url、track_url、video_play_track_url、video_play_done_track_url、video_play_effective_track_url，当传入值为空字符串时，会将对应的监测链接置为空，如果将5个链接全部传入空字符串，那么5个监测链接将全部置为空； 修改转化的监测链接，可以同时传多个链接地址修改，5个监测链接中，需要至少有一个字段传入，全部不传（字段没有传入置）系统会进行报错； 应用下载类的转化跟踪，不允许修改监控链接（展示，点击等5个均不允许传入修改）。 监测链接传输协议仅支持https类型 监测链接可以修改为空值，如 action_track_url传入空字符串，会将监测链接置空

func UpdateStatus

func UpdateStatus(ctx context.Context, clt *core.SDKClient, accessToken string, req *adconvert.UpdateStatusRequest) error

UpdateStatus 更新转化目标操作状态 此接口用于针对转化目标的操作状态进行变更，将无用的转化目标删除放入回收站或将已删除至回收站的转化目标恢复 更改转化目标操作状态为删除后，正在使用该转化目标的广告计划不受影响； 转化目标删除后，对应已经在使用中的转化数据不受影响；