Skip to content

Latest commit

 

History

History
117 lines (98 loc) · 11 KB

amazon-ads.md

File metadata and controls

117 lines (98 loc) · 11 KB
Raw

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). 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 is treated in the timezone of the processed profile.
  10. Profile IDs (Optional) you want to fetch data for. See docs for more details.
  11. Click Set up source.

For Airbyte Open Source:

  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 relative to the target profile' timezone.

Performance considerations

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

Data type mapping

Integration Type Airbyte Type
string string
int, float, number number
date date
datetime datetime
array array
object object

CHANGELOG

Version Date Pull Request Subject
0.1.24 2022-10-19 17475 Add filters for state on brand, product and display campaigns
0.1.23 2022-09-06 16342 Add attribution reports
0.1.22 2022-09-28 17304 Migrate to per-stream state.
0.1.21 2022-09-27 17202 Improved handling if known reporting errors
0.1.20 2022-09-08 16453 Increase report_wait_timeout 30 -> 60 minutes
0.1.19 2022-08-31 16191 Improved connector's input configuration validation
0.1.18 2022-08-25 15951 Skip API error "Tactic T00020 is not supported for report API in marketplace A1C3SOZRARQ6R3."
0.1.17 2022-08-24 15921 Skip API error "Report date is too far in the past."
0.1.16 2022-08-23 15822 Set default value for 'region' if needed
0.1.15 2022-08-20 15816 Update STATE of incremental sync if no records
0.1.14 2022-08-15 15637 Generate slices by lazy evaluation
0.1.12 2022-08-09 15469 Define primary_key for all report streams
0.1.11 2022-07-28 15031 Improve report streams date-range generation
0.1.10 2022-07-26 15042 Update additionalProperties field to true from schemas
0.1.9 2022-05-08 12541 Improve documentation for Beta
0.1.8 2022-05-04 12482 Update input configuration copy
0.1.7 2022-04-27 11730 Update fields in source-connectors specifications
0.1.6 2022-04-20 11659 Add adId to products report
0.1.5 2022-04-08 11430 Added support OAuth2.0
0.1.4 2022-02-21 10513 Increasing REPORT_WAIT_TIMEOUT for supporting report generation which takes longer time
0.1.3 2021-12-28 8388 Add retry if recoverable error occured for reporting stream processing
0.1.2 2021-10-01 6367 Add option to pull data for different regions. Add option to choose profiles we want to pull data. Add lookback
0.1.1 2021-09-22 6367 Add seller and vendor filters to profiles stream
0.1.0 2021-08-13 5023 Initial version