-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
spec.yaml
157 lines (157 loc) · 4.93 KB
/
spec.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
---
documentationUrl: https://docs.airbyte.com/integrations/sources/amazon-ads
connectionSpecification:
title: Amazon Ads Spec
type: object
properties:
auth_type:
title: Auth Type
const: oauth2.0
order: 0
type: string
client_id:
title: Client ID
description:
The client ID of your Amazon Ads developer application. See the
<a href="https://advertising.amazon.com/API/docs/en-us/get-started/generate-api-tokens#retrieve-your-client-id-and-client-secret">docs</a>
for more information.
order: 1
type: string
airbyte_secret: true
client_secret:
title: Client Secret
description:
The client secret of your Amazon Ads developer application. See
the <a href="https://advertising.amazon.com/API/docs/en-us/get-started/generate-api-tokens#retrieve-your-client-id-and-client-secret">docs</a>
for more information.
airbyte_secret: true
order: 2
type: string
refresh_token:
title: Refresh Token
description:
Amazon Ads refresh token. See the <a href="https://advertising.amazon.com/API/docs/en-us/get-started/generate-api-tokens">docs</a>
for more information on how to obtain this token.
airbyte_secret: true
order: 3
type: string
region:
title: Region
description:
Region to pull data from (EU/NA/FE). See <a href="https://advertising.amazon.com/API/docs/en-us/info/api-overview#api-endpoints">docs</a>
for more details.
enum:
- NA
- EU
- FE
type: string
default: NA
order: 4
start_date:
title: Start Date
description:
The Start date for collecting reports, should not be more than
60 days in the past. In YYYY-MM-DD format
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
format: date
examples:
- "2022-10-10"
- "2022-10-22"
order: 5
type: string
profiles:
title: Profile IDs
description: 'Profile IDs you want to fetch data for. See <a href="https://advertising.amazon.com/API/docs/en-us/concepts/authorization/profiles">docs</a> for more details. Note: If Marketplace IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID.'
order: 6
type: array
items:
type: integer
marketplace_ids:
title: Marketplace IDs
description: "Marketplace IDs you want to fetch data for. Note: If Profile IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID."
order: 7
type: array
items:
type: string
state_filter:
title: State Filter
description: Reflects the state of the Display, Product, and Brand Campaign streams as enabled, paused, or archived. If you do not populate this field, it will be ignored completely.
items:
type: string
enum:
- enabled
- paused
- archived
type: array
uniqueItems: true
order: 8
look_back_window:
title: "Look Back Window"
description: "The amount of days to go back in time to get the updated data from Amazon Ads"
examples:
- 3
- 10
type: "integer"
default: 3
order: 9
report_record_types:
title: Report Record Types
description:
Optional configuration which accepts an array of string of record types.
Leave blank for default behaviour to pull all report types.
Use this config option only if you want to pull specific report type(s).
See <a href="https://advertising.amazon.com/API/docs/en-us/reporting/v2/report-types">docs</a>
for more details
items:
type: string
enum:
- adGroups
- asins
- asins_keywords
- asins_targets
- campaigns
- keywords
- productAds
- targets
type: array
uniqueItems: true
order: 10
required:
- client_id
- client_secret
- refresh_token
additionalProperties: true
advanced_auth:
auth_flow_type: oauth2.0
predicate_key:
- auth_type
predicate_value: oauth2.0
oauth_config_specification:
complete_oauth_output_specification:
type: object
additionalProperties: true
properties:
refresh_token:
type: string
path_in_connector_config:
- refresh_token
complete_oauth_server_input_specification:
type: object
additionalProperties: true
properties:
client_id:
type: string
client_secret:
type: string
complete_oauth_server_output_specification:
type: object
additionalProperties: true
properties:
client_id:
type: string
path_in_connector_config:
- client_id
client_secret:
type: string
path_in_connector_config:
- client_secret