This page contains the setup guide and reference information for the Amazon Ads source connector.
- Client ID
- Client Secret
- Refresh Token
- Region
- Report Wait Timeout
- Report Generation Maximum Retries
- Start Date (Optional)
- Profile IDs (Optional)
Create an Amazon user with access to Amazon Ads account.
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.
For Airbyte Cloud:
- Log into your Airbyte Cloud account.
- In the left navigation bar, click Sources. In the top-right corner, click + new source.
- On the source setup page, select Amazon Ads from the Source type dropdown and enter a name for this connector.
- Click
Authenticate your Amazon Ads account. - Log in and Authorize to the Amazon account.
- Select Region to pull data from North America (NA), Europe (EU), Far East (FE) or Sandbox Environment. See docs for more details.
- 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. - 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. - 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
reportDateparameter for request). - Profile IDs (Optional) you want to fetch data for. See docs for more details.
- Click
Set up source.
For Airbyte OSS:
- Client ID of your Amazon Ads developer application. See onboarding process for more details.
- Client Secret of your Amazon Ads developer application. See onboarding process for more details.
- Refresh Token. See onboarding process for more details.
The Amazon Ads source connector supports the following sync modes:
- Full Refresh
- Incremental
This source is capable of syncing the following streams:
- Profiles
- Sponsored Brands Campaigns
- Sponsored Brands Ad groups
- Sponsored Brands Keywords
- Sponsored Display Campaigns
- Sponsored Display Ad groups
- Sponsored Display Product Ads
- Sponsored Display Targetings
- Sponsored Products Campaigns
- Sponsored Products Ad groups
- Sponsored Products Keywords
- Sponsored Products Negative keywords
- Sponsored Products Ads
- Sponsored Products Targetings
- Brands Reports
- Brand Video Reports
- Display Reports
- Products Reports
All the reports are generated for the day before relatively to the target profile' timezone
Information about expected report generation waiting time you may find here.
| Integration Type | Airbyte Type |
|---|---|
string |
string |
int, float, number |
number |
date |
date |
datetime |
datetime |
array |
array |
object |
object |
| Version | Date | Pull Request | Subject |
|---|---|---|---|
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 |