1. 术语介绍

术语详细描述

广告账号

客户以直客广告主身份在渠道营销平台注册的账号。每个客户在广告平台可能有多个账号进行推广,每个账号有唯一的账号ID。
管家账号

为广告主提供广告管理服务的代理机构或者有大量账号需要统一管理的大型广告主,在渠道平台注册的账号。每个管家账号下会有多个广告主账号,每个管家账号有唯一的管家账号ID。

开发者

接入渠道MarketingAPI能力,以技术对接方式为代理商或广告主提供广告投放、数据获取等服务的第三方。代理商、广告主、独立第三方均可以是开发者。开发者需要先注册商业开放平台账号,并完成主体资质审核等。代理商、广告主作为开发者时,可直接使用原有账号。

开发者应用

商业开放平台为每个开发者分配的唯一应用。一个开发者可以注册多个应用,用于提供不同的服务(比如管理广告计划、广告数据拉取、用户数据上传等),也可以通过一个应用来实现所有功能。

注意事项:

(1)单个

账号下正常都有最多允许创建个数,如需创建新的开发者应用,需删除旧应用,随之被分配应用的开发者将无法继续提供服务。

(2)开发者应用指基于商业开放平台Marketing API开发的应用,而推广的应用程序是指广告主推广的目标APP,两者之间并无任何关联。

应用ID及密钥

每个开发者应用有唯一的ID,对应唯一密钥。由平台在应用审核通过后分配,开发者发起MarketingAPI 授权请求时需要携带。

授权令牌

开发者应用授权给广告主/代理商的凭证。完成授权流程后开发者可获取到令牌(access_token),用于每次调用接口时传入,包含了客户账号/授权范围/授权有效期等信息。

2. 授权方式

广告主或者广告主服务商接入渠道营销平台Marketing API的方式主要有两种,一种是通过Oauth2.0授权方式,另一种是通过账号&密码&token授权方式

Oauth2.0授权:申请渠道开发者->渠道商业开放平台创建应用->神策后台填写应用ID及Secret->跳转渠道授权界面点击授权->拉取广告账号及投放数据

账号密码授权:申请渠道开发者->渠道商业开放平台获取授权令牌->神策后台填写账号/密码/令牌→拉取广告账号及投放数据

注意事项:如果广告主修改了投放账户的密码后,需要重新在神策广告分析后台做 Marketing API授权或联系神策相关同事。

3. 功能介绍

要使用投放分析报表,首先要账户授权,神策才可以调用接口获取到相应广告账户的广告数据,目前神策支持字节-巨量广告、腾讯广告、百度营销平台、360点睛实效平台、阿里-超级汇川、快手-磁力智投、苹果搜索广告、华为应用商店、华为鲸鸿动能、微博超级粉丝通、OPPO营销平台、vivo营销平台、小米营销平台、知乎效果营销、喜马拉雅-声量、荣耀商推平台的账户授权。

点击授权,回到神策广告分析页面完成授权后,当本次授权关联的广告账户数据超过10个账户时,显示如下弹出页面,可以根据实际业务情况,勾选需要授权的广告账户,点击「提交」完成授权。

授权成功后,可在账号列表查看已授权账号,支持对广告账户开启、停用、删除操作,支持批量操作,支持下载所有的广告账户数据。

4. 字节-巨量广告

点击添加账户授权,授权版本支持「字节-巨量广告升级版」。支持在广告投放报表-「信息流报表」中巨量广告升级版的广告详细数据。

巨量广告原版官方于2024年5月6日下线报表相关接口,神策广告分析广告投放报表不再支持拉取原版数据。

点击添加账号后,在巨量引擎授权界面选择授权账号,授权时请勾选「允许服务商管理敏感物料」。

点击【同意授权】后, 跳转到如下页面,在此页面中,请等待1~2秒

回到授权管理页面,点击【确认】,即可完成授权

注意:

1、授权管理功能目前仅支持广告主管家账号。授权成功后,管家账号下的子账号投放数据 ,可以在广告投放报表页面查看分析。因还未对接星图MKT-API,故授权时请勿勾选星图账户信息

5. 腾讯广告

腾讯广告于2024年4月开始推出新版系统,依据腾讯广告新版推广进度以及推广情况,神策广告分析进行了相关适配。目前仅在信息流报表中支持查看腾讯广告新版数据,SEM报表暂不支持腾讯广告新版

如需在广告分析报表中查看腾讯广告新版系统展示广告数据,需要在「广告授权管理」中重新进行授权。注意,请确保对应的广告账户已经切换到新版,并已经使用腾讯广告新版的监测链接进行投放。

具体授权流程如下:

1、点击添加账号后,在腾讯广告授权界面选择授权账号,并同意授权。目前仅支持身份为「广告主」「BM」的登陆账号进行授权,暂不支持身份为「广告主主体」「广告业务单元」「组织」账号进行授权。使用身份为「广告主」「BM」的登陆账号授权,报表仍正常拉取数据。

2、授权完成后,列表中新增「新旧版切换状态」,对应账号中信息为「新版」,代表账号已经切换到腾讯广告新版。「新版、旧版」代表账号正处于切换新版过渡阶段。仅为「旧版」代表账号为切换到新版。信息中包含「新版」并且使用腾讯广告新版渠道生成的点击监测链接投放,方可在信息流报表中查看对应的数据。

6. 百度营销平台

点击添加账号,弹出授权信息弹窗。授权端口主要是控制该账户信息在广告分析报表中的数据展示。授权同步可控制本次授权信息使用在哪个项目中。

点击「确定」按钮后,跳转至百度OAuth2.0模式授权页面,账号登录状态下选择需要授权的账号,点击「同意授权」按钮,完成授权操作。

注意:百度目前支持Oauth2.0方式授权,原有授权方式将于2022年年底下线,具体的通知:https://dev2.baidu.com/notice?noticeId=425

最迟请于2023年1月7日前完成重新授权。授权前,请截图备份历史授权配置情况,以免配置新账户时找不到参考.

7. 360点睛实效平台

点击添加账号,弹出账户、密码、api key、api secret、授权端口、授权同步 弹窗。授权方式支持广告账户、管家账户授权,管家账户时,授权成功后会将其子账户信息一并拉取回来。

获取api key、api secret详见:https://open.e.360.cn/api/application.html#%E5%BC%80%E9%80%9A%E6%B5%81%E7%A8%8B

注:提交开通api key、api secret申请,审批通过后系统会将ApiKey和ApiSecret发往您的邮箱

8. 阿里-超级汇川

点击添加账号,弹出授权方式、账户、密码、授权token 、授权端口、授权同步弹窗。授权方式可选广告账户、管家账户,当选择管家账户时,授权成功后会将其子账户信息一并拉取回来。授权端口主要是控制该账户信息在广告分析报表中的数据展示。

获取授权token详见https://open2.sm.cn/static/openweb/#/devcenter/api

9. 搜狗广告投放平台(已经下线)

搜狗官方通知,搜狗搜索平台于2022年2月15日停止广告投放,2022年2月28日正式下线。受此影响,神策广告分析不再支持「搜狗-搜索推广」渠道,可转移至腾讯广告平台投放搜索广告

点击添加账号,可以选择添加两种授权方式:广告账户、管家子账户

选择广告账户时弹出账户、密码、授权token、授权端口、授权同步弹窗;选择管家子账户时弹出账户、管家账户、管家密码、管家授权token、授权端口、授权同步弹窗。

当授权方式选择管家账户时,授权成功后会将其子账户信息一并拉取回来。授权端口主要是控制该账户信息在广告分析报表中的数据展示。授权同步可控制本次授权信息使用在哪个项目中。


10. 快手-磁力智投

点击添加账号,弹出app_id、secret、授权端口、授权同步弹窗。授权端口主要是控制该账户信息在广告分析报表中的数据展示。

如何获取appid、secret,请继续往下认真阅读配置详情

2.获取appid及secret前需要先找磁力引擎销售或者代理商开通开发者权限,详见:https://developers.e.kuaishou.com/docs/dsp/0.1

3.开发者注册成功后,进入应用管理-添加应用,并填写应用信息(下图标红1)及回调地址(下图标红2)

应用信息:代表广告主的mktapi授权给第三方的客户端,最多同时创建3个应用,用于同时授权相关权限给服务商,建议以“神策”为服务商单独创建应用,且保证不与其他服务商应用混用。

回调地址:http://ads-authorization.sensorsdata.cn/ads/api/n/platform/callback/{appid}

示例:http://ads-authorization.sensorsdata.cn/ads/api/n/platform/callback/13323232323

4.添加应用成功后,复制APPID(下图标红1),并点击设置将APPID粘贴到步骤3中填写的回调地址最末尾,并记录APPID及明文后的Secret(下图标红2),填写到步骤1中app_id、secret弹窗内。

5.将app_id、secret填写完成后,跳转快手广告授权界面选择授权账号,分别支持基于广告账户授权及基于用户授权,确认授权后即可开始通过mktapi同步今天及以后投放数据

注意:如需拉取授权日之前更早的数据,需要联系技术支持同学并给出需要开始同步的时间。

11. ASA-苹果搜索广告

点击添加账号,弹出私钥信息、公钥信息、clienid、teamid、keyid、授权端口弹窗。授权端口主要是控制该账户信息在广告分析报表中的数据展示。

拷贝公钥信息到苹果搜索后台保存后,拷贝clienid、teamid、keyid信息,填写到如下位置后,点击「提交」

详细请参考:ASA-苹果搜索广告

12. 华为应用商店

点击添加授权账户后,填写授权信息。

支持两种授权模式:【直客账户】和【客户投放伙伴账户】

注意:当您应用对应的投放账户由「客户投放伙伴」更换由「直客」类型时,为了确保报表能够正确看数据,请务必先完成「直客账户」的授权,然后重新创建一条新的监测链接进行投放,否则可能会出现后链路数据对不上的情况

12.1. 授权时需填写客户端ID密钥

获取流程请见华为文档:https://developer.huawei.com/consumer/cn/doc/development/AppGallery-connect-Guides/agcapi-getstarted-0000001111845114#section103mcpsimp

  • 若您为直客,请直接使用您的开发者帐号创建API客户端和获取 Access Token。
  • 若您为客户投放伙伴,需要使用客户投放伙伴主账号创建API客户端和获取 Access Token。

并且务必注意选择客户端对应的角色为【管理员】

创建完客户端后,还需要向华为发送邮件申请【获取报表数据】以开通 Marketing API 权限。

注意区分直客和客户投放伙伴申请模版,请见华为文档 https://developer.huawei.com/consumer/cn/doc/distribution/promotion/bp-functions-marketing_api-apply-0000001385274412 

A)客户投放伙伴申请模版:

    APP名称:投放操作账号正在推广的APP名称
    APPID:投放操作账号正在推广的APP ID(华为侧APP ID)
    客户投放伙伴主账户UID: 代理侧提供此账号ID

B)直客申请模版:

APP名称:投放操作账号正在推广的APP名称

APPID:投放操作账号正在推广的APP ID(华为侧APP ID)

直客 UID:需要直客在推广后台查询,查询位置如下图:

12.2. 华为账号ID获取方式:

账号登录状态下,点击「账户ID:xxxxxxx」位置,弹窗中的华为账号即为华为账号ID。

  • 直客体系下的账户类型需要为:直客 或 直客(团队管理) 
  • 客户投放伙伴体系下的账户类型需要为:投放操作账户,即具体投放广告的账号

13. 华为鲸鸿动能

在华为鲸鸿动能账户列表页面中,点击【添加授权账户】弹出授权页面,即可开始进行华为鲸鸿动能广告账户授权,其中授权方式可选广告账户、管家账户,当选择管家账户时,授权成功后会将其子账户信息一并拉取回来。授权端口主要是控制该账户信息在广告分析报表中的数据展示。

13.1. 授权前准备

在进行广告账户授权前,需要获取账户ID、客户端ID、密钥信息,并进行相关权限的申请,具体步骤如下:

13.1.1. 步骤一:进行华为联盟开发者认证

授权前,需要完成华为联盟开发者认证,开发者主体与广告投放账号主体一致。具体请参考如下文档:https://developer.huawei.com/consumer/cn/doc/distribution/promotion/ads_api06-0000001059044288

13.1.2. 步骤二:创建客户端,获取客户端ID以及密钥

完成华为联盟开发者认证后,登录开发者账号,点击HMS API 服务>凭证>OAuth2.0客户端ID 创建客户端。

按照如下部分填写信息,其中回调地址、应用访问地址为:http://ads-authorization.sensorsdata.cn/ads/api/n/platform/callback/

创建完成后,即可获得【客户端ID】以及【密钥】

添加应用成功后,点击【编辑】,将客户端ID粘贴到步骤3中填写的回调地址以及应用访问地址的最末尾,即为如下格式:http://ads-authorization.sensorsdata.cn/ads/api/n/platform/callback/客户端ID,点击【提交】完成客户端的设置。

具体请参照此文档:https://developer.huawei.com/consumer/cn/doc/distribution/promotion/ads_api07-0000001057938571

13.1.3. 步骤三:为客户端ID申请调用权限

获取到客户端ID后和密钥后,需要为客户端ID申请调用权限,通过邮箱申请权限,主送产品经理liuqianhui1@huawei.com,抄送对应行业运营。

邮件模板如下:

邮件标题申请开通鲸鸿动能Marketing API服务

邮件正文申请开通如下应用的推广服务权限

登录开发者联盟的华为帐号:开发者联盟平台帐号

开发者企业名称:在开发者联盟实名认证的企业名称}

客户端ID:步骤二中获取到的客户端ID 

登录广告平台的华为帐号:鲸鸿动能投放平台帐号

广告主企业名称:在广告平台实名认证的企业名称

投放平台账户ID:投放账户ID

回调地址:与步骤二中申请客户端ID中的填写回调地址一致

认证方式:授权码模式

具体请参照此文档:https://developer.huawei.com/consumer/cn/doc/distribution/promotion/ads_api08-0000001059204274

其中投放平台账户ID获取位置如下:

13.2. 进行授权操作:邮件申请权限通过后,即可进入添加账户授权页面,填写账户名称、账户ID、客户端ID、密钥等信息,完成账户授权

账户名称:用户标记广告广告账户

账户ID:与步骤三中邮件申请模板中的「投放平台账户ID」一致

客户端ID:步骤二中获取的客户端ID

密钥:步骤二中获取的密钥


并点击【确定】。进入华为账户登录页面。此时登录的广告账户需要与步骤三邮件申请中的投放平台账户、授权时填写的账户ID为同一广告账户。如不一致,会导致授权失败或者导致广告投放报表中无法拉取华为鲸鸿动能数据。


点击【登录】后,进入华为账号授权页面,点击【授权】,完成华为鲸鸿动能广告账户授权。


14. VIVO营销平台

在VIVO营销平台账户列表页面中,点击【添加授权账户】弹出授权页面,即可开始进行VIVO营销平台广告账户授权。授权端口主要是控制该账户信息在广告分析报表中的数据展示。

点击【确定】,进入VIVO营销平台授权界面,登录需要授权的广告账户(非代理商平台账号),同意授权时请勾选「我已认真阅读并同意《vivo商业开放平台服务协议》」。

点击【同意授权】后,即可完成VIVO营销平台广告账户授权。

注:

VIVO营销平台广告账户授权之后,方可通过点击监测链接配置回传方案后回传用户行为数据场景。如变更广告账户授权,则会影响用户行为回传,请谨慎操作。

15. 微博-超级粉丝通

在微博-超级粉丝通的账户列表页面中,点击【添加授权账户】弹出授权页面,即可开始进行微博-超级粉丝通的账户授权。

  • 支持【广告账户】和【广告账户及其子账户】授权。
  • APP ID 可在微博开放平台创建应用后获取。
  • 授权端口主要是控制该账户信息在广告分析报表中的数据展示。

15.1. 【可选】步骤一:配置子账户

若您有操作多个广告账户的需求时,可使用微博的「子账户管理」能力,只需一次授权,被授权账户的子账户即可与被授权账户共享相同接口调用权限。

具体可在微博投放平台 - 账户 - 授权关系 - 我管理的账户处添加授权账户。

其中账户 UID 可以从登陆时的 url 中的 customer_id 字段中获取

然后登陆对应账户接受授权,即可建立绑定关系。

15.2. 步骤二:创建开发者应用

使用超级粉丝通账户登陆 https://developers.biz.weibo.com 即可注册成为 API 开发者,无需额外操作。

然后只需填写少量信息即可创建应用。

回调url:初次提交时可以填写 http://ads-authorization.sensorsdata.cn/ads/api/n/platform/callback/ 等应用创建成功后,复制App ID,点击编辑按钮,将 App ID 拼接在回调地址后,方算配置完成。

调试账号:无需填写。仅用于在沙箱环境中依据提供的测试账号创造一个或多个虚拟广告账户(真实环境中开户流程比较繁琐),以便接口调试。

调用权限勾选:【超粉只读权限】& 【数据查看权限】。其中前者用于获取授权账户的 ID 和名称等信息,后者用于获取数据报表数据。

注意:若您无需使用api进行广告创建和投放,请勿勾选投放权限,一旦您勾选投放权限,您的应用将进入沙箱调试环境,届时若需要切换回线上环境须提前联系销售申请。

频控限制:微博对每个开发者应用都设置了调用频次限制,以及 Token 到期天数限制默认 90天,每过90天需要重新进行登录授权流程)。只读账号会默认接入 LEVEL_3 级别的频次控制,详情参考 微博频次限制说明文档。若需要接入其他级别控制,请联系对应微博渠道负责。

15.3. 步骤三:SAT 添加授权账户

1、前往 SAT - 管理与配置 - 广告账户授权 - 微博超级粉丝通,点击【添加授权账户】。

  • App ID:将创建完成的应用 App ID 粘贴至此处。

2、填写完毕后点击【确定】按钮,跳转至微博授权页面。

  • 注意:某些浏览器(如 safari、chrome)出于安全策略拦截,可能会拦截微博的授权页面,需要手动在地址栏右侧点击允许弹出。

3、确认左上角登陆的是需要授权/拉数的广告账户,并至少勾选【超粉只读权限】&【数据查看权限】。

4、点击授权按钮后,返回神策广告分析完成授权。

16. 知乎效果营销

在知乎效果营销的账户列表页面中,点击【添加授权账户】弹出授权页面,即可开始进行知乎效果营销的账户授权。

1、授权方式

授权方式为广告账户。

2、advertiserId 

advertiserId 可在知乎效果营销平台(https://xg.zhihu.com/)登陆后的 url 中获取。

3、token

token 可在知乎广告账户登录状态下访问接口 https://xg.zhihu.com/api/v1/canvas/token 获取。

4、授权端口

授权端口主要是控制该账户信息在广告分析报表中的数据展示。知乎效果营销的数据可在信息流报表中查看。

17. OPPO营销平台

在OPPO营销平台账户列表页面中,点击【添加授权账户】弹出授权页面,即可开始进行OPPO营销平台账户授权,其中授权方式为广告主账号方式。广告主ID、API- ID、API-KEY从OPPO营销平台中获取,授权端口主要是控制该账户信息在广告分析报表中的数据展示。

广告主ID、API- ID、API-KEY获取位置:OPPO营销平台-工具箱- API密钥获取,进入如下页面后即可获取。注意,授权之后,请不要「刷新密钥」,否则会导致授权失败,影响广告投放报表拉取数据。

18. 小米营销平台

在小米营销平台账户列表页面中,点击【添加授权账户】弹出授权页面,即可开始进行小米营销平台账户授权,其中授权方式为广告主账户、代理商账号方式。账户名称,为标记当前账户,账户ID、Sign Id、Secret Key 需要在小米开发平台获取。授权端口主要是控制该账户信息在广告分析报表中的数据展示,填写完毕后,点击【确定】进行授权。

注意:小米MarketingAPI存在白名单,授权前需要先开通权限,涉及的媒体文档为https://api.e.mi.com/doc.html#/1.0.0-mdtag97f0f-omd/document-e11d9bba0eaf1cda48c2af4884311b23

如下为获取 账户id、Sign Id、Secret Key步骤:

步骤一:登录小米广告账户,进入广告平台后,在右上角即可获得账户ID

步骤二:登录小米营销平台广告账户,然后进入小米营销页面,点击【开放平台】

步骤三:进入【账户对接】页面,填写邮箱,点击提交后,小米会发送对应的邮件,邮件中包含Sign Id  以及 Secret Key

邮件内容:

19. 喜马拉雅-声量

在喜马拉雅-声量的账户列表页面中,点击【添加授权账户】弹出授权页面,即可开始进行喜马拉雅-声量的账户授权。

  • refresh_token:需向媒体发送邮件申请开通 MKT-API 管家后台,通过后获得
  • 授权端口主要是控制该账户信息在广告分析报表中的数据展示。

19.1. 步骤一:向媒体发送 MKT-API 管家后台的申请邮件

请注意,媒体侧可能会随时修改自己的申请流程,建议找媒体侧对接人确认最新对接流程。

以下流程为本文档撰写之时所获悉的媒体侧开通方式,喜马拉雅-声量媒体侧拥有最终解释权。

邮件标题【MKT-API管家后台申请】

收件人:lareina.guo@ximalaya.com 抄送:wenyue.ren@ximalaya.com,weiwei.li@ximalaya.com,rui.wu@ximalaya.com

正文:

需求描述:xx

公司主体:xx

开通账户id(主播id):xx(多个账户请用英文逗号隔开)

注:客户需要在发邮件时,将所有需要开通 MKTAPI 能力的账户 ID 一并写在邮件中。 需尽量保证所有喜马拉雅账户 id 均在申请的公司主体下,否则媒体侧可能审核不通过

审核通过后,运营人员会回复公司主体对应的 refresh_token。使用该 token 即可拉取到所有申请账户下的数据。 

以下为邮件示例截图。

19.2. 步骤二:填写 refresh_token,完成授权

当收到媒体回复的邮件后,即可获取公司主体对应的 refresh_token。

该 refresh_token 具有公司主体下所有开通的广告账户id 的 MKTAPI 权限。

将 refresh_token 填写至授权管理页面中的 refresh_token 字段中,点击「提交」即可完成授权。

授权成功后,就可以通过 MKTAPI 将 refresh_token 主体对应的所有广告账户(有几个就授权几个)的数据都拉取到信息流报表中。

20. 荣耀商推平台

在荣耀商推平台的账户列表页面中,点击【添加授权账户】弹出授权页面,即可开始进行荣耀商推平台的账户授权。

授权前,需要向荣耀运营经理申请开通 Marketing API 权限,并获取ClientID、SecretID,并填入授权的广告账户ID,点击「提交」,完成账户授权。

21. 常见问题

21.1. 华为应用商店广告账户如何区分是直接类型,还是客户投放伙伴类

登录广告账户,点击账户信息,可根据账户类型进行区分。

21.2. VIVO营销平台广告账户授权失败?

不支持二代账户进行VIVO营销平台广告账户授权,请使用广告主账户进行授权,具体二代账户、广告主账户的定义,请参考https://open-ad.vivo.com.cn/doc/index?id=163

21.3. 巨量广告账户授权,为何存在No permission to operate account *问题

使用登录账号A进行授权,账号A下的广告账户为1、2、3。次后使用登录账号B进行授权,账号B下的广告账户为1、4、5。 此时广告账户1为重复授权的广告账户。因为会出现上述问题。此时,按照授权的先后循序,需要把登录账号A下的广告账户1关闭即可。

21.4. 如果提示授权成功,但是账户列表没有显示怎么办?

可能是因为数据延迟等原因,手动点击【刷新】即可。

21.5. 如果账号授权后,又在当前的授权账号下新增了其他的广告账户,该怎么办?

请重新进行授权,以此添加新的广告账户。

21.6. 账号授权后,当前的授权账号下若移除了某些广告账户,会导致被移除账户授权失效,无法拉取对应账户的数据,此种情况该怎么办?

请手动关闭对应的广告账户或者重新授权。

21.7. 授权成功后,广告投放报表中没有数据怎么办?

这是因为 SAT 的定时任务还在拉取数据中,请耐心等待即可。 另外,媒体提供的 Marketing API 接口往往会有延迟,若需在广告投放报表中查看前一天完整的投放数据,一般需要等第二天才能拉齐哦。