forked from airbytehq/airbyte
-
Notifications
You must be signed in to change notification settings - Fork 0
/
source_specs.yaml
18005 lines (18005 loc) · 634 KB
/
source_specs.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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# This file is generated by io.airbyte.config.specs.SeedConnectorSpecGenerator.
# Do NOT edit this file directly. See generator class for more details.
---
- dockerImage: "airbyte/source-activecampaign:0.1.0"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/sources/activecampaign"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "Activecampaign Spec"
type: "object"
required:
- "api_key"
- "account_username"
additionalProperties: true
properties:
api_key:
type: "string"
description: "API Key"
airbyte_secret: true
account_username:
type: "string"
description: "Account Username"
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-adjust:0.1.0"
spec:
documentationUrl: "https://raw.githubusercontent.com/appchoose/airbyte/feature/source-adjust/docs/integrations/sources/adjust.md"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
description: "Adjust reporting API connector."
properties:
additional_metrics:
description: "Metrics names that are not pre-defined, such as cohort metrics\
\ or app specific metrics."
items:
type: "string"
order: 3
title: "Additional metrics for ingestion"
type: "array"
api_token:
airbyte_secret: true
description: "Adjust API key, see https://help.adjust.com/en/article/report-service-api-authentication"
order: 0
title: "API Token"
type: "string"
dimensions:
description: "Dimensions allow a user to break down metrics into groups\
\ using one or several parameters. For example, the number of installs\
\ by date, country and network. See https://help.adjust.com/en/article/reports-endpoint#dimensions\
\ for more information about the dimensions."
items:
enum:
- "os_name"
- "device_type"
- "app"
- "app_token"
- "store_id"
- "store_type"
- "app_network"
- "currency"
- "currency_code"
- "network"
- "campaign"
- "campaign_network"
- "campaign_id_network"
- "adgroup"
- "adgroup_network"
- "adgroup_id_network"
- "source_network"
- "source_id_network"
- "creative"
- "creative_network"
- "creative_id_network"
- "country"
- "country_code"
- "region"
- "partner_name"
- "partner_id"
type: "string"
minItems: 1
order: 4
title: "Dimensions"
type: "array"
uniqueItems: true
ingest_start:
description: "Data ingest start date."
format: "date"
order: 1
title: "Ingest Start Date"
type: "string"
metrics:
description: "Select at least one metric to query."
items:
enum:
- "network_cost"
- "network_cost_diff"
- "network_clicks"
- "network_impressions"
- "network_installs"
- "network_installs_diff"
- "network_ecpc"
- "network_ecpi"
- "network_ecpm"
- "arpdau_ad"
- "arpdau"
- "arpdau_iap"
- "ad_impressions"
- "ad_rpm"
- "ad_revenue"
- "cohort_ad_revenue"
- "cost"
- "adjust_cost"
- "all_revenue"
- "cohort_all_revenue"
- "daus"
- "maus"
- "waus"
- "base_sessions"
- "ctr"
- "click_conversion_rate"
- "click_cost"
- "clicks"
- "paid_clicks"
- "deattributions"
- "ecpc"
- "gdpr_forgets"
- "gross_profit"
- "cohort_gross_profit"
- "impression_conversion_rate"
- "impression_cost"
- "impressions"
- "paid_impressions"
- "install_cost"
- "installs"
- "paid_installs"
- "installs_per_mile"
- "limit_ad_tracking_installs"
- "limit_ad_tracking_install_rate"
- "limit_ad_tracking_reattribution_rate"
- "limit_ad_tracking_reattributions"
- "non_organic_installs"
- "organic_installs"
- "roas_ad"
- "roas"
- "roas_iap"
- "reattributions"
- "return_on_investment"
- "revenue"
- "cohort_revenue"
- "revenue_events"
- "revenue_to_cost"
- "sessions"
- "events"
- "ecpi_all"
- "ecpi"
- "ecpm"
type: "string"
minItems: 1
order: 2
title: "Metrics to ingest"
type: "array"
uniqueItems: true
until_today:
default: false
description: "Syncs data up until today. Useful when running daily incremental\
\ syncs, and duplicates are not desired."
order: 5
title: "Until Today"
type: "boolean"
required:
- "api_token"
- "ingest_start"
- "metrics"
- "dimensions"
title: "Adjust Spec"
type: "object"
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-airtable:2.0.4"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/sources/airtable"
connectionSpecification:
$schema: "https://json-schema.org/draft-07/schema#"
title: "Airtable Source Spec"
type: "object"
additionalProperties: true
properties:
credentials:
title: "Authentication"
type: "object"
oneOf:
- type: "object"
title: "OAuth2.0"
required:
- "client_id"
- "client_secret"
- "refresh_token"
properties:
auth_method:
type: "string"
const: "oauth2.0"
client_id:
type: "string"
title: "Client ID"
description: "The client ID of the Airtable developer application."
airbyte_secret: true
client_secret:
type: "string"
title: "Client secret"
description: "The client secret the Airtable developer application."
airbyte_secret: true
access_token:
type: "string"
description: "Access Token for making authenticated requests."
airbyte_secret: true
token_expiry_date:
type: "string"
description: "The date-time when the access token should be refreshed."
format: "date-time"
refresh_token:
type: "string"
title: "Refresh token"
description: "The key to refresh the expired access token."
airbyte_secret: true
- title: "Personal Access Token"
type: "object"
required:
- "api_key"
properties:
auth_method:
type: "string"
const: "api_key"
api_key:
type: "string"
description: "The Personal Access Token for the Airtable account.\
\ See the <a href=\"https://airtable.com/developers/web/guides/personal-access-tokens\"\
>Support Guide</a> for more information on how to obtain this token."
title: "Personal Access Token"
airbyte_secret: true
examples:
- "key1234567890"
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
advanced_auth:
auth_flow_type: "oauth2.0"
predicate_key:
- "credentials"
- "auth_method"
predicate_value: "oauth2.0"
oauth_config_specification:
complete_oauth_output_specification:
type: "object"
properties:
access_token:
type: "string"
path_in_connector_config:
- "credentials"
- "access_token"
refresh_token:
type: "string"
path_in_connector_config:
- "credentials"
- "refresh_token"
token_expiry_date:
type: "string"
format: "date-time"
path_in_connector_config:
- "credentials"
- "token_expiry_date"
complete_oauth_server_input_specification:
type: "object"
properties:
client_id:
type: "string"
client_secret:
type: "string"
complete_oauth_server_output_specification:
type: "object"
properties:
client_id:
type: "string"
path_in_connector_config:
- "credentials"
- "client_id"
client_secret:
type: "string"
path_in_connector_config:
- "credentials"
- "client_secret"
- dockerImage: "airbyte/source-aha:0.1.0"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/sources/aha"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "Aha Spec"
type: "object"
required:
- "api_key"
- "url"
additionalProperties: true
properties:
api_key:
type: "string"
description: "API Key"
title: "API Bearer Token"
url:
type: "string"
description: "URL"
title: "Aha Url Instance"
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-alpha-vantage:0.1.1"
spec:
documentationUrl: "https://docs.airbyte.io/integrations/sources/alpha-vantage"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "Alpha Vantage Spec"
type: "object"
required:
- "api_key"
- "symbol"
properties:
api_key:
title: "API Key"
type: "string"
description: "API Key"
airbyte_secret: true
order: 0
symbol:
title: "Symbol"
type: "string"
description: "Stock symbol (with exchange code)"
examples:
- "AAPL"
- "TSCO.LON"
order: 1
interval:
title: "Interval"
type: "string"
description: "Time-series data point interval. Required for intraday endpoints.\n"
enum:
- "1min"
- "5min"
- "15min"
- "30min"
- "60min"
default: "1min"
order: 2
adjusted:
title: "Adjusted?"
type: "boolean"
description: "Whether to return adjusted data. Only applicable to intraday\
\ endpoints.\n"
default: false
order: 3
outputsize:
title: "Output Size"
type: "string"
description: "Whether to return full or compact data (the last 100 data\
\ points).\n"
enum:
- "compact"
- "full"
default: "compact"
order: 4
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-alloydb:2.0.2"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/sources/postgres"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "Postgres Source Spec"
type: "object"
required:
- "host"
- "port"
- "database"
- "username"
properties:
host:
title: "Host"
description: "Hostname of the database."
type: "string"
order: 0
port:
title: "Port"
description: "Port of the database."
type: "integer"
minimum: 0
maximum: 65536
default: 5432
examples:
- "5432"
order: 1
database:
title: "Database Name"
description: "Name of the database."
type: "string"
order: 2
schemas:
title: "Schemas"
description: "The list of schemas (case sensitive) to sync from. Defaults\
\ to public."
type: "array"
items:
type: "string"
minItems: 0
uniqueItems: true
default:
- "public"
order: 3
username:
title: "Username"
description: "Username to access the database."
type: "string"
order: 4
password:
title: "Password"
description: "Password associated with the username."
type: "string"
airbyte_secret: true
order: 5
jdbc_url_params:
description: "Additional properties to pass to the JDBC URL string when\
\ connecting to the database formatted as 'key=value' pairs separated\
\ by the symbol '&'. (Eg. key1=value1&key2=value2&key3=value3). For more\
\ information read about <a href=\"https://jdbc.postgresql.org/documentation/head/connect.html\"\
>JDBC URL parameters</a>."
title: "JDBC URL Parameters (Advanced)"
type: "string"
order: 6
ssl:
title: "Connect using SSL"
description: "Encrypt data using SSL. When activating SSL, please select\
\ one of the connection modes."
type: "boolean"
default: false
order: 7
ssl_mode:
title: "SSL Modes"
description: "SSL connection modes. \n Read more <a href=\"https://jdbc.postgresql.org/documentation/head/ssl-client.html\"\
> in the docs</a>."
type: "object"
order: 7
oneOf:
- title: "disable"
additionalProperties: true
description: "Disables encryption of communication between Airbyte and\
\ source database."
required:
- "mode"
properties:
mode:
type: "string"
const: "disable"
order: 0
- title: "allow"
additionalProperties: true
description: "Enables encryption only when required by the source database."
required:
- "mode"
properties:
mode:
type: "string"
const: "allow"
order: 0
- title: "prefer"
additionalProperties: true
description: "Allows unencrypted connection only if the source database\
\ does not support encryption."
required:
- "mode"
properties:
mode:
type: "string"
const: "prefer"
order: 0
- title: "require"
additionalProperties: true
description: "Always require encryption. If the source database server\
\ does not support encryption, connection will fail."
required:
- "mode"
properties:
mode:
type: "string"
const: "require"
order: 0
- title: "verify-ca"
additionalProperties: true
description: "Always require encryption and verifies that the source database\
\ server has a valid SSL certificate."
required:
- "mode"
- "ca_certificate"
properties:
mode:
type: "string"
const: "verify-ca"
order: 0
ca_certificate:
type: "string"
title: "CA certificate"
description: "CA certificate"
airbyte_secret: true
multiline: true
order: 1
client_certificate:
type: "string"
title: "Client Certificate"
description: "Client certificate"
airbyte_secret: true
multiline: true
order: 2
client_key:
type: "string"
title: "Client Key"
description: "Client key"
airbyte_secret: true
multiline: true
order: 3
client_key_password:
type: "string"
title: "Client key password"
description: "Password for keystorage. If you do not add it - the\
\ password will be generated automatically."
airbyte_secret: true
order: 4
- title: "verify-full"
additionalProperties: true
description: "This is the most secure mode. Always require encryption\
\ and verifies the identity of the source database server."
required:
- "mode"
- "ca_certificate"
properties:
mode:
type: "string"
const: "verify-full"
order: 0
ca_certificate:
type: "string"
title: "CA Certificate"
description: "CA certificate"
airbyte_secret: true
multiline: true
order: 1
client_certificate:
type: "string"
title: "Client Certificate"
description: "Client certificate"
airbyte_secret: true
multiline: true
order: 2
client_key:
type: "string"
title: "Client Key"
description: "Client key"
airbyte_secret: true
multiline: true
order: 3
client_key_password:
type: "string"
title: "Client key password"
description: "Password for keystorage. If you do not add it - the\
\ password will be generated automatically."
airbyte_secret: true
order: 4
replication_method:
type: "object"
title: "Replication Method"
description: "Replication method for extracting data from the database."
order: 8
oneOf:
- title: "Standard"
description: "Standard replication requires no setup on the DB side but\
\ will not be able to represent deletions incrementally."
required:
- "method"
properties:
method:
type: "string"
const: "Standard"
order: 0
- title: "Logical Replication (CDC)"
description: "Logical replication uses the Postgres write-ahead log (WAL)\
\ to detect inserts, updates, and deletes. This needs to be configured\
\ on the source database itself. Only available on Postgres 10 and above.\
\ Read the <a href=\"https://docs.airbyte.com/integrations/sources/postgres\"\
>docs</a>."
required:
- "method"
- "replication_slot"
- "publication"
additionalProperties: true
properties:
method:
type: "string"
const: "CDC"
order: 1
plugin:
type: "string"
title: "Plugin"
description: "A logical decoding plugin installed on the PostgreSQL\
\ server."
enum:
- "pgoutput"
default: "pgoutput"
order: 2
replication_slot:
type: "string"
title: "Replication Slot"
description: "A plugin logical replication slot. Read about <a href=\"\
https://docs.airbyte.com/integrations/sources/postgres#step-3-create-replication-slot\"\
>replication slots</a>."
order: 3
publication:
type: "string"
title: "Publication"
description: "A Postgres publication used for consuming changes. Read\
\ about <a href=\"https://docs.airbyte.com/integrations/sources/postgres#step-4-create-publications-and-replication-identities-for-tables\"\
>publications and replication identities</a>."
order: 4
initial_waiting_seconds:
type: "integer"
title: "Initial Waiting Time in Seconds (Advanced)"
description: "The amount of time the connector will wait when it launches\
\ to determine if there is new data to sync or not. Defaults to\
\ 300 seconds. Valid range: 120 seconds to 1200 seconds. Read about\
\ <a href=\"https://docs.airbyte.com/integrations/sources/postgres#step-5-optional-set-up-initial-waiting-time\"\
>initial waiting time</a>."
default: 300
order: 5
min: 120
max: 1200
lsn_commit_behaviour:
type: "string"
title: "LSN commit behaviour"
description: "Determines when Airbtye should flush the LSN of processed\
\ WAL logs in the source database. `After loading Data in the destination`\
\ is default. If `While reading Data` is selected, in case of a\
\ downstream failure (while loading data into the destination),\
\ next sync would result in a full sync."
enum:
- "While reading Data"
- "After loading Data in the destination"
default: "After loading Data in the destination"
order: 6
tunnel_method:
type: "object"
title: "SSH Tunnel Method"
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- title: "No Tunnel"
required:
- "tunnel_method"
properties:
tunnel_method:
description: "No ssh tunnel needed to connect to database"
type: "string"
const: "NO_TUNNEL"
order: 0
- title: "SSH Key Authentication"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
properties:
tunnel_method:
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
type: "string"
const: "SSH_KEY_AUTH"
order: 0
tunnel_host:
title: "SSH Tunnel Jump Server Host"
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
type: "string"
order: 1
tunnel_port:
title: "SSH Connection Port"
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
type: "integer"
minimum: 0
maximum: 65536
default: 22
examples:
- "22"
order: 2
tunnel_user:
title: "SSH Login Username"
description: "OS-level username for logging into the jump server host."
type: "string"
order: 3
ssh_key:
title: "SSH Private Key"
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
type: "string"
airbyte_secret: true
multiline: true
order: 4
- title: "Password Authentication"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
properties:
tunnel_method:
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
type: "string"
const: "SSH_PASSWORD_AUTH"
order: 0
tunnel_host:
title: "SSH Tunnel Jump Server Host"
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
type: "string"
order: 1
tunnel_port:
title: "SSH Connection Port"
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
type: "integer"
minimum: 0
maximum: 65536
default: 22
examples:
- "22"
order: 2
tunnel_user:
title: "SSH Login Username"
description: "OS-level username for logging into the jump server host"
type: "string"
order: 3
tunnel_user_password:
title: "Password"
description: "OS-level password for logging into the jump server host"
type: "string"
airbyte_secret: true
order: 4
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-aws-cloudtrail:0.1.5"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/sources/aws-cloudtrail"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "Aws CloudTrail Spec"
type: "object"
required:
- "aws_key_id"
- "aws_secret_key"
- "aws_region_name"
- "start_date"
additionalProperties: true
properties:
aws_key_id:
type: "string"
title: "Key ID"
description: "AWS CloudTrail Access Key ID. See the <a href=\"https://docs.airbyte.com/integrations/sources/aws-cloudtrail\"\
>docs</a> for more information on how to obtain this key."
airbyte_secret: true
aws_secret_key:
type: "string"
title: "Secret Key"
description: "AWS CloudTrail Access Key ID. See the <a href=\"https://docs.airbyte.com/integrations/sources/aws-cloudtrail\"\
>docs</a> for more information on how to obtain this key."
airbyte_secret: true
aws_region_name:
type: "string"
title: "Region Name"
description: "The default AWS Region to use, for example, us-west-1 or us-west-2.\
\ When specifying a Region inline during client initialization, this property\
\ is named region_name."
start_date:
type: "string"
title: "Start Date"
description: "The date you would like to replicate data. Data in AWS CloudTrail\
\ is available for last 90 days only. Format: YYYY-MM-DD."
examples:
- "2021-01-01"
default: "1970-01-01"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
format: "date"
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-amazon-ads:1.0.1"
spec:
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"
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"
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."
order: 6
type: "array"
items:
type: "integer"
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: 7
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: 8
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: 9
required:
- "client_id"
- "client_secret"
- "refresh_token"
additionalProperties: true
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
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"
- dockerImage: "airbyte/source-amazon-seller-partner:1.0.1"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/sources/amazon-seller-partner"
changelogUrl: "https://docs.airbyte.com/integrations/sources/amazon-seller-partner"
connectionSpecification:
title: "Amazon Seller Partner Spec"
type: "object"
properties:
app_id:
title: "App Id"
description: "Your Amazon App ID"
airbyte_secret: true
order: 0
type: "string"
auth_type:
title: "Auth Type"
const: "oauth2.0"
order: 1
type: "string"
lwa_app_id:
title: "LWA Client Id"
description: "Your Login with Amazon Client ID."
order: 2
type: "string"
lwa_client_secret:
title: "LWA Client Secret"
description: "Your Login with Amazon Client Secret."
airbyte_secret: true
order: 3
type: "string"
refresh_token:
title: "Refresh Token"
description: "The Refresh Token obtained via OAuth flow authorization."
airbyte_secret: true
order: 4
type: "string"
aws_access_key:
title: "AWS Access Key"
description: "Specifies the AWS access key used as part of the credentials\
\ to authenticate the user."
airbyte_secret: true
order: 5
type: "string"
aws_secret_key:
title: "AWS Secret Access Key"
description: "Specifies the AWS secret key used as part of the credentials\
\ to authenticate the user."
airbyte_secret: true