开发人员指南概述

亚马逊广告 API 概览

如何使用亚马逊引流洞察 API

获得广告主的配置文件访问权限后,您可以使用亚马逊引流洞察 API 来读取以下与广告主相关的资源:

配置文件资源

配置文件代表特定站点中的广告主账号。每次调用亚马逊引流洞察 API 接口时,您必须将一个配置文件标识符作为 Amazon-Advertising-Api-Scope 标头进行传递。通过调用 /v2/profiles 检索您可以访问的配置文件列表。

广告主资源

警告

:亚马逊引流洞察广告主资源将在未来的 API 版本中废弃。目前支持所有配置文件,以确保向后兼容。仅支持广告平台配置文件的集成商不应使用此资源。

获取广告主资源 以检索与配置文件相关联的亚马逊引流洞察“广告主”列表。广告平台配置文件只能对应一个广告主。基于 DSP 的供应商广告主可能有多个亚马逊引流洞察广告主,但卖家始终只有一个。您可能需要将 advertiserId 作为可选参数传递给以下接口之一。

出版商资源

获取出版商资源 以检索所有支持的出版商的列表。列表中的每个项目包括出版商名称、出版商编号以及出版商标签是否包含宏,也称为动态参数。所有广告主的出版商资源都是相同的。在调用归因标签检索接口时,您将传递出版商编号。

如果您未看到列出的出版商,请通过亚马逊广告 API Support Jira Service Desk联系 API 支持团队。

归因标签资源

在获取广告主的 profileId 和出版商列表之后,选择要调用的归因标签资源 以检索标签。

亚马逊引流洞察提供的标签包括 Google Ads、Facebook、微软广告 (Microsoft Ads) 和 Pinterest 等出版商的宏。对于这些出版商,可以调用 /attribution/tags/macroTag。这些标签仅适用于预期的出版商,并使用该出版商提供的广告活动编号值。

对于不支持宏标签的出版商,请调用 /attribution/tags/nonMacroTemplateTag来检索标签。非宏标签要求您在标签参数中提供唯一的广告活动编号值。

警告

调用标签检索接口是为计划使用的每个配置文件启用成效衡量所需的必备步骤。请勿跳过此步骤,否则标签将无法正常工作。

亚马逊引流洞察的 API 标签与在亚马逊广告平台中创建的亚马逊引流洞察标签并不相同。请勿修改在亚马逊广告平台中创建的标签以便与 API 配合使用,也不要尝试使用 API 标签向在亚马逊广告平台中创建的广告活动添加新标签。

宏标签

使用给定出版商和广告主的宏标签,您可以对广告主在该出版商网站上的所有广告活动使用同一个标签。宏标签允许出版商在准备广告进行展示时将广告活动信息动态插入到点击后到达 URL 中。每个标签包含特定于出版商的宏,这些宏因出版商而异。

例如,以下是通过调用 macroTag 接口返回的 Google Ads 的假设宏标签:

"?maas=maas_adg_api_123456789_macro_1_99&ref_=aa_maas&tag=maas&aa_campaignid={campaignid}&aa_adgroupid={adgroupid}&aa_creativeid=ad-{creative}_{targetid}_dev-{device}_ext-{feeditemid}"

这是广告活动将跳转到的示例落地页 URL:

https://www.amazon.com/AmazonBasics-Performance-Alkaline-Batteries-Count/dp/B00MNV8E0C

在出版商的广告管理器中将标签应用于广告活动后,当出版商准备展示每个广告时,{campaignid}{adgroupid}{creative}{targetid}{device}{feeditemid} 宏将动态替换为实际的广告活动值。

在此示例中,生成的点击后到达 URL 将是:

https://www.amazon.com/AmazonBasics-Performance-Alkaline-Batteries-Count/dp/B00MNV8E0C?maas=maas_adg_api_123456789_macro_1_99&ref_=aa_maas&tag=maas&aa_campaignid=1234&aa_adgroupid=6789&aa_creativeid=ad-1357_kwd-123_dev-c_ext-2468

非宏标签

您还可以为不支持动态参数的出版商使用非宏标签,以便对引流到亚马逊品牌旗舰店或商品详情页的广告启用亚马逊引流洞察成效衡量。为了准备实施非宏标签,您首先需要通过调用 nonMacroTemplateTag 接口来检索广告主的非宏模板标签,然后您的系统可以在每次需要创建新标签时,填充 aa_campaignidaa_adgroupidaa_creativeid URL 参数的模板值。

以下是非宏标签模板示例。在未替换模板值之前,将无法正常使用。

?maas=maas_adg_api_123456789_static_9_99&ref_=aa_maas&tag=maas&aa_campaignid={campaignId}&aa_adgroupid={adgroupId}&aa_creativeid={creativeId}

注意

使用非宏标签时,同一个标签不能用于多个落地页 URL。如果需要更改有效标签的落地页,请使用唯一的创意素材编号来准备新标签,并将该新标签运用于更新后的落地页上。

警告

aa_campaignidaa_adgroupid、和 aa_creativeid 参数的值长度必须不超过 255 个字符(在所有宏扩展后),并且不能包含以下字符,即使是 URL 转义字符也不例外:/、&、=、#、?、+、’、”、%、$。

aa_campaignid 的值必须在账户中保持唯一。请勿在多个广告主之间或多个站点之间重复使用同一个广告活动编号。如果使用宏标签,请注意整理您的 3P 广告活动,以便每个亚马逊账户和站点都有单独的广告活动。

归因标签的实施

可以以任何有效的 URL 形式来实施归因标签,只要落地页是亚马逊品牌旗舰店或商品详情页即可。以下是实施归因标签的一些常见方法。

您可以将归因标签附加到落地页 URL 的末尾,并将生成的 URL 放入出版商的点击后到达 URL 字段中。部分出版商还允许将 URL 参数与落地页保持分离,并动态地将它们结合在一起。

亚马逊引流洞察标签可以附加到博客文章或电子邮件中以自然搜索方式使用的落地页 URL 中,就像通常创建亚马逊链接一样。

如果使用宏标签,则必须将其放置支持宏处理的字段中。这是出版商特定的规则,因此如果遇到问题,请查阅出版商的帮助文档。

对于部分出版商,您可以将归因标签作为点击追踪器来实施,在每次点击广告时触发追踪。这些追踪字段对于每个出版商都是不同的。请注意,仅当落地页是亚马逊品牌旗舰店或商品详情页时,归因标签才能正常使用。

对于社交网络上的广告活动,例如 Facebook,您可以在“URL参数”追踪字段中实施广告主的归因标签。

对于搜索广告活动,例如 Google Ads 和 Microsoft Ads,您可以在追踪模板字段中实施广告主的归因标签,前面加上 Google 的 {unescapedlpurl} 宏或 Microsoft 的 {lpurl} 宏。以下是一个 Google 的示例:

{unescapedlpurl}?maas=maas_adg_api_123456789_macro_1_99&ref_=aa_maas&tag=maas&aa_campaignid={campaignid}&aa_adgroupid={adgroupid}&aa_creativeid=ad-{creative}_{targetid}_dev-{device}_ext-{feeditemid}

如果没有其他追踪模板会产生干扰,您可以在广告活动级别实施归因标签。但应注意,如果在广告活动的不同级别实施了多个追踪模板,只有最低级别的追踪模板会触发。

警告

请删除点击链接中现有的 ref_tag 参数,以免干扰亚马逊引流洞察的ref_tag 参数。如果 URL 中包含两个同名的参数,成效衡量结果将不准确。

成效衡量

当点击包含亚马逊引流洞察 API 标签参数的亚马逊品牌旗舰店或商品详情页链接时,将触发亚马逊引流洞察推断广告活动的结构,并在亚马逊上衡量点击归因的转化事件。对于给定的配置文件,只有来自该配置文件的带有亚马逊引流洞察标签的链接才会被考虑进行转化归因,并且在 14 天的归因期内最后点击的标签将获得全部归因功劳。转化将不会归因于亚马逊广告或任何其他未被给定配置文件标记的链接。

亚马逊引流洞察将使用 aa_campaignidaa_adgroupidaa_creativeid 参数中的值自动创建亚马逊引流洞察广告活动、广告组和创意素材。创建广告活动后,促销商品将自动关联到广告活动,以便对这些商品启用转化指标成效衡量。点击前往商品详情页后将自动将该商品及其变体关联到广告活动。点击前往亚马逊品牌旗舰店后将自动关联品牌旗舰店页面上列出的商品与广告活动。

自动创建了广告活动、广告组和创意素材后,并且商品已自动关联到广告活动后,亚马逊引流洞察将对点击量、转化量和销量进行成效衡量和报告。关联商品的转化将在报告中显示为“促销”转化指标。“总计”和“品牌光环”转化指标将反映同一品牌的非促销商品的转化情况。

注意

如果您的品牌旗舰店页面使用可实时选择要显示的商品的动态小部件,则这些商品可能不会被亚马逊引流洞察关联到您的广告活动。例如,“畅销商品”、“推荐商品”、“精选促销”等动态小部件,或者由搜索关键词提供支持的商品陈列型/商品列表。为解决这个限制,请直接将您希望衡量的 ASIN 添加到您的品牌旗舰店页面。

报告资源

在实施了归因标签并且顾客点击了您的链接后,调用报告接口 来检索报告。点击量指标可能需要最多 24 小时才会显示,转化量指标可能需要最多 48 小时。

有两种报告可供选择: 效果报告和商品报告。您可以通过输入可选的 reportType 请求体属性,并将其值设置为 PERFORMANCE(默认)或 PRODUCTS 来访问每种报告类型。每种报告类型在聚合级别、维度和指标方面有所不同。对于效果报告,您可以通过传递 groupBy 请求体属性并将其值设置为 CAMPAIGN、ADGROUP 或 CREATIVE(默认)来选择聚合级别。商品报告始终在广告组级别进行聚合,每个广告活动限制为按销量、购买量和 DPV 排名的前 100 件商品。

如果您没有指明希望在报告中包含的指标,响应中将包含所有可用的指标(除 brb_bonus_amount 之外)。为了获得更高效的报告,您可以在请求体中包含所需指标的列表。

提示:品牌引流奖励计划

对于参加品牌引流奖励计划 (BRB) 的广告主,您可以在效果报告中请求 brb_bonus_amount 指标,前提是您明确要求获取该指标,并传递 CAMPAIGN 或 ADGROUP 的 groupBy 值。对未参加 BRB 计划的广告主请求此指标不会导致错误 - 但响应中不会包含该指标。

可以通过访问 ReportRequestBody 文档,查看每种报告类型可用的维度和指标。

报告类型 包含的维度 聚合级别 指标 可用的报告日期
效果 aa_campaignidaa_adgroupidaa_creativeidpublisher 您可以选择在 CAMPAIGN、ADGROUP 或 CREATIVE 级别进行聚合(默认: CREATIVE) 点击量以及所有推广量和总转化量指标。有关完整列表,请参阅报告接口 最近 13 个月
商品 aa_campaignidaa_adgroupidpublisherproductNameproductGroupproductCategoryproductSubcategorybrandNameproductAsinproductConversionType 始终在广告组级别聚合 促销和品牌光环转化指标,品牌推荐奖励。无点击跳转量。有关完整列表,请参阅报告接口 最近 90 天

亚马逊每天至少更新一次亚马逊引流洞察报告,并在 1 天、7 天和 28 天内进行历史归因重述,以确保报告的更新中包含最新的转化数据,并考虑退货或退款的情况。我们建议您每天检索最近 30 天的报告。

注意

为了保护顾客的隐私,如果任何报告行表明标签或标签组在生命周期内获得的点击量低于 10,则亚马逊引流洞察将对该报告行的数据进行掩码处理。例如,在广告组级别聚合的报告对于点击量超过 10 的广告组将显示全部数据,即使该广告组中的部分标签的点击量低于 10。在超过点击量阈值之前,被掩盖的行会将指标值显示为零。预算很少或向很少的受众展示的广告活动可能需要一些时间才能超过这个阈值。

要在广告活动或广告组级别显示报告,您应该请求这些特定聚合级别的效果报告,而不是自己聚合数据,以确保您的报告包含所有可用数据并与亚马逊广告平台相匹配。

后续步骤

如果您在使用亚马逊引流洞察 API 时遇到问题,可以使用疑难排解指南 来帮助诊断并解决问题。