menu
Is this helpful?

# Microsoft Advertising 集成方案

TIP

请注意,第三方数据集成产生的数据会被纳入集群的消耗数据量

# 概要

# 接口简介

接口名 类型 粒度 归因 成本 收益 展示 点击 转化
Bing Ads API API 聚合指标

Bing Ads API 是 Microsoft Advertising 的广告 API,其中的 Reporting API 提供了一系列广告数据报表的查询接口,目前 TE 系统支持拉取报表类型为 AdPerformanceReport 的数据。

# 集成流程

Microsoft Advertising 数据的接入流程如下:

  1. 登录 Azure 平台 (opens new window) 并创建一个应用,并生成应用的 Client Secret
  2. 向 TE 工作人员提供用于 Client ID 以及 Client Secret,配置回调地址,并在 TE 工作人员提供的授权页面中登录 Microsoft 账号,完成授权
  3. 登录 TE 后台,进入三方集成模块,新增 Microsoft Advertising 回传方案,完成相关配置并获取回调地址
  4. 查看 TE 系统否成功接收数据,并完成报表搭建

# 一、注册应用并获取授权信息

# 1.1 注册应用并获得 Client ID 与 Secret

在使用 Bing Ads API 拉取数据前,您需要准备好一个 Azure 应用。如果您尚未创建 Azure 应用,则可以按照本节完成应用的创建

  1. 使用 Microsoft 账号登录 Azure 平台 (opens new window)

  2. 点击「注册应用程序」

  3. 在「注册应用程序」页面,输入应用名称(自定义),在「受支持的账户类型」处,选择「任何组织目录(任何 Azure AD 目录 - 多租户)中的帐户和个人 Microsoft 帐户(例如,Skype、Xbox)」选项,点击「注册」完成应用的创建

  4. 应用创建完毕后,在「概述」页面的「概要」部分,可以查看应用的客户端 ID(即 Client ID)

  5. 点击「添加证书或机密」,在「证书和密码」页面点击「+新客户端密码」,输入说明与期限(无要求)后,完成客户端密码(即 Client Secret)的创建,请在离开页面前复制并保存下图红框处的密码值。

WARNING

如果您在创建应用后,不清楚如何回到应用设置页面,可以在 Azure 后台的顶部搜索栏搜索「应用注册」/「App Register」

# 1.2 获取 Developer Token

接下来,如果您还需要获取 Developer Token,请进入 Microsoft 开发者官网 (opens new window)(如未登录,请登录广告账号的 Microsoft 账号)。点击「Request Token」申请 Developer Token。申请成功后,请保存 Developer Token。(如果您正在管理他人的帐户,最多可能需要五个工作日才能获得 Developer Token)

# 1.3 获取广告账号的 account ID 和 customer ID

最后,您还需要向 TE 工作人员提供需要拉取数据的广告账号的 account ID 和 customer ID。请登录 Microsoft 广告后台 (opens new window),在页面左上角切换至您需要拉取数据的广告账号,接着在浏览器地址栏中,您可以看到 aid 与 cid 参数,aid 对应广告账号的 account ID,cid 对应广告账号的 customer ID,请保存这两个 ID。

至此,您已经完成了所有集成 Microsoft Advertising 数据前的准备工作,总结一下您获得的所有授权信息:

  • Client ID
  • Client Secret
  • Developer Token
  • 广告账号 Account ID
  • 广告账号 Customer ID

# 二、方案配置

当您完成在 Microsoft Advertising 平台的准备工作后,您可以登录 TE 系统,在「三方集成」模块中完成新方案的配置。下图是 Microsoft Advertising 的配置界面,请您按照本章节内容完成方案的创建

# 2.1 授权信息配置

点击「授权信息」按钮,在弹出框内填写您在上一步中获得的信息:

# 2.2 定时拉取

您可以在「定时拉取」模块设置 TE 系统定时拉取 Microsoft Advertising Bing Ads API 数据的策略,可以选择在每天的某时拉取一段时间的数据。由于拉取的数据也会计算再数据量中,建议您在不要定时拉取太长时间的数据

# 2.3 入库设置

您可以控制数据是否以事件的形式写入,如果关闭,则数据将不会写入事件表,因此请不要关闭该配置。

# 2.4 集成配置

最后,您可以在集成配置模块对数据拉取的细节配置进行控制。包括数据的时间聚合粒度,拉取的指标字段与维度,以及入库后的事件名等。

集成配置中的内容是一个 JSON,您可以按照以下内容进行自定义配置:

模块 名称 含义
sink_event event_name 入库后的事件名,可以自定义
source metrics 数据中的指标,列表类型,可以自定义
group_by 数据中的分组维度,列表类型,可以自定义

以下列举的是 AdPerformanceReport 可用字段中的常用部分,如需了解所有字段,可以访问 Bing Ads API 官网文档 (opens new window)

  • 分组维度

以下展示的是常用的分组维度,如需调整的话,可以将字段名写入到 source.group_by 中:

字段 描述 是否默认
TimePeriod 时间
AccountName 广告账号名
AccountNumber 广告账号值
AccountId 广告账号 ID
AccountStatus 广告账号状态
CampaignName Campaign 名
CampaignId Campaign ID
CampaignStatus Campaign 状态
CampaignType Campaign 类型
AdGroupName 广告组名
AdGroupId 广告组 ID
AdGroupStatus 广告组状态
AdTitle 广告名
AdId 广告 ID
AdDescription 广告描述 1
AdDescription2 广告描述 2
AdType 广告类型
AdStatus 广告状态
AdLabels 广告标签
CurrencyCode 结算货币代码
AdDistribution 媒体渠道类型
Network 媒体渠道
TopVsOther 曝光具体位置(版位)
BidMatchType 竞价匹配模式
CustomerId 广告账户的客户 ID
CustomerName 广告账户的客户名
CustomParameters 自定义参数
DestinationUrl 目标 URL 地址
DisplayUrl 广告展示 URL
DeliveredMatchType 广告展示匹配模式
DeviceType 设备类型
Language 语言
DeviceOS 设备系统
Goal 转化目标事件
GoalType 转化目标事件类型
- 指标字段

以下展示的则是常用的指标字段,如需调整,请将指标字段名写入 source.metrics 中:

指标字段 描述 备注 是否默认
Impressions 曝光数
Clicks 点击数
Ctr 点击通过率
AverageCpc 平均 CPC
AverageCpm 平均 CPM
Spend 总支出
Conversions 转化数(过时)
  • 不包含 ExcludeFromBidding 为 true 的 Campaign 的数据

  • 需具备 Microsoft Advertising Universal Event Tracking

ConversionsQualified 转化数(新版,可能无法获取)
ConversionRate 转化率
Revenue 收益
RevenuePerConversion 平均转化收益
CostPerConversion 平均转化成本
ReturnOnAdSpend ROAS
AllConversions 总转化数(过时)
  • 需具备 Microsoft Advertising Universal Event Tracking
AllConversionsQualified 总转化数(新版,可能无法获取)
AllConversionRate 总转化率
AllRevenue 总收益
AllRevenuePerConversion 平均转化总收益
AllCostPerConversion 平均转化总成本
AllReturnOnAdSpend 总 ROAS
Assists 协助转化
CostPerAssist 平均协助转化成本
RevenuePerAssist 平均协助转化收益
AbsoluteTopImpressionRatePercent 广告位首位展示率 展示在搜索结果首位占总曝光的比例
TopImpressionRatePercent 广告位主结果展示率 展示在搜索结果中占总曝光的比例
ViewThroughConversionsQualified View-Through 转化数(过时)
ViewThroughConversions View-Through 转化数(新版,可能无法获取)

# 2.5 数据入库规则

  • 使用数据中的 TimePeriod 字段,即数据的日期,设置为聚合数据的 #event_time
  • 数据事件名为 -- bing_ads_adperformance
  • 其余字段都将会入库

# 2.6 完成授权

完成配置后,您可以点击右上角的「保存并授权」将方案配置保存下来。接下来,您需要完成最后的授权工作:

首先,请在弹出的「授权信息」页面中,将第一步中的地址复制下来

接下来,进入到 Bing Ads 后台,请您在应用「概述」页面的「概要」部分,点击「添加重定向 URI」。接下来在新页面中点击「添加平台」,将授权地址填入「重定向 URI」的输入框中,点击「配置」、「保存」完成回调地址的配置。

完成回调地址的配置后,请回到 TE 后台,在「授权信息」弹窗中点击前去授权按钮,在打开的地址中登录您需要接入广告账号所绑定的 Microsoft 账号,完成授权。

当您完成了授权之后,请在「授权信息」中点击左下角的「我已完成以上两步操作」后点击右下角的「完成授权」结束配置。至此,您完成了 Microsoft Advertising 的数据集成。

# 2.7 标准化字段

Microsoft Advertising Bing Ads API 数据中的部分字段,TE 系统会进行标准化处理:

字段 标准化字段 含义
accountid te_ads_object.ad_account_id 广告账号 ID
campaignname te_ads_object.campaign_name 广告计划名
campaignid te_ads_object.campaign_id 广告计划 ID
adgroupname te_ads_object.ad_group_name 广告组名,变现广告的 Unit 名
adgroupid te_ads_object.ad_group_id 广告组 ID,变现广告的 Unit ID
adtitle te_ads_object.ad_name 广告名
adid te_ads_object.ad_id 广告 ID
topvsother te_ads_object.placement 广告位置
network te_ads_object.media_source 媒体渠道或变现渠道
currencycode te_ads_object.currency 成本或收益的币种
impressions te_ads_object.impressions 曝光量
clicks te_ads_object.clicks 点击量
spend te_ads_object.cost 买量成本
revenue te_ads_object.revenue 收益