Search Ads 归因API

设置Apple Search Ads归因

通过检索归因字典来确定有意义的指标。

总览

归因字典包含归因数据，这些归因数据是从用户与来自Apple Search Ads广告系列的广告进行的互动中获取的。 要检索属性字典，请依次执行以下过程。

将iAd框架添加到您的Xcode项目

iAd框架与Xcode捆绑在一起。 您需要将其添加到应用程序的Xcode项目文件中。

1. 定位到target view，然后选择General。
2. 向下滚动到“链接的框架和库”部分，然后单击加号（+）图标。
3. 在下拉菜单中，选择“ iAd.framework”，然后单击“添加”。
4. 将 导入到您的应用中。 通常放在包含您的归因代码的文件中。 iAd头文件对应于您在Xcode中为其编译应用的iOS版本。 Apple Search Ads归因需要iOS 10.0及更高版本。

有关框架的更多信息，请参见在应用程序中嵌入框架。

检索归因字典

实现requestAttributionDetails(_:)方法以检索包含归因对象的字典。 接下来，检查Apple Search Ads归因，例如在首次打开时或注册完成后。 将数据存储在本地，因此您无需重复方法调用。

// Check for iOS 10 attribution implementation
if ([[ADClient sharedClient] respondsToSelector:@selector(requestAttributionDetailsWithBlock:)]) { 
NSLog(@"iOS 10 call exists"); 
[[ADClient sharedClient] requestAttributionDetailsWithBlock:^(NSDictionary *attributionDetails, NSError *error) { 
// Look inside of the returned dictionary for all attribution details
NSLog(@"Attribution Dictionary: %@", attributionDetails); 
}];
}

以下示例代码显示了在调用requestAttributionDetails(_:)时可以期望接收的字典结构：

{ 
"Version3.1" = { 
"iad-attribution" = true; 
"iad-org-name" = "org name";
"iad-org-id" = “555555”;
"iad-campaign-id" = "12345678"; 
"iad-campaign-name" = "org launch"; 
"iad-purchase-date" = "2019-10-14T17:18:07Z" 
"iad-conversion-date" = "2019-10-14T17:18:07Z"; 
"iad-conversion-type" = "Download"; 
"iad-click-date" = "2019-10-14T17:17:00Z"; 
"iad-adgroup-id" = "12345678"; 
"iad-adgroup-name" = "org launch group"; 
"iad-country-or-region" = "US"; 
"iad-keyword" = "keyword";
"iad-keyword-id" = 12345678";
"iad-keyword-matchtype" = "Broad";
"iad-creativeset-id" = "12345678";
"iad-creativeset-name" = "Nature Images";
}

归因数据报告需要满足以下条件：

• 所有操作必须在同一设备上发生。
• 归因仅适用于运行iOS 10或更高版本的用户，并且在过去30天内下载了该应用。
• 必须从App Store列表或Apple Search Ads 展示中进行下载或重新下载。

下载归因数据

应用检索到归因字典后，可以将归因数据上传到服务器。

以下列表显示了Apple Search Ads Attribution API返回的数据字典键和数据类型。

字段	类型	说明
iad-attribution	Boolean	如果用户在应用下载前30天点击了Apple Search Ads广告，则为True。
iad-org-name	String	广告系列所属的账户组织名称
iad-org-id	Integer	广告系列所属的账户组织ID
iad-campaign-id	Integer	广告系列ID
iad-campaign-name	String	广告系列名称
iad-click-date	Date/time string	用户点击相应广告的日期和时间
iad-purchase-date	Date/time string	用户首次下载您的应用的日期和时间。 当iad-conversion-type的值为“Redownload”，此字符串表示原始购买日期。 该购买可能与Apple Search广告无关。
iad-conversion-date	Date/time string	用户通过点击Apple搜索广告下载您的应用的日期和时间。
iad-conversion-type	String	表明是否首次下载。"Redownload"说明用户在本设备下载/卸载过，或者用同一账户在其他设备下载过。
iad-adgroup-id	Integer	广告组ID
iad-adgroup-name	String	广告组名称
iad-country-or-region	String	广告系列相关的国家或地区
iad-keyword	String	带来广告展示次数并带来相应广告点击的关键字
iad-keyword-id	String	带来广告展示次数的关键字的ID
iad-keyword-matchtype	String	带来广告展示次数的关键字的匹配类型。 值是广泛匹配、完全匹配或搜索匹配。
iad-creativeset-id	Integer	相应广告所属的广告素材集的ID
iad-creativeset-name	String	相应广告所属的广告素材集的名称

有关已返回数据的可能错误，请参见处理错误。

苹果Search Ads API官方文档原文：https://developer.apple.com/documentation/iad/setting_up_apple_search_ads_attribution

量江湖翻译原文：https://www.liangjianghu.com/docs/attribution-api.html