-
Notifications
You must be signed in to change notification settings - Fork 366
Draft for public facing documentation for Amazon Conversions API #7657
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bansrav
wants to merge
3
commits into
segmentio:develop
Choose a base branch
from
bansrav:develop
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
164 changes: 164 additions & 0 deletions
164
src/connections/destinations/catalog/actions-amazon-conversions-api/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,164 @@ | ||
--- | ||
title: Amazon Conversions API (Actions) Destination | ||
id: 683ef14a3f9aac157e3a3446 | ||
hide-personas-partial: true | ||
hide-boilerplate: false | ||
hide-dossier: true | ||
private: false | ||
hidden: false | ||
|
||
--- | ||
The Amazon Conversions API (Actions) destination is a server-to-server integration with the Amazon Events API. This destination allows advertisers to send real-time or offline conversion events data from Segment directly to Amazon without needing Amazon Ad Tag (AAT) setup. | ||
|
||
This enables advertisers to evaluate the effectiveness of their Amazon marketing campaigns regardless of the location of the conversion and utilize this information to drive campaign optimization. The Events API can help strengthen performance and decrease cost per action with more complete attribution, improved data reliability, and better optimized delivery. | ||
|
||
## Benefits of Amazon Conversions API (Actions) | ||
|
||
The Amazon Conversions API destination provides the following benefits: | ||
|
||
- **Simplified setup**. Data mapping for actions-based destinations happens during configuration, which eliminates the need for most settings. | ||
- **Clearer data mapping**. Actions-based destinations enable you to define the mapping between the data Segment receives from your source and the data Segment sends to the Amazon Conversions API. | ||
- **Prebuilt event mappings**. Standard events like `Add to Shopping Cart` and `Checkout` come preconfigured with recommended parameters. | ||
- **Multiple event types**. Support for various conversion event types including purchases, sign-ups, leads, and more. | ||
- **Multi-platform support**. Send events from websites, Android apps, iOS apps, Fire TV, or offline sources. | ||
- **Comprehensive user matching**. Multiple matching keys are available including email, phone, name, address, and mobile advertising IDs. | ||
- **Data normalization**. Data is normalized before it's hashed to send to Amazon Conversions. | ||
- **Custom attributes**. Includes additional context with event-specific attributes. | ||
- **Consent management**. Built-in support for various privacy frameworks including Amazon consent options, TCF, and GPP. | ||
|
||
## Getting started | ||
|
||
Before connecting to the Amazon Conversions API destination, you must have an [Amazon Advertising account](https://advertising.amazon.com/API/docs/en-us/guides/onboarding/overview){:target="_blank"} and an Advertiser ID. | ||
|
||
To connect the Amazon Conversions API Destination: | ||
|
||
1. From the Segment web app, go to **Connections > Catalog**. | ||
2. Search for **Amazon Conversions Api** in the top right corner. | ||
3. From the search results under **Destinations**, select the **Amazon Conversions Api** destination and then click **Add destination** | ||
4. Select the source that will send data to the Amazon Conversions API destination and follow the prompts to name your destination. | ||
5. On the **Basic Settings** page, enter: | ||
- Destination name | ||
- **Region:** - Select North America (NA), Europe (EU), or Far East (FE) based on your Amazon Advertising account | ||
- **Amazon Advertiser ID:** - Your Amazon Advertising Account ID | ||
6. Authenticate using OAuth when prompted. | ||
7. Go to the **Mappings** tab. Prebuilt mappings, like `Checkout`, `Search`, and `Add to Shopping Cart`, include predefined parameters. | ||
8. To create a new mapping: | ||
- Click **New Mapping** and select **Track Conversion**. | ||
- Configure and enable the mapping. | ||
9. Follow the steps in [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings). | ||
10. Toggle **Enable Destination** on, then click **Save Changes**. | ||
|
||
{% include components/actions-fields.html settings="true"%} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I used this tag here which I believe pulls the data based on the id passed similar to how Pinterest does. Is that rite? I am not able to see this in preview as I think it would appear after merging the PR. |
||
|
||
> info "Event Action Source" | ||
> By default, Segment sends all mappings as `website` conversions. To send events from mobile apps, Fire TV, or offline sources, set the Event Action Source in each mapping to the appropriate value: `android`, `ios`, `fire_tv`, or `offline`. | ||
|
||
## Supported event types | ||
|
||
Amazon Conversions API supports the following standard event types: | ||
|
||
| Event Type | Description | | ||
| ---------- | ----------- | | ||
| ADD_TO_SHOPPING_CART | When a user adds an item to their shopping cart | | ||
| APPLICATION | When a user submits an application | | ||
| CHECKOUT | When a user initiates a checkout process | | ||
| CONTACT | When a user submits contact information | | ||
| LEAD | When a user perform an action that initiates a sales lead | | ||
| OFF_AMAZON_PURCHASES | When a user completes a purchase | | ||
| MOBILE_APP_FIRST_START | When a user opens a mobile app for the first time | | ||
| PAGE_VIEW | When a user views a page | | ||
| SEARCH | When a user performs a search | | ||
| SIGN_UP | When a user creates an account | | ||
| SUBSCRIBE | When a user subscribes to a service | | ||
| OTHER | For custom events that don't fit into the standard types | | ||
|
||
## Match keys for user identification | ||
|
||
Amazon requires at least one match key to identify the user associated with each conversion event. Amazon Conversions API supports the following match keys: | ||
|
||
| Match Key | Description | | ||
| --------- | ----------- | | ||
| email | User's email address (is hashed) | | ||
| phone | User's phone number (is hashed) | | ||
| firstName | User's first name (is hashed) | | ||
| lastName | User's last name (is hashed) | | ||
| address | User's street address (is hashed) | | ||
| city | User's city (is hashed) | | ||
| state | User's state (is hashed) | | ||
| postalCode | User's postal code (is hashed) | | ||
| maid | Mobile advertising ID (ADID, IDFA, or FIREADID) | | ||
| rampId | RAMP ID for attribution to traffic events | | ||
| matchId | Custom match ID for the user | | ||
|
||
Segment automatically maps these fields from standard identity traits when available. | ||
|
||
## Consent management | ||
|
||
For EU advertisers and users, Amazon requires consent information to be included with conversion events. The Amazon Conversions API supports several consent mechanisms. | ||
|
||
### Geographic consent (IP Address) | ||
|
||
For basic consent management, include the user's IP address. Segment automatically maps this from the context.ip field when available. | ||
|
||
### Amazon consent format | ||
|
||
Amazon-specific consent format with two primary fields: | ||
|
||
| Consent Field | Description | Values | | ||
| ------------- | ----------- | ------ | | ||
| amznAdStorage | Whether the user has consented to cookie-based tracking | GRANTED, DENIED | | ||
| amznUserData | Whether the user has consented to use personal data for advertising | GRANTED, DENIED | | ||
|
||
### Industry standard consent | ||
|
||
For more comprehensive consent management: | ||
|
||
| Consent Field | Description | | ||
| ------------- | ----------- | | ||
| tcf | Transparency and Consent Framework (TCF) encoded string | | ||
| gpp | Global Privacy Platform (GPP) encoded string | | ||
|
||
## Data processing options | ||
|
||
The Amazon Conversions API supports data processing options to control how events are processed: | ||
|
||
| Option | Description | | ||
| ------ | ----------- | | ||
| LIMITED_DATA_USE | Signals that an event should be processed with limited data use restrictions. Events marked with this option won't be used for advertising purposes. | | ||
|
||
## Custom attributes | ||
|
||
You can include custom attributes with your events to provide additional context. Each custom attribute has: | ||
|
||
- **Name**: Identifier for the attribute (only letters, numbers, and underscores allowed) | ||
- **Data Type**: STRING, NUMBER, or BOOLEAN | ||
- **Value**: The attribute value (maximum 256 characters) | ||
|
||
## FAQ | ||
|
||
#### How does deduplication work? | ||
|
||
Amazon Conversions API uses the `clientDedupeId` field to prevent duplicate events. By default, Segment maps the messageId to this field. For events with the same clientDedupeId, only the latest event will be processed. | ||
|
||
#### What regions are supported? | ||
|
||
Amazon Conversions API supports three regions: | ||
- North America (NA) | ||
- Europe (EU) | ||
- Far East (FE) | ||
|
||
Select the region that corresponds to your Amazon Advertising account. | ||
|
||
#### What are the requirements for OFF_AMAZON_PURCHASES events? | ||
|
||
OFF_AMAZON_PURCHASES events have additional optional fields: | ||
- `currencyCode`: The currency of the purchase in ISO-4217 format (e.g., USD, EUR) | ||
- `unitsSold`: The number of items purchased (defaults to 1 if not provided) | ||
|
||
#### How are PII fields handled? | ||
|
||
Personally identifiable information (PII) fields like email, phone, name, and address are automatically hashed before sending to Amazon. | ||
|
||
#### How can I verify events in Amazon? | ||
|
||
After you start sending events, you should see them in your Amazon Advertising dashboard under conversion tracking reports. Allow some time for the events to be processed and attributed. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The name is actually
Api
https://app.segment.com/amazon-bansrav/destinations/catalog/actions-amazon-conversions-api
https://github.com/segmentio/action-destinations/blob/main/packages/destination-actions/src/destinations/amazon-conversions-api/index.ts#L11