forked from airbytehq/airbyte
/
spec.json
411 lines (411 loc) · 17.6 KB
/
spec.json
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
{
"documentationUrl": "https://docs.airbyte.com/integrations/sources/facebook-marketing",
"changelogUrl": "https://docs.airbyte.com/integrations/sources/facebook-marketing",
"connectionSpecification": {
"title": "Source Facebook Marketing",
"type": "object",
"properties": {
"account_id": {
"title": "Account ID",
"description": "The Facebook Ad account ID to use when pulling data from the Facebook Marketing API. Open your Meta Ads Manager. The Ad account ID number is in the account dropdown menu or in your browser's address bar. See the <a href=\"https://www.facebook.com/business/help/1492627900875762\">docs</a> for more information.",
"order": 0,
"pattern": "^[0-9]+$",
"pattern_descriptor": "1234567890",
"examples": ["111111111111111"],
"type": "string"
},
"start_date": {
"title": "Start Date",
"description": "The date from which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.",
"order": 1,
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$",
"examples": ["2017-01-25T00:00:00Z"],
"type": "string",
"format": "date-time"
},
"end_date": {
"title": "End Date",
"description": "The date until which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.",
"order": 2,
"pattern": "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$",
"examples": ["2017-01-26T00:00:00Z"],
"type": "string",
"format": "date-time"
},
"access_token": {
"title": "Access Token",
"description": "The value of the generated access token. From your App’s Dashboard, click on \"Marketing API\" then \"Tools\". Select permissions <b>ads_management, ads_read, read_insights, business_management</b>. Then click on \"Get token\". See the <a href=\"https://docs.airbyte.com/integrations/sources/facebook-marketing\">docs</a> for more information.",
"order": 3,
"airbyte_secret": true,
"type": "string"
},
"include_deleted": {
"title": "Include Deleted Campaigns, Ads, and AdSets",
"description": "Set to active if you want to include data from deleted Campaigns, Ads, and AdSets.",
"default": false,
"order": 4,
"type": "boolean"
},
"fetch_thumbnail_images": {
"title": "Fetch Thumbnail Images from Ad Creative",
"description": "Set to active if you want to fetch the thumbnail_url and store the result in thumbnail_data_url for each Ad Creative.",
"default": false,
"order": 5,
"type": "boolean"
},
"custom_insights": {
"title": "Custom Insights",
"description": "A list which contains ad statistics entries, each entry must have a name and can contains fields, breakdowns or action_breakdowns. Click on \"add\" to fill this field.",
"order": 6,
"type": "array",
"items": {
"title": "InsightConfig",
"description": "Config for custom insights",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The name value of insight",
"type": "string"
},
"level": {
"title": "Level",
"description": "Chosen level for API",
"default": "ad",
"enum": ["ad", "adset", "campaign", "account"],
"type": "string"
},
"fields": {
"title": "Fields",
"description": "A list of chosen fields for fields parameter",
"default": [],
"type": "array",
"items": {
"title": "ValidEnums",
"description": "Generic enumeration.\n\nDerive from this class to define new enumerations.",
"enum": [
"account_currency",
"account_id",
"account_name",
"action_values",
"actions",
"ad_click_actions",
"ad_id",
"ad_impression_actions",
"ad_name",
"adset_end",
"adset_id",
"adset_name",
"adset_start",
"age_targeting",
"attribution_setting",
"auction_bid",
"auction_competitiveness",
"auction_max_competitor_bid",
"buying_type",
"campaign_id",
"campaign_name",
"canvas_avg_view_percent",
"canvas_avg_view_time",
"catalog_segment_actions",
"catalog_segment_value",
"catalog_segment_value_mobile_purchase_roas",
"catalog_segment_value_omni_purchase_roas",
"catalog_segment_value_website_purchase_roas",
"clicks",
"conversion_rate_ranking",
"conversion_values",
"conversions",
"converted_product_quantity",
"converted_product_value",
"cost_per_15_sec_video_view",
"cost_per_2_sec_continuous_video_view",
"cost_per_action_type",
"cost_per_ad_click",
"cost_per_conversion",
"cost_per_dda_countby_convs",
"cost_per_estimated_ad_recallers",
"cost_per_inline_link_click",
"cost_per_inline_post_engagement",
"cost_per_one_thousand_ad_impression",
"cost_per_outbound_click",
"cost_per_thruplay",
"cost_per_unique_action_type",
"cost_per_unique_click",
"cost_per_unique_conversion",
"cost_per_unique_inline_link_click",
"cost_per_unique_outbound_click",
"cpc",
"cpm",
"cpp",
"created_time",
"creative_media_type",
"ctr",
"date_start",
"date_stop",
"dda_countby_convs",
"dda_results",
"engagement_rate_ranking",
"estimated_ad_recall_rate",
"estimated_ad_recall_rate_lower_bound",
"estimated_ad_recall_rate_upper_bound",
"estimated_ad_recallers",
"estimated_ad_recallers_lower_bound",
"estimated_ad_recallers_upper_bound",
"frequency",
"full_view_impressions",
"full_view_reach",
"gender_targeting",
"impressions",
"inline_link_click_ctr",
"inline_link_clicks",
"inline_post_engagement",
"instagram_upcoming_event_reminders_set",
"instant_experience_clicks_to_open",
"instant_experience_clicks_to_start",
"instant_experience_outbound_clicks",
"interactive_component_tap",
"labels",
"location",
"mobile_app_purchase_roas",
"objective",
"optimization_goal",
"outbound_clicks",
"outbound_clicks_ctr",
"place_page_name",
"purchase_roas",
"qualifying_question_qualify_answer_rate",
"quality_ranking",
"quality_score_ectr",
"quality_score_ecvr",
"quality_score_organic",
"reach",
"social_spend",
"spend",
"total_postbacks",
"total_postbacks_detailed",
"total_postbacks_detailed_v4",
"unique_actions",
"unique_clicks",
"unique_conversions",
"unique_ctr",
"unique_inline_link_click_ctr",
"unique_inline_link_clicks",
"unique_link_clicks_ctr",
"unique_outbound_clicks",
"unique_outbound_clicks_ctr",
"unique_video_continuous_2_sec_watched_actions",
"unique_video_view_15_sec",
"updated_time",
"video_15_sec_watched_actions",
"video_30_sec_watched_actions",
"video_avg_time_watched_actions",
"video_continuous_2_sec_watched_actions",
"video_p100_watched_actions",
"video_p25_watched_actions",
"video_p50_watched_actions",
"video_p75_watched_actions",
"video_p95_watched_actions",
"video_play_actions",
"video_play_curve_actions",
"video_play_retention_0_to_15s_actions",
"video_play_retention_20_to_60s_actions",
"video_play_retention_graph_actions",
"video_thruplay_watched_actions",
"video_time_watched_actions",
"website_ctr",
"website_purchase_roas",
"wish_bid"
]
}
},
"breakdowns": {
"title": "Breakdowns",
"description": "A list of chosen breakdowns for breakdowns",
"default": [],
"type": "array",
"items": {
"title": "ValidBreakdowns",
"description": "Generic enumeration.\n\nDerive from this class to define new enumerations.",
"enum": [
"ad_format_asset",
"age",
"app_id",
"body_asset",
"call_to_action_asset",
"coarse_conversion_value",
"country",
"description_asset",
"device_platform",
"dma",
"fidelity_type",
"frequency_value",
"gender",
"hourly_stats_aggregated_by_advertiser_time_zone",
"hourly_stats_aggregated_by_audience_time_zone",
"hsid",
"image_asset",
"impression_device",
"is_conversion_id_modeled",
"link_url_asset",
"mmm",
"place_page_id",
"platform_position",
"postback_sequence_index",
"product_id",
"publisher_platform",
"redownload",
"region",
"skan_campaign_id",
"skan_conversion_id",
"title_asset",
"video_asset"
]
}
},
"action_breakdowns": {
"title": "Action Breakdowns",
"description": "A list of chosen action_breakdowns for action_breakdowns",
"default": [],
"type": "array",
"items": {
"title": "ValidActionBreakdowns",
"description": "Generic enumeration.\n\nDerive from this class to define new enumerations.",
"enum": [
"action_canvas_component_name",
"action_carousel_card_id",
"action_carousel_card_name",
"action_destination",
"action_device",
"action_reaction",
"action_target_id",
"action_type",
"action_video_sound",
"action_video_type"
]
}
},
"action_report_time": {
"title": "Action Report Time",
"description": "Determines the report time of action stats. For example, if a person saw the ad on Jan 1st but converted on Jan 2nd, when you query the API with action_report_time=impression, you see a conversion on Jan 1st. When you query the API with action_report_time=conversion, you see a conversion on Jan 2nd.",
"default": "mixed",
"enum": ["conversion", "impression", "mixed"],
"type": "string"
},
"time_increment": {
"title": "Time Increment",
"description": "Time window in days by which to aggregate statistics. The sync will be chunked into N day intervals, where N is the number of days you specified. For example, if you set this value to 7, then all statistics will be reported as 7-day aggregates by starting from the start_date. If the start and end dates are October 1st and October 30th, then the connector will output 5 records: 01 - 06, 07 - 13, 14 - 20, 21 - 27, and 28 - 30 (3 days only).",
"default": 1,
"exclusiveMaximum": 90,
"exclusiveMinimum": 0,
"type": "integer"
},
"start_date": {
"title": "Start Date",
"description": "The date from which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z.",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$",
"examples": ["2017-01-25T00:00:00Z"],
"type": "string",
"format": "date-time"
},
"end_date": {
"title": "End Date",
"description": "The date until which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$",
"examples": ["2017-01-26T00:00:00Z"],
"type": "string",
"format": "date-time"
},
"insights_lookback_window": {
"title": "Custom Insights Lookback Window",
"description": "The attribution window",
"default": 28,
"maximum": 28,
"mininum": 1,
"exclusiveMinimum": 0,
"type": "integer"
}
},
"required": ["name"]
}
},
"page_size": {
"title": "Page Size of Requests",
"description": "Page size used when sending requests to Facebook API to specify number of records per page when response has pagination. Most users do not need to set this field unless they specifically need to tune the connector to address specific issues or use cases.",
"default": 100,
"order": 7,
"exclusiveMinimum": 0,
"type": "integer"
},
"insights_lookback_window": {
"title": "Insights Lookback Window",
"description": "The attribution window. Facebook freezes insight data 28 days after it was generated, which means that all data from the past 28 days may have changed since we last emitted it, so you can retrieve refreshed insights from the past by setting this parameter. If you set a custom lookback window value in Facebook account, please provide the same value here.",
"default": 28,
"order": 8,
"maximum": 28,
"mininum": 1,
"exclusiveMinimum": 0,
"type": "integer"
},
"max_batch_size": {
"title": "Maximum size of Batched Requests",
"description": "Maximum batch size used when sending batch requests to Facebook API. Most users do not need to set this field unless they specifically need to tune the connector to address specific issues or use cases.",
"default": 50,
"order": 9,
"exclusiveMinimum": 0,
"type": "integer"
},
"action_breakdowns_allow_empty": {
"title": "Action Breakdowns Allow Empty",
"description": "Allows action_breakdowns to be an empty list",
"default": true,
"airbyte_hidden": true,
"type": "boolean"
}
},
"required": ["account_id", "start_date", "access_token"]
},
"supportsIncremental": true,
"supported_destination_sync_modes": ["append"],
"advanced_auth": {
"auth_flow_type": "oauth2.0",
"oauth_config_specification": {
"complete_oauth_output_specification": {
"type": "object",
"properties": {
"access_token": {
"type": "string",
"path_in_connector_config": [
"access_token"
]
}
}
},
"complete_oauth_server_input_specification": {
"type": "object",
"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"]
}
}
}
}
}
}