Skip to main content

Amazon DSP API Connector (V3)

Updated over a week ago
Strategic Partnerships - Xaxis

Overview

Amazon DSP (Demand-Side Platform) is Amazon’s programmatic advertising platform for display, video, audio, and OTT inventory both on Amazon-owned properties and across third-party sites. The Amazon Ads API (formerly the Amazon Advertising API) enables programmatic access to campaign structures, line items, orders, creatives, audiences, inventory, and performance reporting.

The Amazon DSP API provides access to a wide range of trafficking, delivery, and reporting data:

Campaign & Trafficking Configuration

  • Advertisers (Profiles)

  • Orders

  • Line items (including budgets, flighting, pacing)

  • Inventory supply sources

    • Amazon-owned properties (e.g., IMDb, Fire TV)

    • Third-party exchanges

  • Targeting configurations:

    • Audiences (Amazon audiences, custom audiences, retargeting)

    • Geo, device/OS, browser, environment

    • Supply/placement type (display, video, audio, OTT)

Creative & Asset Data

  • Creative metadata (display, video, HTML5, native)

  • Creative approvals & compliance status

  • Sizes, formats, assets, click-through URLs

Performance & Delivery Data

  • Impressions, clicks, conversions

  • Viewability & visibility metrics

  • Video metrics (starts, quartiles, completion rates)

  • Cost, CPC, CPM, CPA

  • Sales, ROAS, new-to-brand metrics (for retail-integrated advertisers)

  • Over-the-top (OTT) and streaming metrics (where applicable)

Metadata & Reference Data

  • Audience taxonomies (Amazon audiences, contextual segments)

  • Inventory sources

  • Creative approval categories

  • Regions, timezones, currencies

  • Supply type definitions (display, in-stream video, out-stream, audio)

Granularity:

This integration supports multiple levels of granularity: Advertiser, Order, Line Item which can be broken down by audience, geo and supply type.

Purpose

This integration is designed to:

  • Sync Amazon DSP campaign structure (orders, line items, creatives) into external data systems

  • Centralise performance metrics for cross-channel reporting

  • Enable automated budget, pacing, and trafficking workflows

  • Provide access to Amazon’s retail-aware conversion and sales data (where applicable)

  • Facilitate analysis across supply sources, targeting segments, and media typesadvertiser, campaign, ad group, and creative metadata

Refresh Cadence:

Data is refreshed daily.

Update Modes:

Append (for data table), Refresh (for metadata)

For more information on the Amazon DSP integration please follow this link


Connection Setup

Key

Description

Required

Type

amazon_client_id

Amazon Ads API Client ID

Yes

Hidden

amazon_client_secret

Amazon Ads API Client Secret

Yes

Hidden

amazon_profile_id

Amazon Ads Profile ID

Yes

Text

amazon_advertisers

Comma-separated list of Advertiser IDs

Yes

Text


Jobs & Scheduling

1. Amazon DSP Delivery Data Job

Setting

Value

Feed

amazon_ads_v3

Job Label

Amazon Ads V3 - Data Delivery

Table

amazon_data_campaign

Type

Data

Description

Amazon Ads - Delivery Data

Update Mode

Append

Create Target

True

Date Column

date

Lookback

5 days

First Run Hour

05:00 UTC

Poll Frequency

24 hours

Options (Target):

Key

Value

Description

skip_clean_source_file

true

Skip clean-up

fields_escaped_by

"\"

Field escape char

amazon_dsp_report_type

dspCampaign

Report type: Campaign-level

amazon_dsp_group_by

campaign,ad,creative

Grouping granularity


2. Amazon DSP Metadata Job

Setting

Value

Feed

amazon_ads_v3

Job Label

Amazon Ads V3 - Meta Import

Type

Lookup (multiple targets)

Lookback

1 day

First Run Hour

02:00 UTC

Poll Frequency

24 hours

Update Mode

Refresh

Create Targets

True

Metadata Tables Created:

Table Name

Description

amazon_meta_advertiser

Advertiser info

amazon_meta_campaign

Campaign-level metadata

amazon_meta_adgroup

Ad Group metadata

amazon_meta_creative

Creative metadata


Tables & Fields

Data Table: amazon_data_campaign

Field

Description

advertiserId

ID of the advertiser

orderId

Campaign/Order ID

lineItemId

Line Item / Ad Group ID

creativeId

Creative ID

date

Date of delivery metrics

totalCost

Spend amount

clicks

Number of clicks

impressions

Number of impressions

viewableImpressions

Viewable impressions

measurableImpressions

Measurable impressions

videoAdStart

Video starts

videoAdFirstQuartile

25% viewed

videoAdMidpoint

50% viewed

videoAdThirdQuartile

75% viewed

videoAdComplete

100% completed views


Metadata Tables

amazon_meta_advertiser

Field

Description

dspAdvertiserId

Advertiser ID

accountName

Account name

country

Advertiser country

amazon_meta_campaign

Field

Description

campaignId

Order/Campaign ID

name

Campaign name

amazon_meta_adgroup

Field

Description

adGroupId

Line item ID

name

Ad group name

amazon_meta_creative

Field

Description

adCreativeId

Creative ID

name

Creative name

adCreativeFormatProperties_adCreativeFormatType

Format type (e.g. video, display)


Joins / Relationships

The following joins are used to enrich amazon_data_campaign with metadata:

Data Field

Lookup Table

Join To Field

advertiserId

amazon_meta_advertiser

dspAdvertiserId

orderId

amazon_meta_campaign

campaignId

lineItemId

amazon_meta_adgroup

adGroupId

creativeId

amazon_meta_creative

adCreativeId


Dimensions

Dimension Name

Source Field

Account Name [Amazon]

amazon_meta_advertiser.accountName

Advertiser Country [Amazon]

amazon_meta_advertiser.country

Order Name [Amazon]

amazon_meta_campaign.name

Line Item Name [Amazon]

amazon_meta_adgroup.name

Creative Name [Amazon]

amazon_meta_creative.name

Creative Format Type [Amazon]

amazon_meta_creative.

adCreativeFormatProperties_adCreativeFormatType


Base Metrics

Metric Name

Formula

Description

Spend [Amazon]

SUM(totalCost)

Total spend

Clicks [Amazon]

SUM(clicks)

Total clicks

Impressions [Amazon]

SUM(impressions)

Total impressions

Viewable Impressions [Amazon]

SUM(viewableImpressions)

Viewable impressions

Measure Impressions [Amazon]

SUM(measurableImpressions)

Measurable impressions

Video Starts [Amazon]

SUM(videoAdStart)

Video ad starts

Video Views First Quartile [Amazon]

SUM(videoAdFirstQuartile)

25% view completion

Video Views Mid Point [Amazon]

SUM(videoAdMidpoint)

50% view completion

Video Views Third Quartile [Amazon]

SUM(videoAdThirdQuartile)

75% view completion

Video Completes [Amazon]

SUM(videoAdComplete)

Full video views


Composite Metrics

Name

Formula

CPC [Amazon]

Spend / Clicks

CPM [Amazon]

Spend / Impressions × 1000

CTR [Amazon]

Clicks / Impressions × 1000

CPV [Amazon]

Spend / Video Starts

CPCV [Amazon]

Spend / Video Completes

VCR [Amazon]

Video Completes / Video Starts × 100

VTR [Amazon]

Video Completes / Impressions × 100


Summary of Scheduling

Job Type

Tables

Frequency

First Run (UTC)

Lookback

Data

amazon_data_campaign

Daily

05:00

5 days

Meta

4 meta tables

Daily

02:00

1 day

Did this answer your question?