For the complete documentation index, see llms.txt. This page is also available as Markdown.

Amazon Events API

Amazon is a multinational technology company focusing on e-commerce, cloud computing, online advertising, digital streaming, and artificial intelligence. Using this destination you can send conversion data directly to Amazon Ads, bypassing browser-side limitations like ad blockers and cookie restrictions. It complements Amazon Ad Tag (AAT) to provide more complete attribution across DSP, SD, and STV campaigns, enabling better optimization and lower CPA.

Key features

The Amazon Events API destination provides the following key features:

  • Events structure: our Events reference model matches Amazon's event structure, meaning that your data is properly bridged to the expected fields in an optimized way.

  • Prebuilt mappings: data mapping for event-based destinations happens automatically, which simplifies user inputs.

  • Automatic hashing: information is automatically hashed matching partner specifications.

  • Custom events and properties: you can freely push custom events and properties based on your specific needs.

  • Smart mapping: data mapping can be readjusted using your datalayer defined fields.

  • Support batch mode: send multiple events in one single request.

Destination setup

Configuration

Settings
Description

Credentials

Required Your credentials with Amazon Ads as set in the Commanders Act interface following: AdministrationConnector CredentialsAdd connector credentialsAmazonAds

API Base Url

Required Your selected Amazon API endpoint. More details are available by following this LINK.

Advertiser Id

Required Enter your advertiser identifier, as shown in Amazon Ads, by clicking the gear icon (Administration) in the left-side menu then Account access and settings and Accounts.

Event Source

Required if not set in Smart Mapping Select your Event Source from the list or map the Smart Mapping field Event Source.

Country Property

Required The property name/path to the country where the event originates from. This value is based on ISO 3166-1 alpha-2.

Dataset Name

Dataset name to which this event should be added. Amazon highly recommends to set this field to help organize your conversion definitions. When a dataset name is not provided, a new conversion definitions will be assigned to the default_events dataset. More details are available by following this LINK. The first character must be an uppercase (A-Z) or lowercase (a-z) letter, followed by 4 to 99 characters, each of which can be a letter, a digit (0-9), an underscore (_), or a hyphen (-).

Event Mapping

Change the standard mapping between Amazon Conversion types and your events or add new mappings.

Custom Event Properties

Custom data associated with the event. Map your custom event properties by setting their field names in Amazon property name and adding the values in Your value . Your value can't be empty and its type must be one of the following: INTEGER , TIMESTAMP or STRING .

Quick reference

Commanders Act Events
Amazon Conversion Types

add_to_cart

ADD_TO_SHOPPING_CART

application

APPLICATION

begin_checkout

CHECKOUT

contact

CONTACT

generate_lead

LEAD

purchase

OFF_AMAZON_PURCHASES

mobile_app_first_start

MOBILE_APP_FIRST_START

page_view

PAGE_VIEW

search

SEARCH

sign_up

SIGN_UP

subscribe

SUBSCRIBE

other

OTHER

[Any Event]

[Any Conversion Type] [1]

1. See Event Mapping in Configuration for more details.

Field mappings

Properties can be remapped using our Smart Mapping feature.

Smart Mapping Fields
Commanders Act Default Properties
Amazon Properties

Conversion Type

-

partners.amazon.conversion_type

event_name

conversionType [*][1][2]

Event Source

-

partners.amazon.event_source

Event Source

eventSource [*][1]

-

Country Property

countryCode [*]

Conversion Definition Name

event_name

name [*][1][3]

-

Dataset Name

dataSetName [1][4]

Event Timestamp

context.event_timestamp

eventTime

Event Id

context.event_id

eventId [5]

Currency

currency

currencyCode

User Email

User Phone

First Name

Last Name

User Address

User City

User State

User Postal Code

Device Mobile Identifier

Ramp Id

Match Id

Real Id

Merkle Id

Kantar Id

user.email

user.phone

user.firstname

user.lastname

user.street

user.city

user.state

user.zipcode

context.device.advertising_id

partners.amazon.ramp_id

partners.amazon.match_id

partners.amazon.real_id

partners.amazon.merkle_id

partners.amazon.kantar_id

matchKeys.X.values.0 [6]

User Email

User Phone

First Name

Last Name

User Address

User City

User State

User Postal Code

Device Mobile Identifier

Ramp Id

Match Id

Real Id

Merkle Id

Kantar Id

user.email

user.phone

user.firstname

user.lastname

user.street

user.city

user.state

user.zipcode

context.device.advertising_id

partners.amazon.ramp_id

partners.amazon.match_id

partners.amazon.real_id

partners.amazon.merkle_id

partners.amazon.kantar_id

matchKeys.X.type [7]

Amazon Consent Ad Storage

partners.amazon.ad_storage

amazonConsent.amznAdStorage [8]

Amazon Consent User Data

partners.amazon.user_data

amazonConsent.amznUserData [8]

Transparency and Consent Framework String

partners.amazon.tcf

tcf [8]

Global Privacy Platform String

partners.amazon.gpp

gpp [8]

Device IP

context.device.ip

ipAddress [9]

Item List

items.length

unitsSold

Value

value

value

-

Custom Event Properties

customData [10]

Limit Data Use

partners.amazon.data_processing

dataProcessingOptions

Ad Event Key

partners.amazon.ad_event_key

amazonAdEventKey

Partner

partners.amazon.partner

partner

* Mandatory field. 1. Set in eventDescription . 2. Priority on the left side. See Quick reference for more details. 3. Default value: event_name . 4. See Configuration for more details. 5. Your specified id for the conversion event and used for deduplication. More details are available by following this LINK. 6. At least one identifier must be provided. 7. Depending on the value provided in matchKeys.X.values.0 , this is one of the following values: EMAIL , PHONE , FIRST_NAME , LAST_NAME , ADDRESS , CITY , STATE , POSTAL , MAID , RAMP_ID , MATCH_ID , REAL_ID , MERKLE_ID and KANTAR_ID . 8. Set in consent . See Destination setup for more details. 9. Set in consent.geo . 10. See Custom Event Properties in Configuration.

Last updated

Was this helpful?