Skip to main content

Amazon Ads

This page contains the setup guide and reference information for the Amazon Ads source connector.

Prerequisites

  • Client ID
  • Client Secret
  • Refresh Token
  • Region
  • Report Wait Timeout
  • Report Generation Maximum Retries
  • Start Date (Optional)
  • Profile IDs (Optional)

Setup guide

Step 1: Set up Amazon Ads

Create an Amazon user with access to Amazon Ads account.

Airbyte Open Source additional setup steps

To use the Amazon Ads API, you must first complete the onboarding process. The onboarding process has several steps and may take several days to complete. After completing all steps you will have to get Amazon client application Client ID, Client Secret and Refresh Token.

Step 2: Set up the Amazon Ads connector in Airbyte

For Airbyte Cloud:

  1. Log into your Airbyte Cloud account.
  2. In the left navigation bar, click Sources. In the top-right corner, click + new source.
  3. On the source setup page, select Amazon Ads from the Source type dropdown and enter a name for this connector.
  4. Click Authenticate your Amazon Ads account.
  5. Log in and Authorize to the Amazon account.
  6. Select Region to pull data from North America (NA), Europe (EU), Far East (FE) or Sandbox Environment. See docs for more details.
  7. Report Wait Timeout is the maximum number of minutes the connector waits for the generation of a report for streams Brands Reports, Brand Video Reports, Display Reports, Products Reports.
  8. Report Generation Maximum Retries is the maximum number of attempts the connector tries to generate a report for streams Brands Reports, Brand Video Reports, Display Reports, Products Reports.
  9. Start Date (Optional) is used for generating reports starting from the specified start date. Should be in YYYY-MM-DD format and not more than 60 days in the past. If not specified today's date is used. The date for a specific profile is calculated according to its timezone, this parameter should be specified in the UTC timezone. Since it has no sense of generating report for the current day (metrics could be changed) it generates report for the day before (e.g. if Start Date is 2021-10-11 it would use 20211010 as reportDate parameter for request).
  10. Profile IDs (Optional) you want to fetch data for. See docs for more details.
  11. Click Set up source.

For Airbyte OSS:

  1. Client ID of your Amazon Ads developer application. See onboarding process for more details.
  2. Client Secret of your Amazon Ads developer application. See onboarding process for more details.
  3. Refresh Token. See onboarding process for more details.

Supported sync modes

The Amazon Ads source connector supports the following sync modes:

  • Full Refresh
  • Incremental

Supported Streams

This source is capable of syncing the following streams:

Connector-specific features and highlights

All the reports are generated for the day before relatively to the target profile' timezone

Performance considerations

Information about expected report generation waiting time you may find here.

Data type mapping

Integration TypeAirbyte Type
stringstring
int, float, numbernumber
datedate
datetimedatetime
arrayarray
objectobject

CHANGELOG

VersionDatePull RequestSubject
0.1.92022-05-08#12541Improve documentation for Beta
0.1.82022-05-04#12482Update input configuration copy
0.1.72022-04-27#11730Update fields in source-connectors specifications
0.1.62022-04-20#11659Add adId to products report
0.1.52022-04-08#11430Added support OAuth2.0
0.1.42022-02-21#10513Increasing REPORT_WAIT_TIMEOUT for supporting report generation which takes longer time
0.1.32021-12-28#8388Add retry if recoverable error occured for reporting stream processing
0.1.22021-10-01#6367Add option to pull data for different regions. Add option to choose profiles we want to pull data. Add lookback
0.1.12021-09-22#6367Add seller and vendor filters to profiles stream
0.1.02021-08-13#5023Initial version