facebookbusiness 0.3.2.12 → 0.3.2.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/facebook_ads/ad_objects/ad.rb +26 -26
- data/lib/facebook_ads/ad_objects/ad_account.rb +282 -281
- data/lib/facebook_ads/ad_objects/ad_account_creation_request.rb +13 -13
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_creative.rb +11 -9
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +2 -0
- data/lib/facebook_ads/ad_objects/{legacy_business_ad_account_request.rb → ad_creative_optimization_spec.rb} +5 -4
- data/lib/facebook_ads/ad_objects/ad_monetization_property.rb +1 -1
- data/lib/facebook_ads/ad_objects/ad_report_run.rb +5 -5
- data/lib/facebook_ads/ad_objects/ad_report_spec.rb +3 -3
- data/lib/facebook_ads/ad_objects/ad_rule.rb +1 -1
- data/lib/facebook_ads/ad_objects/ad_set.rb +25 -25
- data/lib/facebook_ads/ad_objects/ad_study.rb +13 -13
- data/lib/facebook_ads/ad_objects/ad_video.rb +64 -61
- data/lib/facebook_ads/ad_objects/ads_insights.rb +0 -3
- data/lib/facebook_ads/ad_objects/ads_pixel.rb +5 -5
- data/lib/facebook_ads/ad_objects/album.rb +49 -49
- data/lib/facebook_ads/ad_objects/application.rb +99 -122
- data/lib/facebook_ads/ad_objects/business.rb +94 -93
- data/lib/facebook_ads/ad_objects/calibrator_existing_rule.rb +1 -1
- data/lib/facebook_ads/ad_objects/campaign.rb +21 -21
- data/lib/facebook_ads/ad_objects/comment.rb +5 -5
- data/lib/facebook_ads/ad_objects/custom_audience.rb +34 -34
- data/lib/facebook_ads/ad_objects/custom_conversion.rb +4 -4
- data/lib/facebook_ads/ad_objects/direct_deal.rb +1 -1
- data/lib/facebook_ads/ad_objects/event.rb +188 -188
- data/lib/facebook_ads/ad_objects/event_source_group.rb +1 -1
- data/lib/facebook_ads/ad_objects/extended_credit.rb +3 -3
- data/lib/facebook_ads/ad_objects/group.rb +217 -217
- data/lib/facebook_ads/ad_objects/hotel.rb +6 -6
- data/lib/facebook_ads/ad_objects/ig_comment.rb +1 -1
- data/lib/facebook_ads/ad_objects/ig_media.rb +1 -1
- data/lib/facebook_ads/ad_objects/ig_user.rb +6 -6
- data/lib/facebook_ads/ad_objects/instagram_user.rb +2 -2
- data/lib/facebook_ads/ad_objects/instant_article.rb +1 -1
- data/lib/facebook_ads/ad_objects/leadgen_form.rb +2 -2
- data/lib/facebook_ads/ad_objects/life_event.rb +7 -7
- data/lib/facebook_ads/ad_objects/link.rb +11 -11
- data/lib/facebook_ads/ad_objects/live_encoder.rb +20 -20
- data/lib/facebook_ads/ad_objects/live_video.rb +5 -5
- data/lib/facebook_ads/ad_objects/native_offer.rb +9 -9
- data/lib/facebook_ads/ad_objects/native_offer_view.rb +3 -3
- data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb +16 -16
- data/lib/facebook_ads/ad_objects/open_graph_object.rb +47 -47
- data/lib/facebook_ads/ad_objects/owned_domain.rb +0 -1
- data/lib/facebook_ads/ad_objects/page.rb +405 -407
- data/lib/facebook_ads/ad_objects/page_post.rb +24 -23
- data/lib/facebook_ads/ad_objects/partner_integration_linked.rb +1 -0
- data/lib/facebook_ads/ad_objects/permission.rb +0 -1
- data/lib/facebook_ads/ad_objects/photo.rb +56 -56
- data/lib/facebook_ads/ad_objects/playable_content.rb +1 -1
- data/lib/facebook_ads/ad_objects/post.rb +61 -60
- data/lib/facebook_ads/ad_objects/product_catalog.rb +153 -133
- data/lib/facebook_ads/ad_objects/product_group.rb +32 -32
- data/lib/facebook_ads/ad_objects/product_item.rb +20 -20
- data/lib/facebook_ads/ad_objects/profile.rb +2 -2
- data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +9 -10
- data/lib/facebook_ads/ad_objects/rtb_dynamic_post.rb +1 -1
- data/lib/facebook_ads/ad_objects/split_test_config.rb +0 -1
- data/lib/facebook_ads/ad_objects/status.rb +11 -11
- data/lib/facebook_ads/ad_objects/unified_thread.rb +5 -5
- data/lib/facebook_ads/ad_objects/user.rb +307 -305
- data/lib/facebook_ads/ad_objects/user_invitable_friend.rb +2 -2
- data/lib/facebook_ads/ad_objects/user_taggable_friend.rb +2 -2
- data/lib/facebook_ads/ad_objects/vehicle.rb +1 -0
- data/lib/facebook_ads/ad_objects/video_game_show.rb +2 -2
- data/lib/facebook_ads/ad_objects/video_list.rb +6 -6
- data/lib/facebook_ads/version.rb +1 -1
- metadata +3 -5
- data/lib/facebook_ads/ad_objects/ads_post.rb +0 -56
- data/lib/facebook_ads/ad_objects/favorite_request.rb +0 -69
@@ -94,6 +94,7 @@ module FacebookAds
|
|
94
94
|
"PAGES_MESSAGING",
|
95
95
|
"PAGES_MESSAGING_SUBSCRIPTIONS",
|
96
96
|
"READ_PAGE_MAILBOXES",
|
97
|
+
"VIEW_MONETIZATION_INSIGHTS",
|
97
98
|
]
|
98
99
|
|
99
100
|
ROLE = [
|
@@ -137,69 +138,69 @@ module FacebookAds
|
|
137
138
|
edge.get 'AdStudy'
|
138
139
|
edge.post 'AdStudy' do |api|
|
139
140
|
api.has_param :cells, { list: 'object' }
|
140
|
-
api.has_param :
|
141
|
-
api.has_param :
|
141
|
+
api.has_param :client_business, 'string'
|
142
|
+
api.has_param :confidence_level, 'double'
|
143
|
+
api.has_param :cooldown_start_time, 'int'
|
142
144
|
api.has_param :description, 'string'
|
145
|
+
api.has_param :end_time, 'int'
|
143
146
|
api.has_param :name, 'string'
|
144
|
-
api.has_param :
|
145
|
-
api.has_param :viewers, { list: 'int' }
|
146
|
-
api.has_param :cooldown_start_time, 'int'
|
147
|
+
api.has_param :objectives, { list: 'object' }
|
147
148
|
api.has_param :observation_end_time, 'int'
|
148
|
-
api.has_param :
|
149
|
-
api.has_param :client_business, 'string'
|
149
|
+
api.has_param :start_time, 'int'
|
150
150
|
api.has_param :type, { enum: -> { AdStudy::TYPE }}
|
151
|
+
api.has_param :viewers, { list: 'int' }
|
151
152
|
end
|
152
153
|
end
|
153
154
|
|
154
155
|
has_edge :adaccount do |edge|
|
155
156
|
edge.post 'AdAccount' do |api|
|
156
|
-
api.has_param :
|
157
|
+
api.has_param :billing_address_id, 'string'
|
157
158
|
api.has_param :currency, 'string'
|
158
|
-
api.has_param :timezone_id, 'int'
|
159
159
|
api.has_param :end_advertiser, 'object'
|
160
160
|
api.has_param :funding_id, 'string'
|
161
|
-
api.has_param :media_agency, 'string'
|
162
|
-
api.has_param :partner, 'string'
|
163
161
|
api.has_param :invoice, 'bool'
|
164
|
-
api.has_param :
|
162
|
+
api.has_param :invoice_group_id, 'string'
|
165
163
|
api.has_param :invoicing_emails, { list: 'string' }
|
166
164
|
api.has_param :io, 'bool'
|
167
|
-
api.has_param :billing_address_id, 'string'
|
168
|
-
api.has_param :sold_to_address_id, 'string'
|
169
165
|
api.has_param :liable_address_id, 'string'
|
170
|
-
api.has_param :
|
166
|
+
api.has_param :media_agency, 'string'
|
167
|
+
api.has_param :name, 'string'
|
168
|
+
api.has_param :partner, 'string'
|
169
|
+
api.has_param :po_number, 'string'
|
170
|
+
api.has_param :sold_to_address_id, 'string'
|
171
|
+
api.has_param :timezone_id, 'int'
|
171
172
|
end
|
172
173
|
end
|
173
174
|
|
174
175
|
has_edge :adaccountcreationrequests do |edge|
|
175
176
|
edge.get 'AdAccountCreationRequest' do |api|
|
176
|
-
api.has_param :status, { list: { enum: -> { AdAccountCreationRequest::STATUS }} }
|
177
177
|
api.has_param :ad_account_creation_request_id, 'string'
|
178
|
+
api.has_param :status, { list: { enum: -> { AdAccountCreationRequest::STATUS }} }
|
178
179
|
end
|
179
180
|
edge.post 'AdAccountCreationRequest' do |api|
|
180
|
-
api.has_param :extended_credit_id, 'string'
|
181
181
|
api.has_param :ad_accounts_info, { list: 'object' }
|
182
|
-
api.has_param :
|
183
|
-
api.has_param :planning_agency_business_id, 'string'
|
184
|
-
api.has_param :english_legal_entity_name, 'string'
|
185
|
-
api.has_param :legal_entity_name_in_local_language, 'string'
|
186
|
-
api.has_param :chinese_legal_entity_name, 'string'
|
182
|
+
api.has_param :additional_comment, 'string'
|
187
183
|
api.has_param :address_in_chinese, 'string'
|
188
|
-
api.has_param :address_in_local_language, 'string'
|
189
184
|
api.has_param :address_in_english, 'object'
|
190
|
-
api.has_param :
|
185
|
+
api.has_param :address_in_local_language, 'string'
|
186
|
+
api.has_param :advertiser_business_id, 'string'
|
187
|
+
api.has_param :business_registration, 'file'
|
191
188
|
api.has_param :business_registration_id, 'string'
|
192
|
-
api.has_param :
|
193
|
-
api.has_param :subvertical, { enum: -> { AdAccountCreationRequest::SUBVERTICAL }}
|
194
|
-
api.has_param :promotable_page_urls, { list: 'string' }
|
195
|
-
api.has_param :promotable_page_ids, { list: 'string' }
|
196
|
-
api.has_param :promotable_app_ids, { list: 'string' }
|
197
|
-
api.has_param :promotable_urls, { list: 'string' }
|
189
|
+
api.has_param :chinese_legal_entity_name, 'string'
|
198
190
|
api.has_param :contact, 'object'
|
199
|
-
api.has_param :
|
191
|
+
api.has_param :english_legal_entity_name, 'string'
|
192
|
+
api.has_param :extended_credit_id, 'string'
|
200
193
|
api.has_param :is_smb, 'bool'
|
201
194
|
api.has_param :is_test, 'bool'
|
202
|
-
api.has_param :
|
195
|
+
api.has_param :legal_entity_name_in_local_language, 'string'
|
196
|
+
api.has_param :official_website_url, 'string'
|
197
|
+
api.has_param :planning_agency_business_id, 'string'
|
198
|
+
api.has_param :promotable_app_ids, { list: 'string' }
|
199
|
+
api.has_param :promotable_page_ids, { list: 'string' }
|
200
|
+
api.has_param :promotable_page_urls, { list: 'string' }
|
201
|
+
api.has_param :promotable_urls, { list: 'string' }
|
202
|
+
api.has_param :subvertical, { enum: -> { AdAccountCreationRequest::SUBVERTICAL }}
|
203
|
+
api.has_param :vertical, { enum: -> { AdAccountCreationRequest::VERTICAL }}
|
203
204
|
end
|
204
205
|
end
|
205
206
|
|
@@ -224,9 +225,9 @@ module FacebookAds
|
|
224
225
|
edge.post 'Business' do |api|
|
225
226
|
api.has_param :aggregation_period, { enum: -> { AdNetworkAnalyticsSyncQueryResult::AGGREGATION_PERIOD }}
|
226
227
|
api.has_param :breakdowns, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::BREAKDOWNS }} }
|
227
|
-
api.has_param :metrics, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::METRICS }} }
|
228
228
|
api.has_param :filters, { list: 'object' }
|
229
229
|
api.has_param :limit, 'int'
|
230
|
+
api.has_param :metrics, { list: { enum: -> { AdNetworkAnalyticsSyncQueryResult::METRICS }} }
|
230
231
|
api.has_param :ordering_column, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_COLUMN }}
|
231
232
|
api.has_param :ordering_type, { enum: -> { AdNetworkAnalyticsSyncQueryResult::ORDERING_TYPE }}
|
232
233
|
api.has_param :since, 'datetime'
|
@@ -242,8 +243,8 @@ module FacebookAds
|
|
242
243
|
|
243
244
|
has_edge :adspixels do |edge|
|
244
245
|
edge.get 'AdsPixel' do |api|
|
245
|
-
api.has_param :name_filter, 'string'
|
246
246
|
api.has_param :id_filter, 'string'
|
247
|
+
api.has_param :name_filter, 'string'
|
247
248
|
api.has_param :sort_by, { enum: -> { AdsPixel::SORT_BY }}
|
248
249
|
end
|
249
250
|
edge.post 'AdsPixel' do |api|
|
@@ -276,8 +277,8 @@ module FacebookAds
|
|
276
277
|
api.has_param :app_id, 'int'
|
277
278
|
end
|
278
279
|
edge.post 'Business' do |api|
|
279
|
-
api.has_param :app_id, 'object'
|
280
280
|
api.has_param :access_type, { enum: -> { Business::ACCESS_TYPE }}
|
281
|
+
api.has_param :app_id, 'object'
|
281
282
|
end
|
282
283
|
end
|
283
284
|
|
@@ -289,8 +290,8 @@ module FacebookAds
|
|
289
290
|
|
290
291
|
has_edge :business_invoices do |edge|
|
291
292
|
edge.get 'OracleTransaction' do |api|
|
292
|
-
api.has_param :start_date, 'string'
|
293
293
|
api.has_param :end_date, 'string'
|
294
|
+
api.has_param :start_date, 'string'
|
294
295
|
end
|
295
296
|
end
|
296
297
|
|
@@ -375,13 +376,13 @@ module FacebookAds
|
|
375
376
|
api.has_param :include_archived, 'bool'
|
376
377
|
end
|
377
378
|
edge.post 'CustomConversion' do |api|
|
378
|
-
api.has_param :
|
379
|
+
api.has_param :advanced_rule, 'string'
|
380
|
+
api.has_param :custom_event_type, { enum: -> { CustomConversion::CUSTOM_EVENT_TYPE }}
|
381
|
+
api.has_param :default_conversion_value, 'double'
|
379
382
|
api.has_param :description, 'string'
|
380
383
|
api.has_param :event_source_id, 'string'
|
384
|
+
api.has_param :name, 'string'
|
381
385
|
api.has_param :rule, 'string'
|
382
|
-
api.has_param :default_conversion_value, 'double'
|
383
|
-
api.has_param :custom_event_type, { enum: -> { CustomConversion::CUSTOM_EVENT_TYPE }}
|
384
|
-
api.has_param :advanced_rule, 'string'
|
385
386
|
end
|
386
387
|
end
|
387
388
|
|
@@ -436,36 +437,36 @@ module FacebookAds
|
|
436
437
|
|
437
438
|
has_edge :managed_businesses do |edge|
|
438
439
|
edge.post 'Business' do |api|
|
440
|
+
api.has_param :existing_client_business_id, 'string'
|
439
441
|
api.has_param :name, 'string'
|
440
|
-
api.has_param :
|
441
|
-
api.has_param :timezone_id, 'int'
|
442
|
+
api.has_param :sales_rep_email, 'string'
|
442
443
|
api.has_param :survey_business_type, { enum: -> { Business::SURVEY_BUSINESS_TYPE }}
|
443
|
-
api.has_param :survey_num_people, 'int'
|
444
444
|
api.has_param :survey_num_assets, 'int'
|
445
|
-
api.has_param :
|
446
|
-
api.has_param :
|
445
|
+
api.has_param :survey_num_people, 'int'
|
446
|
+
api.has_param :timezone_id, 'int'
|
447
|
+
api.has_param :vertical, { enum: -> { Business::VERTICAL }}
|
447
448
|
end
|
448
449
|
end
|
449
450
|
|
450
451
|
has_edge :measurement_reports do |edge|
|
451
452
|
edge.get 'MeasurementReport' do |api|
|
452
|
-
api.has_param :report_type, { enum: -> { MeasurementReport::REPORT_TYPE }}
|
453
453
|
api.has_param :filters, { list: 'object' }
|
454
|
+
api.has_param :report_type, { enum: -> { MeasurementReport::REPORT_TYPE }}
|
454
455
|
end
|
455
456
|
edge.post 'MeasurementReport' do |api|
|
456
|
-
api.has_param :report_type, { enum: -> { MeasurementReport::REPORT_TYPE }}
|
457
457
|
api.has_param :metadata, 'string'
|
458
|
+
api.has_param :report_type, { enum: -> { MeasurementReport::REPORT_TYPE }}
|
458
459
|
end
|
459
460
|
end
|
460
461
|
|
461
462
|
has_edge :offline_conversion_data_sets do |edge|
|
462
463
|
edge.get 'OfflineConversionDataSet'
|
463
464
|
edge.post 'OfflineConversionDataSet' do |api|
|
464
|
-
api.has_param :
|
465
|
+
api.has_param :auto_assign_to_new_accounts_only, 'bool'
|
465
466
|
api.has_param :description, 'string'
|
466
467
|
api.has_param :enable_auto_assign_to_accounts, 'bool'
|
467
468
|
api.has_param :is_mta_use, 'bool'
|
468
|
-
api.has_param :
|
469
|
+
api.has_param :name, 'string'
|
469
470
|
end
|
470
471
|
end
|
471
472
|
|
@@ -496,15 +497,15 @@ module FacebookAds
|
|
496
497
|
end
|
497
498
|
edge.post 'Business' do |api|
|
498
499
|
api.has_param :name, 'string'
|
499
|
-
api.has_param :vertical, { enum: -> { Business::VERTICAL }}
|
500
|
-
api.has_param :timezone_id, 'int'
|
501
|
-
api.has_param :survey_business_type, { enum: -> { Business::SURVEY_BUSINESS_TYPE }}
|
502
|
-
api.has_param :survey_num_people, 'int'
|
503
|
-
api.has_param :survey_num_assets, 'int'
|
504
|
-
api.has_param :sales_rep_email, 'string'
|
505
|
-
api.has_param :shared_page_id, 'string'
|
506
500
|
api.has_param :page_permitted_roles, { list: { enum: -> { Business::PAGE_PERMITTED_ROLES }} }
|
507
501
|
api.has_param :page_permitted_tasks, { list: { enum: -> { Business::PAGE_PERMITTED_TASKS }} }
|
502
|
+
api.has_param :sales_rep_email, 'string'
|
503
|
+
api.has_param :shared_page_id, 'string'
|
504
|
+
api.has_param :survey_business_type, { enum: -> { Business::SURVEY_BUSINESS_TYPE }}
|
505
|
+
api.has_param :survey_num_assets, 'int'
|
506
|
+
api.has_param :survey_num_people, 'int'
|
507
|
+
api.has_param :timezone_id, 'int'
|
508
|
+
api.has_param :vertical, { enum: -> { Business::VERTICAL }}
|
508
509
|
end
|
509
510
|
end
|
510
511
|
|
@@ -526,8 +527,8 @@ module FacebookAds
|
|
526
527
|
has_edge :owned_pages do |edge|
|
527
528
|
edge.get 'Page'
|
528
529
|
edge.post 'Business' do |api|
|
529
|
-
api.has_param :page_id, 'int'
|
530
530
|
api.has_param :ig_password, 'string'
|
531
|
+
api.has_param :page_id, 'int'
|
531
532
|
end
|
532
533
|
end
|
533
534
|
|
@@ -538,11 +539,11 @@ module FacebookAds
|
|
538
539
|
has_edge :owned_product_catalogs do |edge|
|
539
540
|
edge.get 'ProductCatalog'
|
540
541
|
edge.post 'ProductCatalog' do |api|
|
542
|
+
api.has_param :da_display_settings, 'object'
|
543
|
+
api.has_param :destination_catalog_settings, 'hash'
|
544
|
+
api.has_param :flight_catalog_settings, 'hash'
|
541
545
|
api.has_param :name, 'string'
|
542
546
|
api.has_param :vertical, { enum: -> { ProductCatalog::VERTICAL }}
|
543
|
-
api.has_param :flight_catalog_settings, 'hash'
|
544
|
-
api.has_param :destination_catalog_settings, 'hash'
|
545
|
-
api.has_param :da_display_settings, 'object'
|
546
547
|
end
|
547
548
|
end
|
548
549
|
|
@@ -565,21 +566,21 @@ module FacebookAds
|
|
565
566
|
|
566
567
|
has_edge :partneradaccount do |edge|
|
567
568
|
edge.post do |api|
|
568
|
-
api.has_param :
|
569
|
+
api.has_param :billing_address_id, 'string'
|
569
570
|
api.has_param :currency, 'string'
|
570
|
-
api.has_param :timezone_id, 'int'
|
571
571
|
api.has_param :end_advertiser, 'object'
|
572
572
|
api.has_param :funding_id, 'string'
|
573
|
-
api.has_param :media_agency, 'string'
|
574
|
-
api.has_param :partner, 'string'
|
575
573
|
api.has_param :invoice, 'bool'
|
576
|
-
api.has_param :
|
574
|
+
api.has_param :invoice_group_id, 'string'
|
577
575
|
api.has_param :invoicing_emails, { list: 'string' }
|
578
576
|
api.has_param :io, 'bool'
|
579
|
-
api.has_param :billing_address_id, 'string'
|
580
|
-
api.has_param :sold_to_address_id, 'string'
|
581
577
|
api.has_param :liable_address_id, 'string'
|
582
|
-
api.has_param :
|
578
|
+
api.has_param :media_agency, 'string'
|
579
|
+
api.has_param :name, 'string'
|
580
|
+
api.has_param :partner, 'string'
|
581
|
+
api.has_param :po_number, 'string'
|
582
|
+
api.has_param :sold_to_address_id, 'string'
|
583
|
+
api.has_param :timezone_id, 'int'
|
583
584
|
end
|
584
585
|
end
|
585
586
|
|
@@ -604,7 +605,7 @@ module FacebookAds
|
|
604
605
|
end
|
605
606
|
|
606
607
|
has_edge :pending_owned_ad_accounts do |edge|
|
607
|
-
edge.get '
|
608
|
+
edge.get 'BusinessAdAccountRequest'
|
608
609
|
end
|
609
610
|
|
610
611
|
has_edge :pending_owned_pages do |edge|
|
@@ -624,9 +625,9 @@ module FacebookAds
|
|
624
625
|
has_edge :picture do |edge|
|
625
626
|
edge.get 'ProfilePictureSource' do |api|
|
626
627
|
api.has_param :height, 'int'
|
627
|
-
api.has_param :width, 'int'
|
628
|
-
api.has_param :type, { enum: -> { ProfilePictureSource::TYPE }}
|
629
628
|
api.has_param :redirect, 'bool'
|
629
|
+
api.has_param :type, { enum: -> { ProfilePictureSource::TYPE }}
|
630
|
+
api.has_param :width, 'int'
|
630
631
|
end
|
631
632
|
end
|
632
633
|
|
@@ -649,16 +650,16 @@ module FacebookAds
|
|
649
650
|
|
650
651
|
has_edge :received_sharing_agreements do |edge|
|
651
652
|
edge.get 'BusinessAgreement' do |api|
|
652
|
-
api.has_param :requesting_business_id, 'string'
|
653
653
|
api.has_param :request_status, { enum: -> { BusinessAgreement::REQUEST_STATUS }}
|
654
|
+
api.has_param :requesting_business_id, 'string'
|
654
655
|
end
|
655
656
|
end
|
656
657
|
|
657
658
|
has_edge :sent_inprogress_onbehalf_requests do |edge|
|
658
659
|
edge.get 'BusinessOwnedObjectOnBehalfOfRequest'
|
659
660
|
edge.post 'BusinessOwnedObjectOnBehalfOfRequest' do |api|
|
660
|
-
api.has_param :receiving_business, 'string'
|
661
661
|
api.has_param :business_owned_object, 'string'
|
662
|
+
api.has_param :receiving_business, 'string'
|
662
663
|
end
|
663
664
|
end
|
664
665
|
|
@@ -677,8 +678,8 @@ module FacebookAds
|
|
677
678
|
has_edge :system_users do |edge|
|
678
679
|
edge.get 'SystemUser'
|
679
680
|
edge.post 'SystemUser' do |api|
|
680
|
-
api.has_param :role, { enum: -> { SystemUser::ROLE }}
|
681
681
|
api.has_param :name, 'string'
|
682
|
+
api.has_param :role, { enum: -> { SystemUser::ROLE }}
|
682
683
|
api.has_param :system_user_id, 'int'
|
683
684
|
end
|
684
685
|
end
|
@@ -711,48 +712,48 @@ module FacebookAds
|
|
711
712
|
api.has_param :email, 'string'
|
712
713
|
end
|
713
714
|
edge.get 'BusinessRoleRequest' do |api|
|
714
|
-
api.has_param :status, { enum: -> { BusinessRoleRequest::STATUS }}
|
715
715
|
api.has_param :email, 'string'
|
716
|
+
api.has_param :status, { enum: -> { BusinessRoleRequest::STATUS }}
|
716
717
|
end
|
717
718
|
end
|
718
719
|
|
719
720
|
has_edge :userpermissions do |edge|
|
720
721
|
edge.delete do |api|
|
721
|
-
api.has_param :user, 'int'
|
722
722
|
api.has_param :email, 'string'
|
723
|
+
api.has_param :user, 'int'
|
723
724
|
end
|
724
725
|
edge.post 'Business' do |api|
|
725
|
-
api.has_param :user, 'int'
|
726
726
|
api.has_param :email, 'string'
|
727
727
|
api.has_param :role, { enum: -> { Business::ROLE }}
|
728
|
+
api.has_param :user, 'int'
|
728
729
|
end
|
729
730
|
end
|
730
731
|
|
731
732
|
has_edge :vietnamadaccountcreationrequests do |edge|
|
732
733
|
edge.post 'AdAccountCreationRequest' do |api|
|
733
|
-
api.has_param :address_in_local_language, 'string'
|
734
734
|
api.has_param :ad_accounts_currency, 'string'
|
735
|
-
api.has_param :credit_card_id, 'string'
|
736
|
-
api.has_param :extended_credit_id, 'string'
|
737
|
-
api.has_param :legal_entity_name_in_local_language, 'string'
|
738
735
|
api.has_param :ad_accounts_info, { list: 'object' }
|
739
|
-
api.has_param :
|
740
|
-
api.has_param :planning_agency_business_id, 'string'
|
741
|
-
api.has_param :english_legal_entity_name, 'string'
|
736
|
+
api.has_param :additional_comment, 'string'
|
742
737
|
api.has_param :address_in_english, 'object'
|
743
|
-
api.has_param :
|
738
|
+
api.has_param :address_in_local_language, 'string'
|
739
|
+
api.has_param :advertiser_business_id, 'string'
|
740
|
+
api.has_param :business_registration, 'file'
|
744
741
|
api.has_param :business_registration_id, 'string'
|
745
|
-
api.has_param :vertical, { enum: -> { AdAccountCreationRequest::VERTICAL }}
|
746
|
-
api.has_param :subvertical, { enum: -> { AdAccountCreationRequest::SUBVERTICAL }}
|
747
|
-
api.has_param :promotable_page_urls, { list: 'string' }
|
748
|
-
api.has_param :promotable_page_ids, { list: 'int' }
|
749
|
-
api.has_param :promotable_app_ids, { list: 'string' }
|
750
|
-
api.has_param :promotable_urls, { list: 'string' }
|
751
742
|
api.has_param :contact, 'object'
|
752
|
-
api.has_param :
|
743
|
+
api.has_param :credit_card_id, 'string'
|
744
|
+
api.has_param :english_legal_entity_name, 'string'
|
745
|
+
api.has_param :extended_credit_id, 'string'
|
753
746
|
api.has_param :is_smb, 'bool'
|
754
747
|
api.has_param :is_test, 'bool'
|
755
|
-
api.has_param :
|
748
|
+
api.has_param :legal_entity_name_in_local_language, 'string'
|
749
|
+
api.has_param :official_website_url, 'string'
|
750
|
+
api.has_param :planning_agency_business_id, 'string'
|
751
|
+
api.has_param :promotable_app_ids, { list: 'string' }
|
752
|
+
api.has_param :promotable_page_ids, { list: 'int' }
|
753
|
+
api.has_param :promotable_page_urls, { list: 'string' }
|
754
|
+
api.has_param :promotable_urls, { list: 'string' }
|
755
|
+
api.has_param :subvertical, { enum: -> { AdAccountCreationRequest::SUBVERTICAL }}
|
756
|
+
api.has_param :vertical, { enum: -> { AdAccountCreationRequest::VERTICAL }}
|
756
757
|
end
|
757
758
|
end
|
758
759
|
|
@@ -42,9 +42,9 @@ module FacebookAds
|
|
42
42
|
|
43
43
|
has_edge :activities do |edge|
|
44
44
|
edge.get do |api|
|
45
|
-
api.has_param :start_time, 'datetime'
|
46
45
|
api.has_param :end_time, 'datetime'
|
47
46
|
api.has_param :event_type, { enum: %w{RULE_CREATE RULE_EVENT_REMAPPING RULE_STATUS_UPDATE }}
|
47
|
+
api.has_param :start_time, 'datetime'
|
48
48
|
end
|
49
49
|
end
|
50
50
|
|
@@ -139,7 +139,7 @@ module FacebookAds
|
|
139
139
|
field :pacing_type, { list: 'string' }
|
140
140
|
field :promoted_object, 'AdPromotedObject'
|
141
141
|
field :recommendations, { list: 'AdRecommendation' }
|
142
|
-
field :source_campaign, '
|
142
|
+
field :source_campaign, 'Campaign'
|
143
143
|
field :source_campaign_id, 'string'
|
144
144
|
field :spend_cap, 'string'
|
145
145
|
field :start_time, 'datetime'
|
@@ -149,8 +149,8 @@ module FacebookAds
|
|
149
149
|
field :updated_time, 'datetime'
|
150
150
|
field :adbatch, { list: 'object' }
|
151
151
|
field :execution_options, { list: { enum: -> { EXECUTION_OPTIONS }} }
|
152
|
-
field :upstream_events, 'hash'
|
153
152
|
field :iterative_split_test_configs, { list: 'object' }
|
153
|
+
field :upstream_events, 'hash'
|
154
154
|
|
155
155
|
has_edge :ad_studies do |edge|
|
156
156
|
edge.get 'AdStudy'
|
@@ -175,60 +175,60 @@ module FacebookAds
|
|
175
175
|
|
176
176
|
has_edge :ads do |edge|
|
177
177
|
edge.get 'Ad' do |api|
|
178
|
-
api.has_param :
|
178
|
+
api.has_param :ad_draft_id, 'string'
|
179
179
|
api.has_param :date_preset, { enum: -> { Ad::DATE_PRESET }}
|
180
|
+
api.has_param :effective_status, { list: 'string' }
|
180
181
|
api.has_param :include_deleted, 'bool'
|
182
|
+
api.has_param :include_drafts, 'bool'
|
181
183
|
api.has_param :time_range, 'object'
|
182
184
|
api.has_param :updated_since, 'int'
|
183
|
-
api.has_param :ad_draft_id, 'string'
|
184
|
-
api.has_param :include_drafts, 'bool'
|
185
185
|
end
|
186
186
|
end
|
187
187
|
|
188
188
|
has_edge :adsets do |edge|
|
189
189
|
edge.get 'AdSet' do |api|
|
190
|
-
api.has_param :
|
190
|
+
api.has_param :ad_draft_id, 'string'
|
191
191
|
api.has_param :date_preset, { enum: -> { AdSet::DATE_PRESET }}
|
192
|
+
api.has_param :effective_status, { list: { enum: -> { AdSet::EFFECTIVE_STATUS }} }
|
193
|
+
api.has_param :include_drafts, 'bool'
|
192
194
|
api.has_param :is_completed, 'bool'
|
193
195
|
api.has_param :time_range, 'object'
|
194
|
-
api.has_param :ad_draft_id, 'string'
|
195
|
-
api.has_param :include_drafts, 'bool'
|
196
196
|
end
|
197
197
|
end
|
198
198
|
|
199
199
|
has_edge :copies do |edge|
|
200
200
|
edge.get 'Campaign' do |api|
|
201
|
-
api.has_param :effective_status, { list: { enum: -> { Campaign::EFFECTIVE_STATUS }} }
|
202
201
|
api.has_param :date_preset, { enum: -> { Campaign::DATE_PRESET }}
|
202
|
+
api.has_param :effective_status, { list: { enum: -> { Campaign::EFFECTIVE_STATUS }} }
|
203
203
|
api.has_param :is_completed, 'bool'
|
204
204
|
api.has_param :time_range, 'object'
|
205
205
|
end
|
206
206
|
edge.post 'Campaign' do |api|
|
207
207
|
api.has_param :deep_copy, 'bool'
|
208
|
+
api.has_param :end_time, 'datetime'
|
208
209
|
api.has_param :rename_options, 'object'
|
209
|
-
api.has_param :status_option, { enum: -> { Campaign::STATUS_OPTION }}
|
210
210
|
api.has_param :start_time, 'datetime'
|
211
|
-
api.has_param :
|
211
|
+
api.has_param :status_option, { enum: -> { Campaign::STATUS_OPTION }}
|
212
212
|
end
|
213
213
|
end
|
214
214
|
|
215
215
|
has_edge :insights do |edge|
|
216
216
|
edge.get 'AdsInsights' do |api|
|
217
|
-
api.has_param :default_summary, 'bool'
|
218
|
-
api.has_param :fields, { list: 'string' }
|
219
|
-
api.has_param :filtering, { list: 'object' }
|
220
|
-
api.has_param :summary, { list: 'string' }
|
221
|
-
api.has_param :sort, { list: 'string' }
|
222
217
|
api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
|
223
218
|
api.has_param :action_breakdowns, { list: { enum: -> { AdsInsights::ACTION_BREAKDOWNS }} }
|
224
219
|
api.has_param :action_report_time, { enum: -> { AdsInsights::ACTION_REPORT_TIME }}
|
225
220
|
api.has_param :breakdowns, { list: { enum: -> { AdsInsights::BREAKDOWNS }} }
|
226
221
|
api.has_param :date_preset, { enum: -> { AdsInsights::DATE_PRESET }}
|
222
|
+
api.has_param :default_summary, 'bool'
|
227
223
|
api.has_param :export_columns, { list: 'string' }
|
228
224
|
api.has_param :export_format, 'string'
|
229
225
|
api.has_param :export_name, 'string'
|
226
|
+
api.has_param :fields, { list: 'string' }
|
227
|
+
api.has_param :filtering, { list: 'object' }
|
230
228
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
231
229
|
api.has_param :product_id_limit, 'int'
|
230
|
+
api.has_param :sort, { list: 'string' }
|
231
|
+
api.has_param :summary, { list: 'string' }
|
232
232
|
api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
|
233
233
|
api.has_param :time_increment, 'string'
|
234
234
|
api.has_param :time_range, 'object'
|
@@ -236,21 +236,21 @@ module FacebookAds
|
|
236
236
|
api.has_param :use_account_attribution_setting, 'bool'
|
237
237
|
end
|
238
238
|
edge.post 'AdReportRun' do |api|
|
239
|
-
api.has_param :default_summary, 'bool'
|
240
|
-
api.has_param :fields, { list: 'string' }
|
241
|
-
api.has_param :filtering, { list: 'object' }
|
242
|
-
api.has_param :summary, { list: 'string' }
|
243
|
-
api.has_param :sort, { list: 'string' }
|
244
239
|
api.has_param :action_attribution_windows, { list: { enum: -> { AdsInsights::ACTION_ATTRIBUTION_WINDOWS }} }
|
245
240
|
api.has_param :action_breakdowns, { list: { enum: -> { AdsInsights::ACTION_BREAKDOWNS }} }
|
246
241
|
api.has_param :action_report_time, { enum: -> { AdsInsights::ACTION_REPORT_TIME }}
|
247
242
|
api.has_param :breakdowns, { list: { enum: -> { AdsInsights::BREAKDOWNS }} }
|
248
243
|
api.has_param :date_preset, { enum: -> { AdsInsights::DATE_PRESET }}
|
244
|
+
api.has_param :default_summary, 'bool'
|
249
245
|
api.has_param :export_columns, { list: 'string' }
|
250
246
|
api.has_param :export_format, 'string'
|
251
247
|
api.has_param :export_name, 'string'
|
248
|
+
api.has_param :fields, { list: 'string' }
|
249
|
+
api.has_param :filtering, { list: 'object' }
|
252
250
|
api.has_param :level, { enum: -> { AdsInsights::LEVEL }}
|
253
251
|
api.has_param :product_id_limit, 'int'
|
252
|
+
api.has_param :sort, { list: 'string' }
|
253
|
+
api.has_param :summary, { list: 'string' }
|
254
254
|
api.has_param :summary_action_breakdowns, { list: { enum: -> { AdsInsights::SUMMARY_ACTION_BREAKDOWNS }} }
|
255
255
|
api.has_param :time_increment, 'string'
|
256
256
|
api.has_param :time_range, 'object'
|