Amazon web events API extension overview
- Topics:
- Tags
CREATED FOR:
- Developer
The Amazon Conversions API extension creates a direct connection between marketing data from an advertiser’s server and Amazon. It enables advertisers to evaluate campaign effectiveness regardless of conversion location and optimize campaigns accordingly. This extension provides complete attribution, data reliability, and optimized delivery.
Amazon prerequisites
Before you install and configure the Amazon Conversions API extension, complete the following prerequisite steps to ensure proper authentication and data access:
Create a secret and data element
Create a new Amazon event forwarding secret and provide it with a unique name that signifies the authenticating member. This will be used to authenticate the connection to your account while keeping the value secure.
Next, create a data element using the Core extension and a Secret data element type to reference the Amazon
secret you just created.
Gather required configuration details
In order to connect Experience Platform to Amazon, input the following details:
entity
.Install and configure the Amazon extension
Follow these steps to install and configure the Amazon Conversions API extension:
-
Create or edit an event forwarding property.
-
Navigate to Extensions in the left navigation panel, then select the Amazon extension in the Catalog tab.
-
Select Install.
-
Configure the extension with the following details:
-
Access Token: Your data element secret containing the OAuth 2 token.
-
Entity ID: Your Entity ID (found in the Campaign Manager portal URL with the “entity” prefix).
-
-
Select Save to complete the configuration.
Configure an event forwarding rule
Once all your data elements are set up, create event forwarding rules to determine when and how your events are sent to Amazon.
-
Navigate to Rules and create a new event forwarding rule.
-
Under Actions, select Amazon Conversions API Extension.
-
Set the Action Type to Import Conversion Events.
Configure conversion event data
Conversion event data is critical to track user interactions and measure the effectiveness of your campaigns. By forwarding this data to Amazon, you can gain insights into user behavior, optimize your campaigns, and ensure accurate attribution for conversions.
The table below outlines the key properties required to configure and forward conversion event data:
name
My Event Name
eventType
Add to Shopping Cart
eventActionSource
WEBSITE
clientDedupeId
id
for the conversion event. For events with the same clientDedupeId
, only the first event is retained and all subsequent events are dropped.3234A398932
timestamp
2023-05-08T14:04:28Z
matchKeys
matchKeys > type
matchKeys > value
value
5
, or 0.99
currencyCode
value
of the event in ISO-4217 format. Only applicable for Off Amazon Purchases event type. If not provided, the currency code setting on the conversion definition will be used.USD
, EUR
, GBP
, etc.unitsSold
1
will be applied.countryCode
dataProcessingOptions
- Select Keep Changes to save the rule.
Event deduplication
Deduplication is essential to ensure accurate reporting and prevent inflated conversion counts when using both the Amazon Advertising Tag (AAT) and the Amazon Conversions API extension to track the same events.
When is deduplication required?
- Required: If the same event is being sent from both the client (AAT) and the server (Conversions API).
- Not required: If distinct event types are being sent from the client and server without any overlap.
How to enable deduplication
To enable deduplication, include the clientDedupeId
field in every shared event. This unique identifier allows Amazon to distinguish between client-side and server-side events and prevent duplicate entries.
By properly configuring deduplication, you can ensure that your optimization data remains accurate and that your reporting is not negatively impacted.
For more details, refer to the Amazon Event Deduplication Guide.
Next steps
This guide covered how to configure and send conversion events to Amazon using the Amazon Conversions API extension. For more information on event forwarding capabilities in Adobe Experience Platform, refer to the event forwarding overview.
For more details on how to debug your implementation using the Experience Platform Debugger and Event Forwarding Monitoring tool, read the Adobe Experience Platform Debugger overview and Monitor activities in event forwarding.