UC广告超级汇川Marketing API

一、Marketing API产品介绍

产品基本逻辑、功能优势及接口能力说明

1、什么是超级汇川Marketing API?

API:应用程序接口，可以实现计算机软件间快速、有效、安全的数据传输。

超级汇川Marketing API:开放超级汇川推广平台的数据管理与应用能力，是连结广告主自有平台与超级汇川各流量端的桥梁，为广告主提供稳定、友好的接口服务。

①通过Marketing API获取数据-广告主可以在自有平台内，自主选取、调用超级汇川平台开放的功能，完成UC广告投放、数据获取。

②通过Marketing API优化UC广告投放-广告主可以应用自有数据，实现自动化、个性化的控制UC广告投放，定制优化策略，提升投放效果。

2、超级汇川MarketingAPI目标用户定位

适用于具备一定技术能力的广告主。

(1)行业头部广告主

①有个性化投放需求

②投放量大、物料多，需要支持批量操作

(2)UC广告代理/服务商

①服务多家客户，投放产品/素材不一，需要高效完成投放操作

②客户要求数据反馈及时，需要按时获取定制化的数据报告

③数据监控时效要求高，需要及时发现问题，减少事故发生

(3)第三方工具开发者

①专门为客户提供投放相关技术支持，需要与媒体平台打通

②能够为超级汇川广告主提供广告搭建，数据获取、物料管理等方面的提效支持

(4)其他有技术能力的客户

3、超级汇川Marketing API vs传统手动操作UC广告投放功能效益对比

超级汇川Marketing API支持广告主快捷实现广告搭建、数据拉取、素材上传、人群和转化管理等批量化的投放操作;

基于物料准备->人群定向->起投->效果监测->投放优化全流程的效益提升，支持广告主快速验证投放方案，促进消耗增长。

(1)跨UC广告账户投放管理

①支持指定多账户、或针对代理/管家户下的多个子账户进行批量操作。

②优化师日维护UC广告账户数主要分布在10-20区间，每户平均操作3次，通过API提效30倍以上。

(2)批量搭建广告

①支持一次性批量搭建UC广告推广组/计划/创意。

②优化师每创建200条推广计划，手动操作需3小时，通过API操作仅需15分钟。

(3)定制数据报告

①支持UC广告主白选指标定制报告;支持分推广层级报告、定向报告和其它专项报告。

②优化师日均分时段汇总报告达5次以上，需要20分钟，通过API操作仅需5分钟。

(4)UC广告投放异常监测

①支持广告主基于实时返回的投放数据指标制定监控策略，及时发现异常、跟进优化。

②优化师日均看盘3轮，通过AP可实现分钟级系统自动巡查，监测效率提升5倍以上。

4、超级汇川Marketing API当前使用情况

相较2021年同期，UC广告超级汇川MarketingAPI完成了支持全链路、跨场景投放的产品升级;同步在物料批量搭建、账户资产共享及基本请求流程上进行了迭代优化，帮助广告主实现更轻便、高效的产品体验，提升基建能力和投放效率。

5、超级汇川MarketingAPI核心接口能力一览

二、UC广告Marketing API应用案例

主流第三方合作工具能力、亮点案例介绍

1、超级汇川MarketingAPI应用案例-小鹿超级汇川助手(离线工具)

2、超级汇川MarketingAPI应用案例-九枝兰汇川账户管理(web工具)

3、超级汇川MarketingAPI亮点功能案例-知定堂系统

4、超级汇川Marketing API亮点功能案例-致维嗨景营销云

三、UC广告Marketing API接入指引

接入流程、基本使用说明和常见问题答疑

1、UC广告Marketing API接入流程

【接入条件】超级汇川投放UC广告账户、代理户或管家户均可申请接入;需账户状态为正常，否则会提示无法通过。

如使用代理户或管家户申请，申请通过后可支持获取其下投放账户数据;无需再行使用投放账户逐一完成申请。

【申请方式】

(1)在开放平台登录拟申请的UC广告账户;

(2)点击进入开发者中心->超级汇川API申请，勾选同意协议并点击“提交申请”按钮即提交成功;

(3)提交后系统自动审核，审核通过后将在此页面显示该UC广告账户的APIKey(即API请求时所需的token值);当发生接口请求，该token用于与账户名、密码同步进行身份验证。

2、UC广告Marketing API基本使用说明

【总述】

(1)Marketing API又称投放API，旨在解决广告主投放操作、数据获取等场景的效率问题;不含转化API(转化数据回传)相关内容。

(2)请求频次限制:UC广告账户维度QPS20，即同投放账户内至多请求20次/秒。

(3)人群管理相关接口方法详见技术文档最后的DMPAPI文档”DMP开发者API介绍”;token与其它类接口共用.

(4)技术文档附录提供推广地域列表、错误编码、数据报告指标列取值、创意分类与标签功能账户行业白名单等。

【请求格式】

(1)请求域名(除DMP API)

(2)请求和返回的json消息一般包含header和body两部分，header包含账户名称、密码、token等字段。

(3)如使用UC广告代理户/管家户请求，请务必填写target字段;内容为请求的子账户(投放UC广告账户)名称，不是账户ID。

【API快速联调】

(1)您可通过获取UC广告账户信息接口，快速检验您是否能正常调用接口。

(2)详见文档”API快速联调”部分。

3、UC广告Marketing API常见问题答疑

(1)请求提示”用户没有权限”如何处理?

①这个情况说明请求域名或账户权限存在问题。请检查:

②对应请求的username(UC广告账户名称)是否已在开放平台获取到API Key (token)且填写正确。

(2)请求提示”请求头信息为空或不合法”如何处理?

①如1中所述检查请求域名信息，注意不要带空格、且其后接口名与文档一致;

②确认header信息填写正确:包括请求账户名、密码、token，如为UC广告代理/管家户请求需target到子账户名称。

子账户需与请求账户在crm存在从属关系。

(3)获取数据报告后，使用downloadFile接口下载文件为空，应如何处理?

①建议日报任务获取时间安排在次日上午9:30后，保障数据正常产出;

②推荐获取后先使用getFile查询下载任务状态，当返回状态为true时进行下载;

③注意获取分析类报告后，getFile或downloadFile，“adReport”字段为必填，需传false

分析类报告包含:APP报告、受众分析报告、地域分析报告、安心赔付消费报告、超级巡量计划数据报告、超级巡量建议开启计划报告。

(4)超级汇川全链路转化升级后，哪些接口发生了变化?

UC广告推广计划和转化类接口发生了变化(需广告主对应开发);数据报告接口新增相关字段，广告主可按需对接(不开发仍可获取原有数据报告);其它接口无变化。

①升级前后对比版文档-变更字段已标红

②数据报告字段更新-新增字段已标红

(5)数据报表接口可否支持实时获取?

基本支持实时。请求当日小时级报告时，最后一个小时会是截至当前的分钟级数据汇总。

(6)下载任务的taskid会失效吗?同个taskid数据会更新吗?

不会失效;同个taskid数据会更新，通过taskid下载时，会在前一步获取数据的约束条件基础上，拉取最新数据下载。

(7)通过接口下载报表后发现是”乱码”怎么办?

二进制流，需要在程序里面支持编码，换成gbk。

(8)创建计划时提示素材不可用怎么办?

请检查素材是否在UC广告账户中存在且非审核拒绝状态。

审核中、审核通过的素材均可用于创建计划。

四、SDK封装:更快捷的接入办法

针对java开发者提供更快捷的接入办法

接口SDK封装：更快捷的接入办法-现仅支持java

超级汇川MarketingAPI的JavaSDK版本，在现有Marketing API基础上对功能与接口进行了封装。相比直接接入API，使用SDK版本可以更简单快捷的接入所需功能，大幅降低新客户的接入成本。

【注意】

1、当接口发生升级，常规情况下会每次向前兼容，广告主仍可使用原有SDK包;

2、特殊情况下的重大升级，可能导致原有旧版SDK无法兼容平台最新功能，此时需要UC广告主到开放平台下载最新版本的SDK包。

发生重大升级时，在开放平台及其它官方渠道会发通知。

接口SDK版本优势:

1、超级汇川平台官方提供

稳定维护有保障

2、大幅降低接口接入成本

除特殊定制化需求外，免去UC广告主后端开发工作量

3、新客友好、易用性强

提供接入手册和使用示例，为开发者提供“保姆级”使用指引

4、新功能持续更新

SDK封装接口与Marketing API同步升级