facebookbusiness 0.14.0.0 → 0.15.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/facebook_ads/ad_objects/ad_account.rb +19 -20
- data/lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +12 -0
- data/lib/facebook_ads/ad_objects/{content_delivery_report.rb → ad_account_custom_audience.rb} +4 -58
- data/lib/facebook_ads/ad_objects/ad_account_default_objective.rb +16 -10
- data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +7 -0
- data/lib/facebook_ads/ad_objects/ad_activity.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +4 -1
- data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative.rb +5 -6
- data/lib/facebook_ads/ad_objects/ad_creative_degrees_of_freedom_spec.rb +44 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +4 -0
- data/lib/facebook_ads/ad_objects/ad_image.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_monetization_property.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_network_analytics_async_query_result.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_network_analytics_sync_query_result.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_preview.rb +4 -0
- data/lib/facebook_ads/ad_objects/ad_rule.rb +1 -1
- data/lib/facebook_ads/ad_objects/ad_rule_history.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_set.rb +1 -10
- data/lib/facebook_ads/ad_objects/ad_study.rb +14 -1
- data/lib/facebook_ads/ad_objects/ad_study_cell.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_video.rb +12 -0
- data/lib/facebook_ads/ad_objects/adgroup_metadata.rb +41 -0
- data/lib/facebook_ads/ad_objects/ads_insights.rb +4 -0
- data/lib/facebook_ads/ad_objects/ads_pixel.rb +5 -1
- data/lib/facebook_ads/ad_objects/application.rb +21 -57
- data/lib/facebook_ads/ad_objects/automotive_model.rb +6 -0
- data/lib/facebook_ads/ad_objects/business.rb +35 -30
- data/lib/facebook_ads/ad_objects/business_asset_group.rb +2 -0
- data/lib/facebook_ads/ad_objects/business_asset_sharing_agreement.rb +1 -0
- data/lib/facebook_ads/ad_objects/business_owned_object_on_behalf_of_request.rb +1 -0
- data/lib/facebook_ads/ad_objects/business_partner_premium_options.rb +39 -0
- data/lib/facebook_ads/ad_objects/business_user.rb +4 -1
- data/lib/facebook_ads/ad_objects/campaign.rb +8 -11
- data/lib/facebook_ads/ad_objects/canvas.rb +2 -1
- data/lib/facebook_ads/ad_objects/{third_party_measurement_report_dataset.rb → canvas_dynamic_setting.rb} +4 -5
- data/lib/facebook_ads/ad_objects/catalog_segment_all_match_count_laser.rb +42 -0
- data/lib/facebook_ads/ad_objects/collaborative_ads_share_settings.rb +1 -0
- data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +11 -0
- data/lib/facebook_ads/ad_objects/commerce_merchant_tos_acceptance.rb +36 -0
- data/lib/facebook_ads/ad_objects/cpas_business_setup_config.rb +1 -0
- data/lib/facebook_ads/ad_objects/crm_address.rb +48 -0
- data/lib/facebook_ads/ad_objects/custom_audience.rb +1 -0
- data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb +1 -0
- data/lib/facebook_ads/ad_objects/destination.rb +6 -0
- data/lib/facebook_ads/ad_objects/event.rb +22 -26
- data/lib/facebook_ads/ad_objects/event_source_group.rb +1 -0
- data/lib/facebook_ads/ad_objects/experience.rb +1 -1
- data/lib/facebook_ads/ad_objects/extended_credit.rb +3 -0
- data/lib/facebook_ads/ad_objects/extended_credit_invoice_group.rb +4 -0
- data/lib/facebook_ads/ad_objects/flight.rb +6 -0
- data/lib/facebook_ads/ad_objects/group.rb +0 -72
- data/lib/facebook_ads/ad_objects/home_listing.rb +6 -0
- data/lib/facebook_ads/ad_objects/hotel.rb +6 -0
- data/lib/facebook_ads/ad_objects/hotel_room.rb +1 -0
- data/lib/facebook_ads/ad_objects/ig_media.rb +1 -0
- data/lib/facebook_ads/ad_objects/ig_user.rb +5 -0
- data/lib/facebook_ads/ad_objects/{canvas_template.rb → igbc_ads_permission.rb} +2 -13
- data/lib/facebook_ads/ad_objects/image_copyright.rb +1 -0
- data/lib/facebook_ads/ad_objects/insights_result.rb +1 -0
- data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +27 -3
- data/lib/facebook_ads/ad_objects/instagram_user.rb +1 -0
- data/lib/facebook_ads/ad_objects/instant_article_insights_query_result.rb +1 -0
- data/lib/facebook_ads/ad_objects/jobs_job.rb +6 -0
- data/lib/facebook_ads/ad_objects/leadgen_form.rb +2 -0
- data/lib/facebook_ads/ad_objects/local_service_business.rb +6 -0
- data/lib/facebook_ads/ad_objects/media_title.rb +85 -0
- data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb +2 -0
- data/lib/facebook_ads/ad_objects/page.rb +33 -17
- data/lib/facebook_ads/ad_objects/page_upcoming_change.rb +1 -0
- data/lib/facebook_ads/ad_objects/private_lift_study_instance.rb +4 -0
- data/lib/facebook_ads/ad_objects/product_catalog.rb +18 -6
- data/lib/facebook_ads/ad_objects/product_feed.rb +8 -2
- data/lib/facebook_ads/ad_objects/product_item.rb +10 -0
- data/lib/facebook_ads/ad_objects/product_item_ar_data.rb +1 -0
- data/lib/facebook_ads/ad_objects/product_set.rb +7 -0
- data/lib/facebook_ads/ad_objects/saved_audience.rb +1 -0
- data/lib/facebook_ads/ad_objects/shop.rb +1 -0
- data/lib/facebook_ads/ad_objects/{copyright_audio_asset.rb → shop_order.rb} +1 -4
- data/lib/facebook_ads/ad_objects/store_catalog_settings.rb +1 -0
- data/lib/facebook_ads/ad_objects/system_user.rb +3 -1
- data/lib/facebook_ads/ad_objects/targeting.rb +1 -0
- data/lib/facebook_ads/ad_objects/targeting_relaxation.rb +1 -0
- data/lib/facebook_ads/ad_objects/unified_thread.rb +1 -1
- data/lib/facebook_ads/ad_objects/user.rb +17 -10
- data/lib/facebook_ads/ad_objects/user_page_one_time_opt_in_token_settings.rb +44 -0
- data/lib/facebook_ads/ad_objects/vehicle.rb +7 -0
- data/lib/facebook_ads/ad_objects/vehicle_offer.rb +6 -0
- data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +25 -3
- data/lib/facebook_ads/version.rb +2 -2
- metadata +15 -8
- data/lib/facebook_ads/ad_objects/ad_campaign_activity.rb +0 -184
@@ -45,6 +45,7 @@ module FacebookAds
|
|
45
45
|
"AUDIO_COMMENT",
|
46
46
|
"BROADCAST",
|
47
47
|
"BULLETIN_ARTICLE_AUDIO",
|
48
|
+
"CANDIDATE_VIDEOS_DELETED",
|
48
49
|
"CANVAS",
|
49
50
|
"CFC_VIDEO",
|
50
51
|
"CMS_MEDIA_MANAGER",
|
@@ -61,6 +62,7 @@ module FacebookAds
|
|
61
62
|
"DIRECTED_POST_ATTACHMENT",
|
62
63
|
"DIRECT_INBOX",
|
63
64
|
"DIRECT_INBOX_REACTION",
|
65
|
+
"DROPS_SHOPPING_EVENT_PAGE",
|
64
66
|
"DYNAMIC_ITEM_DISPLAY_BUNDLE",
|
65
67
|
"DYNAMIC_ITEM_VIDEO",
|
66
68
|
"DYNAMIC_TEMPLATE_VIDEO",
|
@@ -73,6 +75,7 @@ module FacebookAds
|
|
73
75
|
"FB_SHORTS_CROSS_META_POST",
|
74
76
|
"FB_SHORTS_GROUP_POST",
|
75
77
|
"FB_SHORTS_PMV_POST",
|
78
|
+
"FB_SHORTS_PMV_POST_NO_NEWSFEED_NOR_TIMELINE",
|
76
79
|
"FB_SHORTS_POST",
|
77
80
|
"FB_SHORTS_REMIX_POST",
|
78
81
|
"FUNDRAISER_COVER_VIDEO",
|
@@ -137,6 +140,8 @@ module FacebookAds
|
|
137
140
|
"PAID_CONTENT_PREVIEW",
|
138
141
|
"PAID_CONTENT_VIDEO",
|
139
142
|
"PAID_CONTENT_VIDEO__POST",
|
143
|
+
"PAPER_DOCUMENT_AUDIO",
|
144
|
+
"PAPER_DOCUMENT_VIDEO",
|
140
145
|
"PIXELCLOUD",
|
141
146
|
"PODCAST_HIGHLIGHT",
|
142
147
|
"PODCAST_ML_PREVIEW",
|
@@ -253,6 +258,12 @@ module FacebookAds
|
|
253
258
|
"uploaded",
|
254
259
|
]
|
255
260
|
|
261
|
+
VIDEO_STATE = [
|
262
|
+
"DRAFT",
|
263
|
+
"PUBLISHED",
|
264
|
+
"SCHEDULED",
|
265
|
+
]
|
266
|
+
|
256
267
|
BACKDATED_TIME_GRANULARITY = [
|
257
268
|
"day",
|
258
269
|
"hour",
|
@@ -264,6 +275,7 @@ module FacebookAds
|
|
264
275
|
|
265
276
|
|
266
277
|
field :ad_breaks, { list: 'int' }
|
278
|
+
field :admin_creator, 'User'
|
267
279
|
field :audio_isrc, 'object'
|
268
280
|
field :backdated_time, 'datetime'
|
269
281
|
field :backdated_time_granularity, 'string'
|
@@ -0,0 +1,41 @@
|
|
1
|
+
# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
|
2
|
+
#
|
3
|
+
# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
|
4
|
+
# copy, modify, and distribute this software in source code or binary form for use
|
5
|
+
# in connection with the web services and APIs provided by Facebook.
|
6
|
+
#
|
7
|
+
# As with any software that integrates with the Facebook platform, your use of
|
8
|
+
# this software is subject to the Facebook Platform Policy
|
9
|
+
# [http://developers.facebook.com/policy/]. This copyright notice shall be
|
10
|
+
# included in all copies or substantial portions of the software.
|
11
|
+
#
|
12
|
+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
13
|
+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
14
|
+
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
15
|
+
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
16
|
+
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
17
|
+
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
18
|
+
|
19
|
+
# FB:AUTOGEN
|
20
|
+
|
21
|
+
module FacebookAds
|
22
|
+
# This class is auto-generated.
|
23
|
+
|
24
|
+
# For any issues or feature requests related to this class, please let us know
|
25
|
+
# on github and we'll fix in our codegen framework. We'll not be able to accept
|
26
|
+
# pull request for this class.
|
27
|
+
|
28
|
+
class AdgroupMetadata < AdObject
|
29
|
+
|
30
|
+
field :ad_standard_enhancements_edit_source, 'int'
|
31
|
+
field :adgroup_creation_source, 'string'
|
32
|
+
field :adgroup_edit_source, 'string'
|
33
|
+
field :carousel_style, 'string'
|
34
|
+
field :carousel_with_static_card_style, 'string'
|
35
|
+
has_no_id
|
36
|
+
has_no_get
|
37
|
+
has_no_post
|
38
|
+
has_no_delete
|
39
|
+
|
40
|
+
end
|
41
|
+
end
|
@@ -74,12 +74,15 @@ module FacebookAds
|
|
74
74
|
"hourly_stats_aggregated_by_audience_time_zone",
|
75
75
|
"image_asset",
|
76
76
|
"impression_device",
|
77
|
+
"is_conversion_id_modeled",
|
77
78
|
"link_url_asset",
|
79
|
+
"mmm",
|
78
80
|
"place_page_id",
|
79
81
|
"platform_position",
|
80
82
|
"product_id",
|
81
83
|
"publisher_platform",
|
82
84
|
"region",
|
85
|
+
"skan_campaign_id",
|
83
86
|
"skan_conversion_id",
|
84
87
|
"title_asset",
|
85
88
|
"video_asset",
|
@@ -228,6 +231,7 @@ module FacebookAds
|
|
228
231
|
field :social_spend, 'string'
|
229
232
|
field :spend, 'string'
|
230
233
|
field :total_postbacks, 'string'
|
234
|
+
field :total_postbacks_detailed, { list: 'AdsActionStats' }
|
231
235
|
field :unique_actions, { list: 'AdsActionStats' }
|
232
236
|
field :unique_clicks, 'string'
|
233
237
|
field :unique_conversions, { list: 'AdsActionStats' }
|
@@ -102,7 +102,7 @@ module FacebookAds
|
|
102
102
|
end
|
103
103
|
|
104
104
|
has_edge :events do |edge|
|
105
|
-
edge.post
|
105
|
+
edge.post do |api|
|
106
106
|
api.has_param :data, { list: 'string' }
|
107
107
|
api.has_param :namespace_id, 'string'
|
108
108
|
api.has_param :partner_agent, 'string'
|
@@ -115,6 +115,10 @@ module FacebookAds
|
|
115
115
|
end
|
116
116
|
end
|
117
117
|
|
118
|
+
has_edge :meapitocapiconsolidationhelper do |edge|
|
119
|
+
edge.post
|
120
|
+
end
|
121
|
+
|
118
122
|
has_edge :shadowtraffichelper do |edge|
|
119
123
|
edge.post
|
120
124
|
end
|
@@ -77,17 +77,6 @@ module FacebookAds
|
|
77
77
|
"EYMT",
|
78
78
|
]
|
79
79
|
|
80
|
-
SCORE_TYPE = [
|
81
|
-
"CUSTOM",
|
82
|
-
"NUMERIC",
|
83
|
-
"TIME",
|
84
|
-
]
|
85
|
-
|
86
|
-
SORT_ORDER = [
|
87
|
-
"HIGHER_IS_BETTER",
|
88
|
-
"LOWER_IS_BETTER",
|
89
|
-
]
|
90
|
-
|
91
80
|
LOGGING_SOURCE = [
|
92
81
|
"MESSENGER_BOT",
|
93
82
|
]
|
@@ -124,6 +113,7 @@ module FacebookAds
|
|
124
113
|
field :auto_event_mapping_android, { list: 'object' }
|
125
114
|
field :auto_event_mapping_ios, { list: 'object' }
|
126
115
|
field :auto_event_setup_enabled, 'bool'
|
116
|
+
field :business, 'Business'
|
127
117
|
field :canvas_fluid_height, 'bool'
|
128
118
|
field :canvas_fluid_width, 'int'
|
129
119
|
field :canvas_url, 'string'
|
@@ -159,7 +149,6 @@ module FacebookAds
|
|
159
149
|
field :latest_sdk_version, 'object'
|
160
150
|
field :link, 'string'
|
161
151
|
field :logging_token, 'string'
|
162
|
-
field :login_secret, 'string'
|
163
152
|
field :logo_url, 'string'
|
164
153
|
field :migrations, 'hash'
|
165
154
|
field :mobile_profile_section_url, 'string'
|
@@ -169,6 +158,7 @@ module FacebookAds
|
|
169
158
|
field :name, 'string'
|
170
159
|
field :namespace, 'string'
|
171
160
|
field :object_store_urls, 'object'
|
161
|
+
field :owner_business, 'Business'
|
172
162
|
field :page_tab_default_name, 'string'
|
173
163
|
field :page_tab_url, 'string'
|
174
164
|
field :photo_url, 'string'
|
@@ -233,6 +223,7 @@ module FacebookAds
|
|
233
223
|
api.has_param :bundle_id, 'string'
|
234
224
|
api.has_param :bundle_short_version, 'string'
|
235
225
|
api.has_param :bundle_version, 'string'
|
226
|
+
api.has_param :campaign_ids, 'string'
|
236
227
|
api.has_param :click_id, 'string'
|
237
228
|
api.has_param :consider_views, 'bool'
|
238
229
|
api.has_param :custom_events, { list: 'object' }
|
@@ -302,6 +293,13 @@ module FacebookAds
|
|
302
293
|
end
|
303
294
|
end
|
304
295
|
|
296
|
+
has_edge :aem_attribution do |edge|
|
297
|
+
edge.get do |api|
|
298
|
+
api.has_param :advertiser_ids, { list: 'string' }
|
299
|
+
api.has_param :fb_content_data, 'string'
|
300
|
+
end
|
301
|
+
end
|
302
|
+
|
305
303
|
has_edge :aem_conversion_configs do |edge|
|
306
304
|
edge.get do |api|
|
307
305
|
api.has_param :advertiser_ids, { list: 'string' }
|
@@ -325,6 +323,7 @@ module FacebookAds
|
|
325
323
|
edge.post do |api|
|
326
324
|
api.has_param :app_id, 'int'
|
327
325
|
api.has_param :is_aem_ready, 'bool'
|
326
|
+
api.has_param :is_aem_v2_ready, 'bool'
|
328
327
|
api.has_param :is_skan_ready, 'bool'
|
329
328
|
end
|
330
329
|
end
|
@@ -346,6 +345,10 @@ module FacebookAds
|
|
346
345
|
edge.get
|
347
346
|
end
|
348
347
|
|
348
|
+
has_edge :app_capi_settings do |edge|
|
349
|
+
edge.get
|
350
|
+
end
|
351
|
+
|
349
352
|
has_edge :app_event_types do |edge|
|
350
353
|
edge.get
|
351
354
|
end
|
@@ -400,12 +403,6 @@ module FacebookAds
|
|
400
403
|
end
|
401
404
|
end
|
402
405
|
|
403
|
-
has_edge :banned do |edge|
|
404
|
-
edge.delete do |api|
|
405
|
-
api.has_param :uids, { list: 'int' }
|
406
|
-
end
|
407
|
-
end
|
408
|
-
|
409
406
|
has_edge :button_auto_detection_device_selection do |edge|
|
410
407
|
edge.get do |api|
|
411
408
|
api.has_param :device_id, 'string'
|
@@ -441,44 +438,12 @@ module FacebookAds
|
|
441
438
|
|
442
439
|
has_edge :insights_push_schedule do |edge|
|
443
440
|
edge.get
|
444
|
-
edge.post do |api|
|
445
|
-
api.has_param :ad_account_ids, { list: 'string' }
|
446
|
-
api.has_param :breakdowns, { list: 'string' }
|
447
|
-
api.has_param :date_preset, 'string'
|
448
|
-
api.has_param :level, { enum: %w{ACCOUNT AD ADSET CAMPAIGN }}
|
449
|
-
api.has_param :metrics, { list: 'string' }
|
450
|
-
api.has_param :object_id, 'string'
|
451
|
-
api.has_param :owner_id, 'int'
|
452
|
-
api.has_param :schedule, { enum: %w{DAILY FINE_15_MIN FINE_5_MIN MONTHLY WEEKLY }}
|
453
|
-
api.has_param :status, { enum: %w{ACTIVE DISABLED ERROR }}
|
454
|
-
api.has_param :time_increment, 'int'
|
455
|
-
api.has_param :time_start, 'datetime'
|
456
|
-
api.has_param :time_stop, 'datetime'
|
457
|
-
end
|
458
441
|
end
|
459
442
|
|
460
443
|
has_edge :ios_dialog_configs do |edge|
|
461
444
|
edge.get
|
462
445
|
end
|
463
446
|
|
464
|
-
has_edge :leaderboards_create do |edge|
|
465
|
-
edge.post 'Application' do |api|
|
466
|
-
api.has_param :context_id, 'string'
|
467
|
-
api.has_param :decimal_offset, 'int'
|
468
|
-
api.has_param :name, 'string'
|
469
|
-
api.has_param :score_type, { enum: -> { Application::SCORE_TYPE }}
|
470
|
-
api.has_param :sort_order, { enum: -> { Application::SORT_ORDER }}
|
471
|
-
api.has_param :unit, 'string'
|
472
|
-
end
|
473
|
-
end
|
474
|
-
|
475
|
-
has_edge :leaderboards_delete_entry do |edge|
|
476
|
-
edge.post 'Application' do |api|
|
477
|
-
api.has_param :name, 'string'
|
478
|
-
api.has_param :player_id, 'string'
|
479
|
-
end
|
480
|
-
end
|
481
|
-
|
482
447
|
has_edge :mmp_auditing do |edge|
|
483
448
|
edge.post do |api|
|
484
449
|
api.has_param :advertiser_id, 'string'
|
@@ -494,6 +459,7 @@ module FacebookAds
|
|
494
459
|
api.has_param :fb_click_time, 'int'
|
495
460
|
api.has_param :fb_view_time, 'int'
|
496
461
|
api.has_param :is_fb, 'bool'
|
462
|
+
api.has_param :used_install_referrer, 'bool'
|
497
463
|
api.has_param :view_attr_window, 'int'
|
498
464
|
end
|
499
465
|
end
|
@@ -509,12 +475,17 @@ module FacebookAds
|
|
509
475
|
end
|
510
476
|
|
511
477
|
has_edge :monetized_digital_store_objects do |edge|
|
478
|
+
edge.get
|
512
479
|
edge.post do |api|
|
513
480
|
api.has_param :content_id, 'string'
|
514
481
|
api.has_param :store, 'string'
|
515
482
|
end
|
516
483
|
end
|
517
484
|
|
485
|
+
has_edge :object_types do |edge|
|
486
|
+
edge.get 'NullNode'
|
487
|
+
end
|
488
|
+
|
518
489
|
has_edge :occludespopups do |edge|
|
519
490
|
edge.post do |api|
|
520
491
|
api.has_param :flash, 'bool'
|
@@ -603,12 +574,5 @@ module FacebookAds
|
|
603
574
|
end
|
604
575
|
end
|
605
576
|
|
606
|
-
has_edge :user_properties do |edge|
|
607
|
-
edge.post do |api|
|
608
|
-
api.has_param :data, { list: 'object' }
|
609
|
-
api.has_param :limited_data_use, 'bool'
|
610
|
-
end
|
611
|
-
end
|
612
|
-
|
613
577
|
end
|
614
578
|
end
|
@@ -35,6 +35,11 @@ module FacebookAds
|
|
35
35
|
"PARTIAL_FETCH",
|
36
36
|
]
|
37
37
|
|
38
|
+
VISIBILITY = [
|
39
|
+
"PUBLISHED",
|
40
|
+
"STAGING",
|
41
|
+
]
|
42
|
+
|
38
43
|
|
39
44
|
field :applinks, 'CatalogItemAppLinks'
|
40
45
|
field :automotive_model_id, 'string'
|
@@ -64,6 +69,7 @@ module FacebookAds
|
|
64
69
|
field :trim, 'string'
|
65
70
|
field :unit_price, 'object'
|
66
71
|
field :url, 'string'
|
72
|
+
field :visibility, { enum: -> { VISIBILITY }}
|
67
73
|
field :year, 'int'
|
68
74
|
has_no_post
|
69
75
|
has_no_delete
|
@@ -76,6 +76,7 @@ module FacebookAds
|
|
76
76
|
"PROFILE_PLUS_FACEBOOK_ACCESS",
|
77
77
|
"PROFILE_PLUS_FULL_CONTROL",
|
78
78
|
"PROFILE_PLUS_MANAGE",
|
79
|
+
"PROFILE_PLUS_MANAGE_LEADS",
|
79
80
|
"PROFILE_PLUS_MESSAGING",
|
80
81
|
"PROFILE_PLUS_MODERATE",
|
81
82
|
"PROFILE_PLUS_MODERATE_DELEGATE_COMMUNITY",
|
@@ -110,6 +111,7 @@ module FacebookAds
|
|
110
111
|
"PROFILE_PLUS_FACEBOOK_ACCESS",
|
111
112
|
"PROFILE_PLUS_FULL_CONTROL",
|
112
113
|
"PROFILE_PLUS_MANAGE",
|
114
|
+
"PROFILE_PLUS_MANAGE_LEADS",
|
113
115
|
"PROFILE_PLUS_MESSAGING",
|
114
116
|
"PROFILE_PLUS_MODERATE",
|
115
117
|
"PROFILE_PLUS_MODERATE_DELEGATE_COMMUNITY",
|
@@ -122,6 +124,7 @@ module FacebookAds
|
|
122
124
|
field :block_offline_analytics, 'bool'
|
123
125
|
field :collaborative_ads_managed_partner_business_info, 'ManagedPartnerBusiness'
|
124
126
|
field :collaborative_ads_managed_partner_eligibility, 'BusinessManagedPartnerEligibility'
|
127
|
+
field :collaborative_ads_partner_premium_options, 'BusinessPartnerPremiumOptions'
|
125
128
|
field :created_by, 'object'
|
126
129
|
field :created_time, 'datetime'
|
127
130
|
field :extended_updated_time, 'datetime'
|
@@ -229,6 +232,16 @@ module FacebookAds
|
|
229
232
|
end
|
230
233
|
end
|
231
234
|
|
235
|
+
has_edge :ads_reporting_mmm_reports do |edge|
|
236
|
+
edge.get do |api|
|
237
|
+
api.has_param :filtering, { list: 'hash' }
|
238
|
+
end
|
239
|
+
end
|
240
|
+
|
241
|
+
has_edge :ads_reporting_mmm_schedulers do |edge|
|
242
|
+
edge.get
|
243
|
+
end
|
244
|
+
|
232
245
|
has_edge :adspixels do |edge|
|
233
246
|
edge.get 'AdsPixel' do |api|
|
234
247
|
api.has_param :id_filter, 'string'
|
@@ -289,7 +302,9 @@ module FacebookAds
|
|
289
302
|
end
|
290
303
|
|
291
304
|
has_edge :client_ad_accounts do |edge|
|
292
|
-
edge.get 'AdAccount'
|
305
|
+
edge.get 'AdAccount' do |api|
|
306
|
+
api.has_param :search_query, 'string'
|
307
|
+
end
|
293
308
|
end
|
294
309
|
|
295
310
|
has_edge :client_apps do |edge|
|
@@ -354,17 +369,6 @@ module FacebookAds
|
|
354
369
|
edge.get 'CommerceMerchantSettings'
|
355
370
|
end
|
356
371
|
|
357
|
-
has_edge :content_delivery_report do |edge|
|
358
|
-
edge.get 'ContentDeliveryReport' do |api|
|
359
|
-
api.has_param :end_date, 'datetime'
|
360
|
-
api.has_param :page_id, 'int'
|
361
|
-
api.has_param :platform, { enum: -> { ContentDeliveryReport::PLATFORM }}
|
362
|
-
api.has_param :position, { enum: -> { ContentDeliveryReport::POSITION }}
|
363
|
-
api.has_param :start_date, 'datetime'
|
364
|
-
api.has_param :summary, 'bool'
|
365
|
-
end
|
366
|
-
end
|
367
|
-
|
368
372
|
has_edge :cpas_business_setup_config do |edge|
|
369
373
|
edge.get 'CpasBusinessSetupConfig'
|
370
374
|
edge.post 'CpasBusinessSetupConfig' do |api|
|
@@ -379,14 +383,6 @@ module FacebookAds
|
|
379
383
|
edge.get 'CpasMerchantConfig'
|
380
384
|
end
|
381
385
|
|
382
|
-
has_edge :create_and_apply_publisher_block_list do |edge|
|
383
|
-
edge.post do |api|
|
384
|
-
api.has_param :is_auto_blocking_on, 'bool'
|
385
|
-
api.has_param :name, 'string'
|
386
|
-
api.has_param :publisher_urls, { list: 'string' }
|
387
|
-
end
|
388
|
-
end
|
389
|
-
|
390
386
|
has_edge :creditcards do |edge|
|
391
387
|
edge.get 'CreditCard'
|
392
388
|
end
|
@@ -477,6 +473,10 @@ module FacebookAds
|
|
477
473
|
end
|
478
474
|
|
479
475
|
has_edge :managed_partner_businesses do |edge|
|
476
|
+
edge.delete do |api|
|
477
|
+
api.has_param :child_business_external_id, 'string'
|
478
|
+
api.has_param :child_business_id, 'string'
|
479
|
+
end
|
480
480
|
edge.post do |api|
|
481
481
|
api.has_param :ad_account_currency, 'string'
|
482
482
|
api.has_param :catalog_id, 'string'
|
@@ -500,14 +500,6 @@ module FacebookAds
|
|
500
500
|
end
|
501
501
|
end
|
502
502
|
|
503
|
-
has_edge :managed_partner_child_business_assets do |edge|
|
504
|
-
edge.post 'Business' do |api|
|
505
|
-
api.has_param :child_business_id, 'string'
|
506
|
-
api.has_param :credit_limit, 'int'
|
507
|
-
api.has_param :line_of_credit_id, 'string'
|
508
|
-
end
|
509
|
-
end
|
510
|
-
|
511
503
|
has_edge :negative_keyword_lists do |edge|
|
512
504
|
edge.get
|
513
505
|
end
|
@@ -524,7 +516,9 @@ module FacebookAds
|
|
524
516
|
end
|
525
517
|
|
526
518
|
has_edge :owned_ad_accounts do |edge|
|
527
|
-
edge.get 'AdAccount'
|
519
|
+
edge.get 'AdAccount' do |api|
|
520
|
+
api.has_param :search_query, 'string'
|
521
|
+
end
|
528
522
|
edge.post 'Business' do |api|
|
529
523
|
api.has_param :adaccount_id, 'string'
|
530
524
|
end
|
@@ -605,6 +599,17 @@ module FacebookAds
|
|
605
599
|
end
|
606
600
|
end
|
607
601
|
|
602
|
+
has_edge :partner_premium_options do |edge|
|
603
|
+
edge.post do |api|
|
604
|
+
api.has_param :catalog_segment_id, 'string'
|
605
|
+
api.has_param :enable_basket_insight, 'bool'
|
606
|
+
api.has_param :enable_extended_audience_retargeting, 'bool'
|
607
|
+
api.has_param :partner_business_id, 'string'
|
608
|
+
api.has_param :retailer_custom_audience_config, 'hash'
|
609
|
+
api.has_param :vendor_id, 'string'
|
610
|
+
end
|
611
|
+
end
|
612
|
+
|
608
613
|
has_edge :pending_client_ad_accounts do |edge|
|
609
614
|
edge.get 'BusinessAdAccountRequest'
|
610
615
|
end
|
@@ -666,7 +671,7 @@ module FacebookAds
|
|
666
671
|
end
|
667
672
|
|
668
673
|
has_edge :third_party_measurement_report_dataset do |edge|
|
669
|
-
edge.get
|
674
|
+
edge.get
|
670
675
|
end
|
671
676
|
|
672
677
|
end
|
@@ -61,6 +61,7 @@ module FacebookAds
|
|
61
61
|
"PROFILE_PLUS_FACEBOOK_ACCESS",
|
62
62
|
"PROFILE_PLUS_FULL_CONTROL",
|
63
63
|
"PROFILE_PLUS_MANAGE",
|
64
|
+
"PROFILE_PLUS_MANAGE_LEADS",
|
64
65
|
"PROFILE_PLUS_MESSAGING",
|
65
66
|
"PROFILE_PLUS_MODERATE",
|
66
67
|
"PROFILE_PLUS_MODERATE_DELEGATE_COMMUNITY",
|
@@ -80,6 +81,7 @@ module FacebookAds
|
|
80
81
|
|
81
82
|
field :id, 'string'
|
82
83
|
field :name, 'string'
|
84
|
+
field :owner_business, 'Business'
|
83
85
|
has_no_delete
|
84
86
|
|
85
87
|
has_edge :assigned_users do |edge|
|
@@ -0,0 +1,39 @@
|
|
1
|
+
# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
|
2
|
+
#
|
3
|
+
# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
|
4
|
+
# copy, modify, and distribute this software in source code or binary form for use
|
5
|
+
# in connection with the web services and APIs provided by Facebook.
|
6
|
+
#
|
7
|
+
# As with any software that integrates with the Facebook platform, your use of
|
8
|
+
# this software is subject to the Facebook Platform Policy
|
9
|
+
# [http://developers.facebook.com/policy/]. This copyright notice shall be
|
10
|
+
# included in all copies or substantial portions of the software.
|
11
|
+
#
|
12
|
+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
13
|
+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
14
|
+
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
15
|
+
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
16
|
+
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
17
|
+
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
18
|
+
|
19
|
+
# FB:AUTOGEN
|
20
|
+
|
21
|
+
module FacebookAds
|
22
|
+
# This class is auto-generated.
|
23
|
+
|
24
|
+
# For any issues or feature requests related to this class, please let us know
|
25
|
+
# on github and we'll fix in our codegen framework. We'll not be able to accept
|
26
|
+
# pull request for this class.
|
27
|
+
|
28
|
+
class BusinessPartnerPremiumOptions < AdObject
|
29
|
+
|
30
|
+
field :enable_basket_insight, 'bool'
|
31
|
+
field :enable_extended_audience_retargeting, 'bool'
|
32
|
+
field :retailer_custom_audience_config, 'object'
|
33
|
+
has_no_id
|
34
|
+
has_no_get
|
35
|
+
has_no_post
|
36
|
+
has_no_delete
|
37
|
+
|
38
|
+
end
|
39
|
+
end
|
@@ -46,6 +46,7 @@ module FacebookAds
|
|
46
46
|
|
47
47
|
|
48
48
|
field :business, 'Business'
|
49
|
+
field :business_role_request, 'BusinessRoleRequest'
|
49
50
|
field :email, 'string'
|
50
51
|
field :finance_permission, 'string'
|
51
52
|
field :first_name, 'string'
|
@@ -70,7 +71,9 @@ module FacebookAds
|
|
70
71
|
end
|
71
72
|
|
72
73
|
has_edge :assigned_pages do |edge|
|
73
|
-
edge.get 'Page'
|
74
|
+
edge.get 'Page' do |api|
|
75
|
+
api.has_param :pages, { list: 'int' }
|
76
|
+
end
|
74
77
|
end
|
75
78
|
|
76
79
|
has_edge :assigned_product_catalogs do |edge|
|
@@ -93,6 +93,12 @@ module FacebookAds
|
|
93
93
|
"LOCAL_AWARENESS",
|
94
94
|
"MESSAGES",
|
95
95
|
"OFFER_CLAIMS",
|
96
|
+
"OUTCOME_APP_PROMOTION",
|
97
|
+
"OUTCOME_AWARENESS",
|
98
|
+
"OUTCOME_ENGAGEMENT",
|
99
|
+
"OUTCOME_LEADS",
|
100
|
+
"OUTCOME_SALES",
|
101
|
+
"OUTCOME_TRAFFIC",
|
96
102
|
"PAGE_LIKES",
|
97
103
|
"POST_ENGAGEMENT",
|
98
104
|
"PRODUCT_CATALOG_SALES",
|
@@ -406,6 +412,7 @@ module FacebookAds
|
|
406
412
|
field :created_time, 'datetime'
|
407
413
|
field :daily_budget, 'string'
|
408
414
|
field :effective_status, { enum: -> { EFFECTIVE_STATUS }}
|
415
|
+
field :has_secondary_skadnetwork_reporting, 'bool'
|
409
416
|
field :id, 'string'
|
410
417
|
field :is_skadnetwork_attribution, 'bool'
|
411
418
|
field :issues_info, { list: 'AdCampaignIssuesInfo' }
|
@@ -414,6 +421,7 @@ module FacebookAds
|
|
414
421
|
field :name, 'string'
|
415
422
|
field :objective, 'string'
|
416
423
|
field :pacing_type, { list: 'string' }
|
424
|
+
field :primary_attribution, 'string'
|
417
425
|
field :promoted_object, 'AdPromotedObject'
|
418
426
|
field :recommendations, { list: 'AdRecommendation' }
|
419
427
|
field :smart_promotion_type, 'string'
|
@@ -468,17 +476,6 @@ module FacebookAds
|
|
468
476
|
end
|
469
477
|
end
|
470
478
|
|
471
|
-
has_edge :content_delivery_report do |edge|
|
472
|
-
edge.get 'ContentDeliveryReport' do |api|
|
473
|
-
api.has_param :end_date, 'datetime'
|
474
|
-
api.has_param :page_id, 'int'
|
475
|
-
api.has_param :platform, { enum: -> { ContentDeliveryReport::PLATFORM }}
|
476
|
-
api.has_param :position, { enum: -> { ContentDeliveryReport::POSITION }}
|
477
|
-
api.has_param :start_date, 'datetime'
|
478
|
-
api.has_param :summary, 'bool'
|
479
|
-
end
|
480
|
-
end
|
481
|
-
|
482
479
|
has_edge :copies do |edge|
|
483
480
|
edge.get 'Campaign' do |api|
|
484
481
|
api.has_param :date_preset, { enum: -> { Campaign::DATE_PRESET }}
|
@@ -34,6 +34,7 @@ module FacebookAds
|
|
34
34
|
field :collection_hero_image, 'Photo'
|
35
35
|
field :collection_hero_video, 'AdVideo'
|
36
36
|
field :collection_thumbnails, { list: 'CanvasCollectionThumbnail' }
|
37
|
+
field :dynamic_setting, 'CanvasDynamicSetting'
|
37
38
|
field :element_payload, 'string'
|
38
39
|
field :elements, { list: 'RichMediaElement' }
|
39
40
|
field :fb_body_elements, { list: 'object' }
|
@@ -45,7 +46,7 @@ module FacebookAds
|
|
45
46
|
field :name, 'string'
|
46
47
|
field :owner, 'Page'
|
47
48
|
field :property_list, { list: 'string' }
|
48
|
-
field :source_template, '
|
49
|
+
field :source_template, 'object'
|
49
50
|
field :store_url, 'string'
|
50
51
|
field :style_list, { list: 'string' }
|
51
52
|
field :tags, { list: 'string' }
|
@@ -25,13 +25,12 @@ module FacebookAds
|
|
25
25
|
# on github and we'll fix in our codegen framework. We'll not be able to accept
|
26
26
|
# pull request for this class.
|
27
27
|
|
28
|
-
class
|
28
|
+
class CanvasDynamicSetting < AdObject
|
29
29
|
|
30
|
-
field :
|
30
|
+
field :child_documents, { list: 'Canvas' }
|
31
|
+
field :product_set_id, 'string'
|
31
32
|
field :id, 'string'
|
32
|
-
|
33
|
-
field :product, 'string'
|
34
|
-
field :schema, { list: 'object' }
|
33
|
+
has_no_post
|
35
34
|
has_no_delete
|
36
35
|
|
37
36
|
end
|