Search Ads 归因API

概览

Search Ads归因API使iOS开发人员能够跟踪和归因源自Search Ads系列的应用下载。借助Search Ads归因API,开发人员可以准确衡量新用户的价值及其广告活动的有效性。

主要优点

安装启用

要为您的应用启用搜索广告归因功能,请按以下步骤操作:

  1. iAd framework:在Xcode工程将iAd framework添加到您的应用程序中。
  2. iAd 相关头文件:在包含您的归因代码的文件中导入iAd 相关头文件。
  3. Search Ads归因:在您的应用中,检查搜索广告归因。
  4. 错误处理:处理错误并在需要时重新检查。
  5. “Phone Home”:“Phone home”并将下载的数据发送到您的服务器。

要求

要为您的应用启用搜索广告归因功能,请按以下步骤操作:

iAd framework

iAd框架与Xcode捆绑在一起。按照以下步骤将iAd框架添加到应用程序的Xcode项目文件中:

  1. 定位到target view,然后选择General。
  2. 向下滚动到“链接框架和库”部分,然后单击加号(+)图标。
  3. 在下拉菜单中,搜索iAd。
  4. 选择iAd.framework并单击“Add”按钮。

iAd 头文件

将iAd头文件导入您的应用,通常导入到包含您的归因代码的文件中。此头文件取决于您在Xcode中编译应用程序的iOS版本。搜索广告归因需要iOS 10.0或更高版本。

Search Ads attribution

在您的应用中,检查一次搜索广告的归因,例如首次打开或注册完成时。将数据存储在本地,这样您就不需要再次调用。

 

错误处理

如果需要,处理您收到的任何错误并重新轮询数据。使用ADClientErrorDomain捕获返回的错误。

在Search Ads 归因 API中,有两个错误值:ADClientErrorUnknown和ADClientErrorLimitAdTracking。如果收到ADClientErrorUnknown,请等待几秒钟再试一次。成功检索归因数据后,您无需再次轮询数据;您检索到的值不会改变。 如果您收到ADClientErrorLimitAdTracking,则表示用户已在其iOS设备上启用了限制广告跟踪功能。没有关于此用户的广告点击和转化的数据。

"Phone Home”

将下载的数据发送到您的服务器。当您的应用程序获取到NSDictionary对象时(在下面的示例中此对象为attributionDetails),您可以使用您想要的任何用户注册数据并使用您选择的任何方法将数据上传到您的服务器。

返回值

此表显示Search Ads Attribution API返回的数据字典里的键及其数据类型。

Dictionary Key Type Comments
iad-attribution Boolean True/False,如果用户下载APP前30日内点击了Search Ads广告为True
iad-click-date Date/time string 用户点击广告的日期和时间
iad-conversion-date Date/time string 用户点击广告后下载APP的日期和时间
iad-purchase-date Date/time string 用户首次下载APP的日期和时间。当iad-conversion-type = “Redownload”时,其表示原购买日期。这个字段与广告不一定有必然联系。
iad-conversion-type String 表明是否首次下载。"Redownload"说明用户在本设备下载/卸载过,或者用同一账户在其他设备下载过。iad-conversion-date指明了是点击广告后的最新一次下载。
iad-keyword-matchtype String 三种关键词匹配方式之一:Broad、Exact 或者 Search Match。
iad-org-name String Campaign所属的账户organization名称
iad-campaign-id Integer Campaign的ID
iad-campaign-name String Campaign的名称
iad-adgroup-id Integer Ad Group的ID
iad-adgroup-name String Ad Group的名称
iad-keyword String 触发广告展示的关键词
iad-creativeset-id Integer 创意的ID
iad-creativeset-name String 创意的名称

返回数据示例

此示例代码为在调用requestAttributionDetailsWithBlock时返回的数据结构。

常见问题

问:Search Ads Attribution API是否支持请求作为iTunes App Bundle一部分下载的应用的归因数据?

答:不,不支持作为iTunes App Bundle的一部分下载的应用程序的归属。

问:Search Ads Attribution API是否支持通过iOS Family Sharing进行的应用下载?

答:不,不支持通过“家庭共享”进行的应用下载归属。

问:我不是广告系列数据的所有者。如何获得有关广告系列中使用的定价或定位的更多信息?

答:请联系广告系列所有者以获取更多信息。归因数据中的广告系列ID和名称可以帮助您确定哪些广告系列用于宣传您的应用。

问:我怎么知道何时会获得归因数据以及何时不会?

答:当用户点按“搜索广告”展示并在点击后30天内下载或重新下载相应的归因启用应用时,系统会提供归因数据。

附加标准:

问:我的广告系列的归因转化次数与我在“搜索广告”报告中看到的转化次数不同。差异在哪儿?

答:差异主要在以下几点:

限制广告跟踪

已启用“限制广告跟踪”(LAT On)的用户的转化次数将显示在“搜索广告”报告中,但不会用于“搜索广告”归因。

应用程序下载 VS 应用程序打开

搜索广告会在用户下载应用时计算,而搜索广告归因API仅在应用打开时计算。

点击“延迟”

点击搜索广告展示的大多数用户会立即下载该应用。当应用程序立即打开并调用搜索广告归因API时,由于某些延迟,我们的系统可能尚未处理相应的广告点击。我们建议您在检索归因数据之前设置几秒钟的延迟。