facebookbusiness 0.11.0.0 → 0.13.0.0
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.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_account.rb +36 -24
- data/lib/facebook_ads/ad_objects/ad_account_ad_volume.rb +6 -0
- data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +6 -9
- data/lib/facebook_ads/ad_objects/ad_account_matched_search_applications_edge_data.rb +9 -0
- data/lib/facebook_ads/ad_objects/ad_account_reach_estimate.rb +2 -1
- data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +12 -1
- data/lib/facebook_ads/ad_objects/ad_activity.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +3 -1
- data/lib/facebook_ads/ad_objects/ad_async_request_set.rb +1 -7
- data/lib/facebook_ads/ad_objects/ad_campaign_activity.rb +6 -16
- data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +6 -9
- data/lib/facebook_ads/ad_objects/ad_creative.rb +6 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_image_overlay_spec.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_image.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_place_page_set.rb +0 -6
- data/lib/facebook_ads/ad_objects/ad_preview.rb +8 -1
- data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_rule.rb +27 -0
- data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb +3 -0
- data/lib/facebook_ads/ad_objects/ad_set.rb +12 -24
- data/lib/facebook_ads/ad_objects/ad_study.rb +0 -1
- data/lib/facebook_ads/ad_objects/ad_study_objective.rb +1 -1
- data/lib/facebook_ads/ad_objects/ad_study_objective_offsite_datasets.rb +37 -0
- data/lib/facebook_ads/ad_objects/ad_video.rb +34 -4
- data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb +1 -0
- data/lib/facebook_ads/ad_objects/adoptable_pet.rb +1 -0
- data/lib/facebook_ads/ad_objects/ads_action_stats.rb +2 -0
- data/lib/facebook_ads/ad_objects/ads_insights.rb +6 -6
- data/lib/facebook_ads/ad_objects/ads_pixel.rb +7 -0
- data/lib/facebook_ads/ad_objects/album.rb +0 -1
- data/lib/facebook_ads/ad_objects/application.rb +38 -50
- data/lib/facebook_ads/ad_objects/{adgroup_relevance_score.rb → ar_effects_batch_status.rb} +3 -4
- data/lib/facebook_ads/ad_objects/audio_copyright.rb +0 -4
- data/lib/facebook_ads/ad_objects/automotive_model.rb +2 -0
- data/lib/facebook_ads/ad_objects/broad_targeting_categories.rb +2 -1
- data/lib/facebook_ads/ad_objects/business.rb +87 -52
- data/lib/facebook_ads/ad_objects/business_asset_group.rb +6 -0
- data/lib/facebook_ads/ad_objects/business_image.rb +44 -0
- data/lib/facebook_ads/ad_objects/{billed_amount_details.rb → business_managed_partner_eligibility.rb} +4 -5
- data/lib/facebook_ads/ad_objects/campaign.rb +4 -0
- data/lib/facebook_ads/ad_objects/canvas.rb +17 -6
- data/lib/facebook_ads/ad_objects/chat_plugin.rb +48 -0
- data/lib/facebook_ads/ad_objects/{audience_insights_study_spec.rb → cloud_game.rb} +10 -11
- data/lib/facebook_ads/ad_objects/comment.rb +2 -0
- data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +6 -1
- data/lib/facebook_ads/ad_objects/commerce_order.rb +8 -0
- data/lib/facebook_ads/ad_objects/content_delivery_report.rb +10 -0
- data/lib/facebook_ads/ad_objects/{business_agreement.rb → copyright_audio_asset.rb} +5 -10
- data/lib/facebook_ads/ad_objects/cpas_business_setup_config.rb +43 -0
- data/lib/facebook_ads/ad_objects/cpas_merchant_config.rb +41 -0
- data/lib/facebook_ads/ad_objects/custom_audience.rb +9 -1
- data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb +1 -0
- data/lib/facebook_ads/ad_objects/destination.rb +1 -0
- data/lib/facebook_ads/ad_objects/event.rb +12 -7
- data/lib/facebook_ads/ad_objects/flight.rb +1 -0
- data/lib/facebook_ads/ad_objects/fundraiser_person_to_charity.rb +74 -0
- data/lib/facebook_ads/ad_objects/group.rb +24 -4
- data/lib/facebook_ads/ad_objects/home_listing.rb +1 -3
- data/lib/facebook_ads/ad_objects/hotel.rb +1 -0
- data/lib/facebook_ads/ad_objects/ig_comment.rb +2 -0
- data/lib/facebook_ads/ad_objects/ig_media.rb +0 -1
- data/lib/facebook_ads/ad_objects/ig_user.rb +9 -0
- data/lib/facebook_ads/ad_objects/insights_result.rb +1 -0
- data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +4 -0
- data/lib/facebook_ads/ad_objects/instagram_user.rb +1 -0
- data/lib/facebook_ads/ad_objects/{ad_account_content_filter_levels_inheritance.rb → instant_articles_stats.rb} +6 -5
- data/lib/facebook_ads/ad_objects/{ad_report_spec.rb → jobs_job.rb} +39 -18
- data/lib/facebook_ads/ad_objects/life_event.rb +0 -9
- data/lib/facebook_ads/ad_objects/live_video.rb +22 -19
- data/lib/facebook_ads/ad_objects/live_video_input_stream.rb +0 -1
- data/lib/facebook_ads/ad_objects/live_video_recommended_encoder_settings.rb +39 -0
- data/lib/facebook_ads/ad_objects/local_service_business.rb +98 -0
- data/lib/facebook_ads/ad_objects/{invoice_campaign.rb → managed_partner_business.rb} +8 -9
- data/lib/facebook_ads/ad_objects/media_fingerprint.rb +1 -0
- data/lib/facebook_ads/ad_objects/{product_feed_upload_diagnostics_report.rb → messaging_feature_status.rb} +2 -3
- data/lib/facebook_ads/ad_objects/messenger_destination_page_welcome_message.rb +1 -0
- data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb +6 -5
- data/lib/facebook_ads/ad_objects/offline_conversion_data_set_permissions.rb +40 -0
- data/lib/facebook_ads/ad_objects/{oracle_transaction.rb → offline_conversion_data_set_upload.rb} +36 -21
- data/lib/facebook_ads/ad_objects/offline_conversion_data_set_usage.rb +37 -0
- data/lib/facebook_ads/ad_objects/omega_customer_trx.rb +3 -3
- data/lib/facebook_ads/ad_objects/page.rb +84 -100
- data/lib/facebook_ads/ad_objects/page_post.rb +2 -2
- data/lib/facebook_ads/ad_objects/page_user_message_thread_label.rb +1 -1
- data/lib/facebook_ads/ad_objects/payment_engine_payment.rb +1 -0
- data/lib/facebook_ads/ad_objects/post.rb +2 -2
- data/lib/facebook_ads/ad_objects/private_lift_study_instance.rb +2 -0
- data/lib/facebook_ads/ad_objects/product_catalog.rb +52 -11
- data/lib/facebook_ads/ad_objects/product_feed.rb +17 -17
- data/lib/facebook_ads/ad_objects/product_feed_rule.rb +0 -8
- data/lib/facebook_ads/ad_objects/product_group.rb +6 -1
- data/lib/facebook_ads/ad_objects/{domain.rb → product_image.rb} +2 -3
- data/lib/facebook_ads/ad_objects/product_item.rb +272 -0
- data/lib/facebook_ads/ad_objects/product_item_importer_address.rb +42 -0
- data/lib/facebook_ads/ad_objects/product_set.rb +2 -7
- data/lib/facebook_ads/ad_objects/profile.rb +2 -0
- data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +2 -1
- data/lib/facebook_ads/ad_objects/saved_audience.rb +3 -2
- data/lib/facebook_ads/ad_objects/shop.rb +37 -0
- data/lib/facebook_ads/ad_objects/text_with_entities.rb +37 -0
- data/lib/facebook_ads/ad_objects/user.rb +19 -54
- data/lib/facebook_ads/ad_objects/vehicle.rb +11 -0
- data/lib/facebook_ads/ad_objects/vehicle_offer.rb +1 -0
- data/lib/facebook_ads/ad_objects/video_copyright.rb +0 -4
- data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +30 -0
- data/lib/facebook_ads/ad_objects/woodhenge_purchased_payg_receipt.rb +38 -0
- data/lib/facebook_ads/version.rb +2 -2
- metadata +26 -17
- data/lib/facebook_ads/ad_objects/atlas_campaign.rb +0 -153
- data/lib/facebook_ads/ad_objects/business_unit.rb +0 -132
- data/lib/facebook_ads/ad_objects/live_encoder.rb +0 -100
- data/lib/facebook_ads/ad_objects/measurement_upload_event.rb +0 -220
- data/lib/facebook_ads/ad_objects/referral.rb +0 -45
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2d1235a032c2cc0a192c80e31c798acafbd61375459abe53d0bf7845c14ea2be
|
4
|
+
data.tar.gz: beef64f3c6b445dcc3487951561bf051c2932c3b902634aec95ed9f091a005da
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2fac47bc2e3b4ba64305719940f01029b6e7a99345fff1f6554c7ed28fcf9cf448d2a5fae94efe31dd590355f5135869b6c2540045a2b440de737ec14cbb21b0
|
7
|
+
data.tar.gz: 48ba92279762768a30a9e70740dfad7aef81c6ab71ac720dbcd4dce72d3b611720488a4abba78772684ad91e897d35b167b0a41bb8f66d7afed34aebcfeddc18
|
@@ -70,7 +70,6 @@ module FacebookAds
|
|
70
70
|
"PYG",
|
71
71
|
"QAR",
|
72
72
|
"RON",
|
73
|
-
"RUB",
|
74
73
|
"SAR",
|
75
74
|
"SEK",
|
76
75
|
"SGD",
|
@@ -85,6 +84,7 @@ module FacebookAds
|
|
85
84
|
]
|
86
85
|
|
87
86
|
TASKS = [
|
87
|
+
"AA_ANALYZE",
|
88
88
|
"ADVERTISE",
|
89
89
|
"ANALYZE",
|
90
90
|
"DRAFT",
|
@@ -108,6 +108,7 @@ module FacebookAds
|
|
108
108
|
"FLIGHT",
|
109
109
|
"HOME_LISTING",
|
110
110
|
"HOTEL",
|
111
|
+
"JOB",
|
111
112
|
"LOCAL_SERVICE_BUSINESS",
|
112
113
|
"LOCATION_BASED_ITEM",
|
113
114
|
"MEDIA_TITLE",
|
@@ -159,11 +160,13 @@ module FacebookAds
|
|
159
160
|
field :disable_reason, 'int'
|
160
161
|
field :end_advertiser, 'string'
|
161
162
|
field :end_advertiser_name, 'string'
|
163
|
+
field :existing_customers, { list: 'string' }
|
162
164
|
field :extended_credit_invoice_group, 'ExtendedCreditInvoiceGroup'
|
163
165
|
field :failed_delivery_checks, { list: 'DeliveryCheck' }
|
164
166
|
field :fb_entity, 'int'
|
165
167
|
field :funding_source, 'string'
|
166
168
|
field :funding_source_details, 'FundingSourceDetails'
|
169
|
+
field :has_advertiser_opted_in_odax, 'bool'
|
167
170
|
field :has_migrated_permissions, 'bool'
|
168
171
|
field :has_page_authorized_adaccount, 'bool'
|
169
172
|
field :id, 'string'
|
@@ -171,7 +174,6 @@ module FacebookAds
|
|
171
174
|
field :is_attribution_spec_system_default, 'bool'
|
172
175
|
field :is_direct_deals_enabled, 'bool'
|
173
176
|
field :is_in_3ds_authorization_enabled_market, 'bool'
|
174
|
-
field :is_in_middle_of_local_entity_migration, 'bool'
|
175
177
|
field :is_notifications_enabled, 'bool'
|
176
178
|
field :is_personal, 'int'
|
177
179
|
field :is_prepay_account, 'bool'
|
@@ -217,7 +219,6 @@ module FacebookAds
|
|
217
219
|
has_edge :ad_place_page_sets do |edge|
|
218
220
|
edge.get 'AdPlacePageSet'
|
219
221
|
edge.post 'AdPlacePageSet' do |api|
|
220
|
-
api.has_param :category, { enum: -> { AdPlacePageSet::CATEGORY }}
|
221
222
|
api.has_param :location_types, { list: { enum: -> { AdPlacePageSet::LOCATION_TYPES }} }
|
222
223
|
api.has_param :name, 'string'
|
223
224
|
api.has_param :parent_page, 'string'
|
@@ -227,7 +228,6 @@ module FacebookAds
|
|
227
228
|
|
228
229
|
has_edge :ad_place_page_sets_async do |edge|
|
229
230
|
edge.post 'AdPlacePageSet' do |api|
|
230
|
-
api.has_param :category, { enum: -> { AdPlacePageSet::CATEGORY }}
|
231
231
|
api.has_param :location_types, { list: { enum: -> { AdPlacePageSet::LOCATION_TYPES }} }
|
232
232
|
api.has_param :name, 'string'
|
233
233
|
api.has_param :parent_page, 'string'
|
@@ -235,18 +235,12 @@ module FacebookAds
|
|
235
235
|
end
|
236
236
|
end
|
237
237
|
|
238
|
-
has_edge :ad_saved_keywords do |edge|
|
239
|
-
edge.get do |api|
|
240
|
-
api.has_param :fields, { list: 'string' }
|
241
|
-
end
|
242
|
-
end
|
243
|
-
|
244
238
|
has_edge :ad_studies do |edge|
|
245
239
|
edge.get 'AdStudy'
|
246
240
|
end
|
247
241
|
|
248
242
|
has_edge :adcloudplayables do |edge|
|
249
|
-
edge.get
|
243
|
+
edge.get 'CloudGame'
|
250
244
|
end
|
251
245
|
|
252
246
|
has_edge :adcreatives do |edge|
|
@@ -285,6 +279,7 @@ module FacebookAds
|
|
285
279
|
api.has_param :object_story_spec, 'AdCreativeObjectStorySpec'
|
286
280
|
api.has_param :object_type, 'string'
|
287
281
|
api.has_param :object_url, 'string'
|
282
|
+
api.has_param :omnichannel_link_spec, 'hash'
|
288
283
|
api.has_param :place_page_set_id, 'string'
|
289
284
|
api.has_param :platform_customizations, 'object'
|
290
285
|
api.has_param :playable_asset_id, 'string'
|
@@ -364,6 +359,7 @@ module FacebookAds
|
|
364
359
|
api.has_param :name, 'string'
|
365
360
|
api.has_param :schedule_spec, 'object'
|
366
361
|
api.has_param :status, { enum: -> { AdRule::STATUS }}
|
362
|
+
api.has_param :ui_creation_source, { enum: -> { AdRule::UI_CREATION_SOURCE }}
|
367
363
|
end
|
368
364
|
end
|
369
365
|
|
@@ -419,15 +415,15 @@ module FacebookAds
|
|
419
415
|
api.has_param :is_completed, 'bool'
|
420
416
|
api.has_param :time_range, 'object'
|
421
417
|
end
|
422
|
-
edge.post
|
418
|
+
edge.post do |api|
|
423
419
|
api.has_param :adlabels, { list: 'object' }
|
424
420
|
api.has_param :adset_schedule, { list: 'object' }
|
425
421
|
api.has_param :attribution_spec, { list: 'hash' }
|
426
422
|
api.has_param :bid_adjustments, 'object'
|
427
423
|
api.has_param :bid_amount, 'int'
|
428
424
|
api.has_param :bid_constraints, 'hash'
|
429
|
-
api.has_param :bid_strategy, { enum:
|
430
|
-
api.has_param :billing_event, { enum:
|
425
|
+
api.has_param :bid_strategy, { enum: %w{COST_CAP LOWEST_COST_WITHOUT_CAP LOWEST_COST_WITH_BID_CAP }}
|
426
|
+
api.has_param :billing_event, { enum: %w{APP_INSTALLS CLICKS IMPRESSIONS LINK_CLICKS LISTING_INTERACTION NONE OFFER_CLAIMS PAGE_LIKES POST_ENGAGEMENT PURCHASE THRUPLAY }}
|
431
427
|
api.has_param :campaign_id, 'string'
|
432
428
|
api.has_param :campaign_spec, 'object'
|
433
429
|
api.has_param :creative_sequence, { list: 'string' }
|
@@ -436,35 +432,36 @@ module FacebookAds
|
|
436
432
|
api.has_param :daily_min_spend_target, 'int'
|
437
433
|
api.has_param :daily_spend_cap, 'int'
|
438
434
|
api.has_param :date_format, 'string'
|
439
|
-
api.has_param :destination_type, { enum:
|
435
|
+
api.has_param :destination_type, { enum: %w{APP APPLINKS_AUTOMATIC FACEBOOK MESSENGER UNDEFINED WEBSITE }}
|
440
436
|
api.has_param :end_time, 'datetime'
|
441
|
-
api.has_param :execution_options, { list: { enum:
|
437
|
+
api.has_param :execution_options, { list: { enum: %w{include_recommendations validate_only }} }
|
438
|
+
api.has_param :existing_customer_budget_percentage, 'int'
|
442
439
|
api.has_param :frequency_control_specs, { list: 'object' }
|
443
|
-
api.has_param :full_funnel_exploration_mode, { enum:
|
440
|
+
api.has_param :full_funnel_exploration_mode, { enum: %w{EXTENDED_EXPLORATION LIMITED_EXPLORATION NONE_EXPLORATION }}
|
444
441
|
api.has_param :is_dynamic_creative, 'bool'
|
445
442
|
api.has_param :lifetime_budget, 'int'
|
446
443
|
api.has_param :lifetime_imps, 'int'
|
447
444
|
api.has_param :lifetime_min_spend_target, 'int'
|
448
445
|
api.has_param :lifetime_spend_cap, 'int'
|
449
446
|
api.has_param :line_number, 'int'
|
450
|
-
api.has_param :multi_optimization_goal_weight, { enum:
|
447
|
+
api.has_param :multi_optimization_goal_weight, { enum: %w{BALANCED PREFER_EVENT PREFER_INSTALL UNDEFINED }}
|
451
448
|
api.has_param :name, 'string'
|
452
|
-
api.has_param :optimization_goal, { enum:
|
453
|
-
api.has_param :optimization_sub_event, { enum:
|
449
|
+
api.has_param :optimization_goal, { enum: %w{AD_RECALL_LIFT APP_INSTALLS APP_INSTALLS_AND_OFFSITE_CONVERSIONS CONVERSATIONS DERIVED_EVENTS ENGAGED_USERS EVENT_RESPONSES IMPRESSIONS IN_APP_VALUE LANDING_PAGE_VIEWS LEAD_GENERATION LINK_CLICKS NONE OFFSITE_CONVERSIONS PAGE_LIKES POST_ENGAGEMENT QUALITY_CALL QUALITY_LEAD REACH THRUPLAY VALUE VISIT_INSTAGRAM_PROFILE }}
|
450
|
+
api.has_param :optimization_sub_event, { enum: %w{NONE TRAVEL_INTENT TRAVEL_INTENT_BUCKET_01 TRAVEL_INTENT_BUCKET_02 TRAVEL_INTENT_BUCKET_03 TRAVEL_INTENT_BUCKET_04 TRAVEL_INTENT_BUCKET_05 TRAVEL_INTENT_NO_DESTINATION_INTENT TRIP_CONSIDERATION VIDEO_SOUND_ON }}
|
454
451
|
api.has_param :pacing_type, { list: 'string' }
|
455
452
|
api.has_param :promoted_object, 'object'
|
456
453
|
api.has_param :rb_prediction_id, 'string'
|
457
454
|
api.has_param :rf_prediction_id, 'string'
|
458
455
|
api.has_param :source_adset_id, 'string'
|
459
456
|
api.has_param :start_time, 'datetime'
|
460
|
-
api.has_param :status, { enum:
|
457
|
+
api.has_param :status, { enum: %w{ACTIVE ARCHIVED DELETED PAUSED }}
|
461
458
|
api.has_param :targeting, 'Targeting'
|
462
459
|
api.has_param :time_based_ad_rotation_id_blocks, { list: { list: 'int' } }
|
463
460
|
api.has_param :time_based_ad_rotation_intervals, { list: 'int' }
|
464
461
|
api.has_param :time_start, 'datetime'
|
465
462
|
api.has_param :time_stop, 'datetime'
|
466
463
|
api.has_param :topline_id, 'string'
|
467
|
-
api.has_param :tune_for_category, { enum:
|
464
|
+
api.has_param :tune_for_category, { enum: %w{CREDIT EMPLOYMENT HOUSING ISSUES_ELECTIONS_POLITICS NONE ONLINE_GAMBLING_AND_GAMING }}
|
468
465
|
api.has_param :upstream_events, 'hash'
|
469
466
|
end
|
470
467
|
end
|
@@ -480,7 +477,7 @@ module FacebookAds
|
|
480
477
|
edge.get 'AdsPixel' do |api|
|
481
478
|
api.has_param :sort_by, { enum: -> { AdsPixel::SORT_BY }}
|
482
479
|
end
|
483
|
-
edge.post
|
480
|
+
edge.post do |api|
|
484
481
|
api.has_param :name, 'string'
|
485
482
|
end
|
486
483
|
end
|
@@ -560,7 +557,6 @@ module FacebookAds
|
|
560
557
|
api.has_param :react_mode_metadata, 'string'
|
561
558
|
api.has_param :referenced_sticker_id, 'string'
|
562
559
|
api.has_param :replace_video_id, 'string'
|
563
|
-
api.has_param :sales_promo_id, 'int'
|
564
560
|
api.has_param :slideshow_spec, 'hash'
|
565
561
|
api.has_param :source, 'file'
|
566
562
|
api.has_param :source_instagram_media_id, 'string'
|
@@ -881,6 +877,22 @@ module FacebookAds
|
|
881
877
|
end
|
882
878
|
end
|
883
879
|
|
880
|
+
has_edge :managed_partner_ads do |edge|
|
881
|
+
edge.post do |api|
|
882
|
+
api.has_param :campaign_group_id, 'int'
|
883
|
+
api.has_param :campaign_group_status, { enum: %w{ACTIVE ADSET_PAUSED ARCHIVED CAMPAIGN_PAUSED DELETED DISAPPROVED IN_PROCESS PAUSED PENDING_BILLING_INFO PENDING_REVIEW PREAPPROVED WITH_ISSUES }}
|
884
|
+
api.has_param :conversion_domain, 'string'
|
885
|
+
api.has_param :end_time, 'int'
|
886
|
+
api.has_param :lifetime_budget, 'int'
|
887
|
+
api.has_param :override_creative_text, 'string'
|
888
|
+
api.has_param :override_targeting_countries, { list: 'string' }
|
889
|
+
api.has_param :product_set_id, 'string'
|
890
|
+
api.has_param :start_time, 'int'
|
891
|
+
api.has_param :use_marketplace_template, 'bool'
|
892
|
+
api.has_param :use_seller_template, 'bool'
|
893
|
+
end
|
894
|
+
end
|
895
|
+
|
884
896
|
has_edge :matched_search_applications do |edge|
|
885
897
|
edge.get 'AdAccountMatchedSearchApplicationsEdgeData' do |api|
|
886
898
|
api.has_param :allow_incomplete_app, 'bool'
|
@@ -32,9 +32,15 @@ module FacebookAds
|
|
32
32
|
"AGGREGATED_BUDGET_LIMITED",
|
33
33
|
"AGGREGATED_COST_LIMITED",
|
34
34
|
"AUCTION_OVERLAP",
|
35
|
+
"AUDIENCE_EXPANSION",
|
36
|
+
"AUTOFLOW_OPT_IN",
|
35
37
|
"CREATIVE_FATIGUE",
|
38
|
+
"CREATIVE_LIMITED",
|
39
|
+
"DEAD_LINK",
|
40
|
+
"ECOSYSTEM_BID_REDUCE_L1_CARDINALITY",
|
36
41
|
"FRAGMENTATION",
|
37
42
|
"LEARNING_LIMITED",
|
43
|
+
"SYD_TEST_MODE",
|
38
44
|
"TOP_ADSETS_WITH_ADS_UNDER_CAP",
|
39
45
|
"TOP_CAMPAIGNS_WITH_ADS_UNDER_CAP",
|
40
46
|
"UNECONOMICAL_ADS_THROTTLING",
|
@@ -28,30 +28,25 @@ module FacebookAds
|
|
28
28
|
class AdAccountDeliveryEstimate < AdObject
|
29
29
|
OPTIMIZATION_GOAL = [
|
30
30
|
"AD_RECALL_LIFT",
|
31
|
-
"APP_DOWNLOADS",
|
32
31
|
"APP_INSTALLS",
|
33
|
-
"
|
34
|
-
"
|
32
|
+
"APP_INSTALLS_AND_OFFSITE_CONVERSIONS",
|
33
|
+
"CONVERSATIONS",
|
35
34
|
"DERIVED_EVENTS",
|
36
35
|
"ENGAGED_USERS",
|
37
36
|
"EVENT_RESPONSES",
|
38
37
|
"IMPRESSIONS",
|
38
|
+
"IN_APP_VALUE",
|
39
39
|
"LANDING_PAGE_VIEWS",
|
40
40
|
"LEAD_GENERATION",
|
41
41
|
"LINK_CLICKS",
|
42
42
|
"NONE",
|
43
|
-
"OFFER_CLAIMS",
|
44
43
|
"OFFSITE_CONVERSIONS",
|
45
|
-
"PAGE_ENGAGEMENT",
|
46
44
|
"PAGE_LIKES",
|
47
45
|
"POST_ENGAGEMENT",
|
48
46
|
"QUALITY_CALL",
|
49
47
|
"QUALITY_LEAD",
|
50
48
|
"REACH",
|
51
|
-
"REPLIES",
|
52
|
-
"SOCIAL_IMPRESSIONS",
|
53
49
|
"THRUPLAY",
|
54
|
-
"TWO_SECOND_CONTINUOUS_VIDEO_VIEWS",
|
55
50
|
"VALUE",
|
56
51
|
"VISIT_INSTAGRAM_PROFILE",
|
57
52
|
]
|
@@ -59,8 +54,10 @@ module FacebookAds
|
|
59
54
|
|
60
55
|
field :daily_outcomes_curve, { list: 'OutcomePredictionPoint' }
|
61
56
|
field :estimate_dau, 'int'
|
62
|
-
field :
|
57
|
+
field :estimate_mau_lower_bound, 'int'
|
58
|
+
field :estimate_mau_upper_bound, 'int'
|
63
59
|
field :estimate_ready, 'bool'
|
60
|
+
field :targeting_optimization_types, 'hash'
|
64
61
|
has_no_id
|
65
62
|
has_no_get
|
66
63
|
has_no_post
|
@@ -28,6 +28,11 @@ module FacebookAds
|
|
28
28
|
class AdAccountMatchedSearchApplicationsEdgeData < AdObject
|
29
29
|
APP_STORE = [
|
30
30
|
"AMAZON_APP_STORE",
|
31
|
+
"APK_MIRROR",
|
32
|
+
"APK_MONK",
|
33
|
+
"APK_PURE",
|
34
|
+
"APTOIDE_A1_STORE",
|
35
|
+
"BEMOBI_MOBILE_STORE",
|
31
36
|
"DOES_NOT_EXIST",
|
32
37
|
"FB_ANDROID_STORE",
|
33
38
|
"FB_CANVAS",
|
@@ -38,9 +43,13 @@ module FacebookAds
|
|
38
43
|
"ITUNES",
|
39
44
|
"ITUNES_IPAD",
|
40
45
|
"OCULUS_APP_STORE",
|
46
|
+
"OPPO",
|
41
47
|
"ROKU_STORE",
|
48
|
+
"UPTODOWN",
|
49
|
+
"VIVO",
|
42
50
|
"WINDOWS_10_STORE",
|
43
51
|
"WINDOWS_STORE",
|
52
|
+
"XIAOMI",
|
44
53
|
]
|
45
54
|
|
46
55
|
|
@@ -61,6 +61,7 @@ module FacebookAds
|
|
61
61
|
"HOUSING",
|
62
62
|
"ISSUES_ELECTIONS_POLITICS",
|
63
63
|
"NONE",
|
64
|
+
"ONLINE_GAMBLING_AND_GAMING",
|
64
65
|
]
|
65
66
|
|
66
67
|
WHITELISTED_TYPES = [
|
@@ -189,6 +190,11 @@ module FacebookAds
|
|
189
190
|
|
190
191
|
APP_STORE = [
|
191
192
|
"amazon_app_store",
|
193
|
+
"apk_mirror",
|
194
|
+
"apk_monk",
|
195
|
+
"apk_pure",
|
196
|
+
"aptoide_a1_store",
|
197
|
+
"bemobi_mobile_store",
|
192
198
|
"does_not_exist",
|
193
199
|
"fb_android_store",
|
194
200
|
"fb_canvas",
|
@@ -199,9 +205,13 @@ module FacebookAds
|
|
199
205
|
"itunes",
|
200
206
|
"itunes_ipad",
|
201
207
|
"oculus_app_store",
|
208
|
+
"oppo",
|
202
209
|
"roku_channel_store",
|
210
|
+
"uptodown",
|
211
|
+
"vivo",
|
203
212
|
"windows_10_store",
|
204
213
|
"windows_store",
|
214
|
+
"xiaomi",
|
205
215
|
]
|
206
216
|
|
207
217
|
OBJECTIVE = [
|
@@ -230,7 +240,8 @@ module FacebookAds
|
|
230
240
|
]
|
231
241
|
|
232
242
|
|
233
|
-
field :
|
243
|
+
field :audience_size_lower_bound, 'int'
|
244
|
+
field :audience_size_upper_bound, 'int'
|
234
245
|
field :conversion_lift, 'double'
|
235
246
|
field :description, 'string'
|
236
247
|
field :id, 'string'
|
@@ -35,6 +35,7 @@ module FacebookAds
|
|
35
35
|
"BUY_TICKETS",
|
36
36
|
"CALL",
|
37
37
|
"CALL_ME",
|
38
|
+
"CALL_NOW",
|
38
39
|
"CONTACT",
|
39
40
|
"CONTACT_US",
|
40
41
|
"DONATE",
|
@@ -65,6 +66,7 @@ module FacebookAds
|
|
65
66
|
"ORDER_NOW",
|
66
67
|
"PAY_TO_ACCESS",
|
67
68
|
"PLAY_GAME",
|
69
|
+
"PLAY_GAME_ON_FACEBOOK",
|
68
70
|
"PURCHASE_GIFT_CARDS",
|
69
71
|
"RECORD_NOW",
|
70
72
|
"REFER_FRIENDS",
|
@@ -105,10 +107,10 @@ module FacebookAds
|
|
105
107
|
field :captions, { list: 'AdAssetFeedSpecCaption' }
|
106
108
|
field :carousels, { list: 'object' }
|
107
109
|
field :descriptions, { list: 'AdAssetFeedSpecDescription' }
|
110
|
+
field :events, { list: 'object' }
|
108
111
|
field :groups, { list: 'AdAssetFeedSpecGroupRule' }
|
109
112
|
field :images, { list: 'AdAssetFeedSpecImage' }
|
110
113
|
field :link_urls, { list: 'AdAssetFeedSpecLinkUrl' }
|
111
|
-
field :onsite_destinations, { list: 'object' }
|
112
114
|
field :optimization_type, 'string'
|
113
115
|
field :posts, { list: 'object' }
|
114
116
|
field :titles, { list: 'AdAssetFeedSpecTitle' }
|
@@ -31,12 +31,6 @@ module FacebookAds
|
|
31
31
|
"ON_COMPLETE",
|
32
32
|
]
|
33
33
|
|
34
|
-
NOTIFICATION_STATUS = [
|
35
|
-
"NOT_SENT",
|
36
|
-
"SENDING",
|
37
|
-
"SENT",
|
38
|
-
]
|
39
|
-
|
40
34
|
|
41
35
|
field :canceled_count, 'int'
|
42
36
|
field :created_time, 'datetime'
|
@@ -48,7 +42,7 @@ module FacebookAds
|
|
48
42
|
field :name, 'string'
|
49
43
|
field :notification_mode, { enum: -> { NOTIFICATION_MODE }}
|
50
44
|
field :notification_result, 'AdAsyncRequestSetNotificationResult'
|
51
|
-
field :notification_status,
|
45
|
+
field :notification_status, 'string'
|
52
46
|
field :notification_uri, 'string'
|
53
47
|
field :owner_id, 'string'
|
54
48
|
field :success_count, 'int'
|
@@ -68,60 +68,50 @@ module FacebookAds
|
|
68
68
|
|
69
69
|
OPTIMIZATION_GOAL_NEW = [
|
70
70
|
"AD_RECALL_LIFT",
|
71
|
-
"APP_DOWNLOADS",
|
72
71
|
"APP_INSTALLS",
|
73
|
-
"
|
74
|
-
"
|
72
|
+
"APP_INSTALLS_AND_OFFSITE_CONVERSIONS",
|
73
|
+
"CONVERSATIONS",
|
75
74
|
"DERIVED_EVENTS",
|
76
75
|
"ENGAGED_USERS",
|
77
76
|
"EVENT_RESPONSES",
|
78
77
|
"IMPRESSIONS",
|
78
|
+
"IN_APP_VALUE",
|
79
79
|
"LANDING_PAGE_VIEWS",
|
80
80
|
"LEAD_GENERATION",
|
81
81
|
"LINK_CLICKS",
|
82
82
|
"NONE",
|
83
|
-
"OFFER_CLAIMS",
|
84
83
|
"OFFSITE_CONVERSIONS",
|
85
|
-
"PAGE_ENGAGEMENT",
|
86
84
|
"PAGE_LIKES",
|
87
85
|
"POST_ENGAGEMENT",
|
88
86
|
"QUALITY_CALL",
|
89
87
|
"QUALITY_LEAD",
|
90
88
|
"REACH",
|
91
|
-
"REPLIES",
|
92
|
-
"SOCIAL_IMPRESSIONS",
|
93
89
|
"THRUPLAY",
|
94
|
-
"TWO_SECOND_CONTINUOUS_VIDEO_VIEWS",
|
95
90
|
"VALUE",
|
96
91
|
"VISIT_INSTAGRAM_PROFILE",
|
97
92
|
]
|
98
93
|
|
99
94
|
OPTIMIZATION_GOAL_OLD = [
|
100
95
|
"AD_RECALL_LIFT",
|
101
|
-
"APP_DOWNLOADS",
|
102
96
|
"APP_INSTALLS",
|
103
|
-
"
|
104
|
-
"
|
97
|
+
"APP_INSTALLS_AND_OFFSITE_CONVERSIONS",
|
98
|
+
"CONVERSATIONS",
|
105
99
|
"DERIVED_EVENTS",
|
106
100
|
"ENGAGED_USERS",
|
107
101
|
"EVENT_RESPONSES",
|
108
102
|
"IMPRESSIONS",
|
103
|
+
"IN_APP_VALUE",
|
109
104
|
"LANDING_PAGE_VIEWS",
|
110
105
|
"LEAD_GENERATION",
|
111
106
|
"LINK_CLICKS",
|
112
107
|
"NONE",
|
113
|
-
"OFFER_CLAIMS",
|
114
108
|
"OFFSITE_CONVERSIONS",
|
115
|
-
"PAGE_ENGAGEMENT",
|
116
109
|
"PAGE_LIKES",
|
117
110
|
"POST_ENGAGEMENT",
|
118
111
|
"QUALITY_CALL",
|
119
112
|
"QUALITY_LEAD",
|
120
113
|
"REACH",
|
121
|
-
"REPLIES",
|
122
|
-
"SOCIAL_IMPRESSIONS",
|
123
114
|
"THRUPLAY",
|
124
|
-
"TWO_SECOND_CONTINUOUS_VIDEO_VIEWS",
|
125
115
|
"VALUE",
|
126
116
|
"VISIT_INSTAGRAM_PROFILE",
|
127
117
|
]
|
@@ -28,30 +28,25 @@ module FacebookAds
|
|
28
28
|
class AdCampaignDeliveryEstimate < AdObject
|
29
29
|
OPTIMIZATION_GOAL = [
|
30
30
|
"AD_RECALL_LIFT",
|
31
|
-
"APP_DOWNLOADS",
|
32
31
|
"APP_INSTALLS",
|
33
|
-
"
|
34
|
-
"
|
32
|
+
"APP_INSTALLS_AND_OFFSITE_CONVERSIONS",
|
33
|
+
"CONVERSATIONS",
|
35
34
|
"DERIVED_EVENTS",
|
36
35
|
"ENGAGED_USERS",
|
37
36
|
"EVENT_RESPONSES",
|
38
37
|
"IMPRESSIONS",
|
38
|
+
"IN_APP_VALUE",
|
39
39
|
"LANDING_PAGE_VIEWS",
|
40
40
|
"LEAD_GENERATION",
|
41
41
|
"LINK_CLICKS",
|
42
42
|
"NONE",
|
43
|
-
"OFFER_CLAIMS",
|
44
43
|
"OFFSITE_CONVERSIONS",
|
45
|
-
"PAGE_ENGAGEMENT",
|
46
44
|
"PAGE_LIKES",
|
47
45
|
"POST_ENGAGEMENT",
|
48
46
|
"QUALITY_CALL",
|
49
47
|
"QUALITY_LEAD",
|
50
48
|
"REACH",
|
51
|
-
"REPLIES",
|
52
|
-
"SOCIAL_IMPRESSIONS",
|
53
49
|
"THRUPLAY",
|
54
|
-
"TWO_SECOND_CONTINUOUS_VIDEO_VIEWS",
|
55
50
|
"VALUE",
|
56
51
|
"VISIT_INSTAGRAM_PROFILE",
|
57
52
|
]
|
@@ -59,8 +54,10 @@ module FacebookAds
|
|
59
54
|
|
60
55
|
field :daily_outcomes_curve, { list: 'OutcomePredictionPoint' }
|
61
56
|
field :estimate_dau, 'int'
|
62
|
-
field :
|
57
|
+
field :estimate_mau_lower_bound, 'int'
|
58
|
+
field :estimate_mau_upper_bound, 'int'
|
63
59
|
field :estimate_ready, 'bool'
|
60
|
+
field :targeting_optimization_types, 'hash'
|
64
61
|
has_no_id
|
65
62
|
has_no_get
|
66
63
|
has_no_post
|
@@ -35,6 +35,7 @@ module FacebookAds
|
|
35
35
|
"BUY_TICKETS",
|
36
36
|
"CALL",
|
37
37
|
"CALL_ME",
|
38
|
+
"CALL_NOW",
|
38
39
|
"CONTACT",
|
39
40
|
"CONTACT_US",
|
40
41
|
"DONATE",
|
@@ -65,6 +66,7 @@ module FacebookAds
|
|
65
66
|
"ORDER_NOW",
|
66
67
|
"PAY_TO_ACCESS",
|
67
68
|
"PLAY_GAME",
|
69
|
+
"PLAY_GAME_ON_FACEBOOK",
|
68
70
|
"PURCHASE_GIFT_CARDS",
|
69
71
|
"RECORD_NOW",
|
70
72
|
"REFER_FRIENDS",
|
@@ -118,6 +120,7 @@ module FacebookAds
|
|
118
120
|
]
|
119
121
|
|
120
122
|
APPLINK_TREATMENT = [
|
123
|
+
"automatic",
|
121
124
|
"deeplink_with_appstore_fallback",
|
122
125
|
"deeplink_with_web_fallback",
|
123
126
|
"web_only",
|
@@ -170,6 +173,7 @@ module FacebookAds
|
|
170
173
|
field :call_to_action_type, { enum: -> { CALL_TO_ACTION_TYPE }}
|
171
174
|
field :categorization_criteria, 'string'
|
172
175
|
field :category_media_source, 'string'
|
176
|
+
field :collaborative_ads_lsb_image_bank_id, 'string'
|
173
177
|
field :destination_set_id, 'string'
|
174
178
|
field :dynamic_ad_voice, 'string'
|
175
179
|
field :effective_authorization_category, 'string'
|
@@ -199,6 +203,7 @@ module FacebookAds
|
|
199
203
|
field :object_story_spec, 'AdCreativeObjectStorySpec'
|
200
204
|
field :object_type, { enum: -> { OBJECT_TYPE }}
|
201
205
|
field :object_url, 'string'
|
206
|
+
field :omnichannel_link_spec, 'AdCreativeOmnichannelLinkSpec'
|
202
207
|
field :place_page_set_id, 'string'
|
203
208
|
field :platform_customizations, 'AdCreativePlatformCustomization'
|
204
209
|
field :playable_asset_id, 'string'
|
@@ -209,6 +214,7 @@ module FacebookAds
|
|
209
214
|
field :status, { enum: -> { STATUS }}
|
210
215
|
field :template_url, 'string'
|
211
216
|
field :template_url_spec, 'AdCreativeTemplateUrlSpec'
|
217
|
+
field :thumbnail_id, 'string'
|
212
218
|
field :thumbnail_url, 'string'
|
213
219
|
field :title, 'string'
|
214
220
|
field :url_tags, 'string'
|
@@ -35,6 +35,7 @@ module FacebookAds
|
|
35
35
|
"BUY_TICKETS",
|
36
36
|
"CALL",
|
37
37
|
"CALL_ME",
|
38
|
+
"CALL_NOW",
|
38
39
|
"CONTACT",
|
39
40
|
"CONTACT_US",
|
40
41
|
"DONATE",
|
@@ -65,6 +66,7 @@ module FacebookAds
|
|
65
66
|
"ORDER_NOW",
|
66
67
|
"PAY_TO_ACCESS",
|
67
68
|
"PLAY_GAME",
|
69
|
+
"PLAY_GAME_ON_FACEBOOK",
|
68
70
|
"PURCHASE_GIFT_CARDS",
|
69
71
|
"RECORD_NOW",
|
70
72
|
"REFER_FRIENDS",
|
@@ -28,6 +28,7 @@ module FacebookAds
|
|
28
28
|
class AdCreativeLinkDataImageOverlaySpec < AdObject
|
29
29
|
CUSTOM_TEXT_TYPE = [
|
30
30
|
"free_shipping",
|
31
|
+
"popular",
|
31
32
|
]
|
32
33
|
|
33
34
|
OVERLAY_TEMPLATE = [
|
@@ -57,6 +58,7 @@ module FacebookAds
|
|
57
58
|
]
|
58
59
|
|
59
60
|
TEXT_TYPE = [
|
61
|
+
"automated_personalize",
|
60
62
|
"custom",
|
61
63
|
"disclaimer",
|
62
64
|
"from_price",
|
@@ -26,11 +26,6 @@ module FacebookAds
|
|
26
26
|
# pull request for this class.
|
27
27
|
|
28
28
|
class AdPlacePageSet < AdObject
|
29
|
-
CATEGORY = [
|
30
|
-
"BOPUS",
|
31
|
-
"GENERAL",
|
32
|
-
]
|
33
|
-
|
34
29
|
LOCATION_TYPES = [
|
35
30
|
"home",
|
36
31
|
"recent",
|
@@ -49,7 +44,6 @@ module FacebookAds
|
|
49
44
|
field :name, 'string'
|
50
45
|
field :pages_count, 'int'
|
51
46
|
field :parent_page, 'Page'
|
52
|
-
field :category, 'adaccountad_place_page_sets_category_enum_param'
|
53
47
|
field :targeted_area_type, 'adaccountad_place_page_sets_targeted_area_type_enum_param'
|
54
48
|
has_no_post
|
55
49
|
has_no_delete
|