facebookbusiness 0.10.0.0 → 0.10.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (53) hide show
  1. checksums.yaml +4 -4
  2. data/lib/facebook_ads/ad_objects/ad_account.rb +2 -15
  3. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +2 -0
  4. data/lib/facebook_ads/ad_objects/ad_creative.rb +7 -7
  5. data/lib/facebook_ads/ad_objects/ad_creative_portrait_customizations.rb +1 -0
  6. data/lib/facebook_ads/ad_objects/ad_preview.rb +1 -0
  7. data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb +1 -2
  8. data/lib/facebook_ads/ad_objects/ad_study.rb +8 -0
  9. data/lib/facebook_ads/ad_objects/ad_study_objective.rb +2 -0
  10. data/lib/facebook_ads/ad_objects/ad_video.rb +15 -5
  11. data/lib/facebook_ads/ad_objects/adgroup_activity.rb +0 -2
  12. data/lib/facebook_ads/ad_objects/adoptable_pet.rb +18 -0
  13. data/lib/facebook_ads/ad_objects/ads_insights.rb +1 -0
  14. data/lib/facebook_ads/ad_objects/ads_pixel.rb +1 -0
  15. data/lib/facebook_ads/ad_objects/application.rb +21 -0
  16. data/lib/facebook_ads/ad_objects/atlas_campaign.rb +0 -8
  17. data/lib/facebook_ads/ad_objects/automotive_model.rb +18 -0
  18. data/lib/facebook_ads/ad_objects/business.rb +16 -3
  19. data/lib/facebook_ads/ad_objects/business_asset_group.rb +1 -0
  20. data/lib/facebook_ads/ad_objects/catalog_sub_vertical_list.rb +0 -1
  21. data/lib/facebook_ads/ad_objects/comment.rb +2 -1
  22. data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +1 -0
  23. data/lib/facebook_ads/ad_objects/content_delivery_report.rb +4 -0
  24. data/lib/facebook_ads/ad_objects/cpas_parent_catalog_settings.rb +1 -0
  25. data/lib/facebook_ads/ad_objects/custom_audience.rb +0 -2
  26. data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb +1 -0
  27. data/lib/facebook_ads/ad_objects/delivery_window.rb +287 -0
  28. data/lib/facebook_ads/ad_objects/destination.rb +18 -0
  29. data/lib/facebook_ads/ad_objects/flight.rb +18 -0
  30. data/lib/facebook_ads/ad_objects/group.rb +17 -0
  31. data/lib/facebook_ads/ad_objects/home_listing.rb +18 -0
  32. data/lib/facebook_ads/ad_objects/hotel.rb +18 -0
  33. data/lib/facebook_ads/ad_objects/ig_media.rb +2 -0
  34. data/lib/facebook_ads/ad_objects/{invoice_campaign.rb → invoice_campaign_new.rb} +1 -1
  35. data/lib/facebook_ads/ad_objects/live_video.rb +8 -1
  36. data/lib/facebook_ads/ad_objects/omega_customer_trx.rb +64 -0
  37. data/lib/facebook_ads/ad_objects/oracle_transaction.rb +1 -6
  38. data/lib/facebook_ads/ad_objects/page.rb +18 -6
  39. data/lib/facebook_ads/ad_objects/private_lift_study_instance.rb +46 -0
  40. data/lib/facebook_ads/ad_objects/product_catalog.rb +15 -0
  41. data/lib/facebook_ads/ad_objects/product_feed.rb +16 -0
  42. data/lib/facebook_ads/ad_objects/product_item.rb +10 -0
  43. data/lib/facebook_ads/ad_objects/product_item_ar_data.rb +1 -0
  44. data/lib/facebook_ads/ad_objects/product_set.rb +7 -0
  45. data/lib/facebook_ads/ad_objects/saved_audience.rb +1 -0
  46. data/lib/facebook_ads/ad_objects/server_side/user_data.rb +290 -96
  47. data/lib/facebook_ads/ad_objects/server_side/util.rb +15 -0
  48. data/lib/facebook_ads/ad_objects/vehicle.rb +18 -0
  49. data/lib/facebook_ads/ad_objects/vehicle_offer.rb +18 -0
  50. data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +1 -0
  51. data/lib/facebook_ads/ad_objects/whats_app_business_profile.rb +1 -0
  52. data/lib/facebook_ads/version.rb +1 -1
  53. metadata +6 -3
@@ -26,6 +26,15 @@ module FacebookAds
26
26
  # pull request for this class.
27
27
 
28
28
  class Destination < AdObject
29
+ IMAGE_FETCH_STATUS = [
30
+ "DIRECT_UPLOAD",
31
+ "FETCHED",
32
+ "FETCH_FAILED",
33
+ "NO_STATUS",
34
+ "OUTDATED",
35
+ "PARTIAL_FETCH",
36
+ ]
37
+
29
38
 
30
39
  field :address, 'string'
31
40
  field :applinks, 'CatalogItemAppLinks'
@@ -34,6 +43,7 @@ module FacebookAds
34
43
  field :description, 'string'
35
44
  field :destination_id, 'string'
36
45
  field :id, 'string'
46
+ field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
37
47
  field :images, { list: 'string' }
38
48
  field :name, 'string'
39
49
  field :price, 'string'
@@ -44,5 +54,13 @@ module FacebookAds
44
54
  has_no_post
45
55
  has_no_delete
46
56
 
57
+ has_edge :augmented_realities_metadata do |edge|
58
+ edge.get
59
+ end
60
+
61
+ has_edge :videos_metadata do |edge|
62
+ edge.get
63
+ end
64
+
47
65
  end
48
66
  end
@@ -26,6 +26,15 @@ module FacebookAds
26
26
  # pull request for this class.
27
27
 
28
28
  class Flight < AdObject
29
+ IMAGE_FETCH_STATUS = [
30
+ "DIRECT_UPLOAD",
31
+ "FETCHED",
32
+ "FETCH_FAILED",
33
+ "NO_STATUS",
34
+ "OUTDATED",
35
+ "PARTIAL_FETCH",
36
+ ]
37
+
29
38
 
30
39
  field :applinks, 'CatalogItemAppLinks'
31
40
  field :category_specific_fields, 'CatalogSubVerticalList'
@@ -35,6 +44,7 @@ module FacebookAds
35
44
  field :destination_city, 'string'
36
45
  field :flight_id, 'string'
37
46
  field :id, 'string'
47
+ field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
38
48
  field :images, { list: 'string' }
39
49
  field :oneway_currency, 'string'
40
50
  field :oneway_price, 'string'
@@ -45,5 +55,13 @@ module FacebookAds
45
55
  field :url, 'string'
46
56
  has_no_delete
47
57
 
58
+ has_edge :augmented_realities_metadata do |edge|
59
+ edge.get
60
+ end
61
+
62
+ has_edge :videos_metadata do |edge|
63
+ edge.get
64
+ end
65
+
48
66
  end
49
67
  end
@@ -351,6 +351,14 @@ module FacebookAds
351
351
  end
352
352
  end
353
353
 
354
+ has_edge :important_posts do |edge|
355
+ edge.post do |api|
356
+ api.has_param :button_type, { enum: %w{DISMISS DONE MARK_AS_READ }}
357
+ api.has_param :expiration_time, 'datetime'
358
+ api.has_param :post_id, 'string'
359
+ end
360
+ end
361
+
354
362
  has_edge :live_videos do |edge|
355
363
  edge.get 'LiveVideo' do |api|
356
364
  api.has_param :broadcast_status, { list: { enum: -> { LiveVideo::BROADCAST_STATUS }} }
@@ -466,6 +474,15 @@ module FacebookAds
466
474
  end
467
475
  end
468
476
 
477
+ has_edge :pinned_posts do |edge|
478
+ edge.delete do |api|
479
+ api.has_param :post_id, 'string'
480
+ end
481
+ edge.post 'Post' do |api|
482
+ api.has_param :post_ids, { list: 'string' }
483
+ end
484
+ end
485
+
469
486
  has_edge :videos do |edge|
470
487
  edge.get 'AdVideo' do |api|
471
488
  api.has_param :type, { enum: -> { AdVideo::TYPE }}
@@ -26,6 +26,15 @@ module FacebookAds
26
26
  # pull request for this class.
27
27
 
28
28
  class HomeListing < AdObject
29
+ IMAGE_FETCH_STATUS = [
30
+ "DIRECT_UPLOAD",
31
+ "FETCHED",
32
+ "FETCH_FAILED",
33
+ "NO_STATUS",
34
+ "OUTDATED",
35
+ "PARTIAL_FETCH",
36
+ ]
37
+
29
38
 
30
39
  field :ac_type, 'string'
31
40
  field :additional_fees_description, 'string'
@@ -50,6 +59,7 @@ module FacebookAds
50
59
  field :heating_type, 'string'
51
60
  field :home_listing_id, 'string'
52
61
  field :id, 'string'
62
+ field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
53
63
  field :images, { list: 'string' }
54
64
  field :laundry_type, 'string'
55
65
  field :listing_type, 'string'
@@ -71,5 +81,13 @@ module FacebookAds
71
81
  field :url, 'string'
72
82
  field :year_built, 'int'
73
83
 
84
+ has_edge :augmented_realities_metadata do |edge|
85
+ edge.get
86
+ end
87
+
88
+ has_edge :videos_metadata do |edge|
89
+ edge.get
90
+ end
91
+
74
92
  end
75
93
  end
@@ -26,6 +26,15 @@ module FacebookAds
26
26
  # pull request for this class.
27
27
 
28
28
  class Hotel < AdObject
29
+ IMAGE_FETCH_STATUS = [
30
+ "DIRECT_UPLOAD",
31
+ "FETCHED",
32
+ "FETCH_FAILED",
33
+ "NO_STATUS",
34
+ "OUTDATED",
35
+ "PARTIAL_FETCH",
36
+ ]
37
+
29
38
 
30
39
  field :address, 'string'
31
40
  field :applinks, 'CatalogItemAppLinks'
@@ -37,6 +46,7 @@ module FacebookAds
37
46
  field :guest_ratings, 'string'
38
47
  field :hotel_id, 'string'
39
48
  field :id, 'string'
49
+ field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
40
50
  field :images, { list: 'string' }
41
51
  field :lowest_base_price, 'string'
42
52
  field :loyalty_program, 'string'
@@ -49,9 +59,17 @@ module FacebookAds
49
59
  field :url, 'string'
50
60
  field :base_price, 'int'
51
61
 
62
+ has_edge :augmented_realities_metadata do |edge|
63
+ edge.get
64
+ end
65
+
52
66
  has_edge :hotel_rooms do |edge|
53
67
  edge.get 'HotelRoom'
54
68
  end
55
69
 
70
+ has_edge :videos_metadata do |edge|
71
+ edge.get
72
+ end
73
+
56
74
  end
57
75
  end
@@ -33,6 +33,7 @@ module FacebookAds
33
33
  field :ig_id, 'string'
34
34
  field :is_comment_enabled, 'bool'
35
35
  field :like_count, 'int'
36
+ field :media_product_type, 'string'
36
37
  field :media_type, 'string'
37
38
  field :media_url, 'string'
38
39
  field :owner, 'IgUser'
@@ -41,6 +42,7 @@ module FacebookAds
41
42
  field :thumbnail_url, 'string'
42
43
  field :timestamp, 'datetime'
43
44
  field :username, 'string'
45
+ field :video_title, 'string'
44
46
  has_no_delete
45
47
 
46
48
  has_edge :children do |edge|
@@ -25,7 +25,7 @@ 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 InvoiceCampaign < AdObject
28
+ class InvoiceCampaignNew < AdObject
29
29
 
30
30
  field :ad_account_id, 'string'
31
31
  field :billed_amount_details, 'BilledAmountDetails'
@@ -73,6 +73,7 @@ module FacebookAds
73
73
  ]
74
74
 
75
75
  LIVE_COMMENT_MODERATION_SETTING = [
76
+ "DEFAULT",
76
77
  "DISCUSSION",
77
78
  "FOLLOWER",
78
79
  "PROTECTED_MODE",
@@ -81,6 +82,12 @@ module FacebookAds
81
82
  "SUPPORTER",
82
83
  ]
83
84
 
85
+ PERSISTENT_STREAM_KEY_STATUS = [
86
+ "DISABLE",
87
+ "ENABLE",
88
+ "REGENERATE",
89
+ ]
90
+
84
91
 
85
92
  field :ad_break_config, 'LiveVideoAdBreakConfig'
86
93
  field :ad_break_failure_reason, 'string'
@@ -99,7 +106,7 @@ module FacebookAds
99
106
  field :live_encoders, { list: 'LiveEncoder' }
100
107
  field :live_views, 'int'
101
108
  field :overlay_url, 'string'
102
- field :permalink_url, 'string'
109
+ field :permalink_url, 'object'
103
110
  field :planned_start_time, 'datetime'
104
111
  field :seconds_left, 'int'
105
112
  field :secure_stream_url, 'string'
@@ -0,0 +1,64 @@
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 OmegaCustomerTrx < AdObject
29
+ TYPE = [
30
+ "CM",
31
+ "DM",
32
+ "INV",
33
+ "PRO_FORMA",
34
+ ]
35
+
36
+
37
+ field :ad_account_ids, { list: 'string' }
38
+ field :amount, 'string'
39
+ field :amount_due, 'CurrencyAmount'
40
+ field :billed_amount_details, 'BilledAmountDetails'
41
+ field :billing_period, 'string'
42
+ field :campaign, 'AtlasCampaign'
43
+ field :cdn_download_uri, 'string'
44
+ field :currency, 'string'
45
+ field :download_uri, 'string'
46
+ field :due_date, 'datetime'
47
+ field :entity, 'string'
48
+ field :id, 'string'
49
+ field :invoice_date, 'datetime'
50
+ field :invoice_id, 'string'
51
+ field :invoice_type, 'string'
52
+ field :liability_type, 'string'
53
+ field :payment_status, 'string'
54
+ field :payment_term, 'string'
55
+ field :type, 'string'
56
+ has_no_post
57
+ has_no_delete
58
+
59
+ has_edge :campaigns do |edge|
60
+ edge.get 'InvoiceCampaignNew'
61
+ end
62
+
63
+ end
64
+ end
@@ -26,11 +26,6 @@ module FacebookAds
26
26
  # pull request for this class.
27
27
 
28
28
  class OracleTransaction < AdObject
29
- TYPE = [
30
- "CM",
31
- "INV",
32
- ]
33
-
34
29
 
35
30
  field :ad_account_ids, { list: 'string' }
36
31
  field :amount, 'string'
@@ -54,7 +49,7 @@ module FacebookAds
54
49
  has_no_delete
55
50
 
56
51
  has_edge :campaigns do |edge|
57
- edge.get 'InvoiceCampaign'
52
+ edge.get 'InvoiceCampaignNew'
58
53
  end
59
54
 
60
55
  end
@@ -121,6 +121,7 @@ module FacebookAds
121
121
  "PROFILE_PLUS_ADVERTISE",
122
122
  "PROFILE_PLUS_ANALYZE",
123
123
  "PROFILE_PLUS_CREATE_CONTENT",
124
+ "PROFILE_PLUS_FACEBOOK_ACCESS",
124
125
  "PROFILE_PLUS_MANAGE",
125
126
  "PROFILE_PLUS_MESSAGING",
126
127
  "PROFILE_PLUS_MODERATE",
@@ -144,6 +145,7 @@ module FacebookAds
144
145
  "PROFILE_PLUS_ADVERTISE",
145
146
  "PROFILE_PLUS_ANALYZE",
146
147
  "PROFILE_PLUS_CREATE_CONTENT",
148
+ "PROFILE_PLUS_FACEBOOK_ACCESS",
147
149
  "PROFILE_PLUS_MANAGE",
148
150
  "PROFILE_PLUS_MESSAGING",
149
151
  "PROFILE_PLUS_MODERATE",
@@ -389,6 +391,7 @@ module FacebookAds
389
391
  field :global_brand_page_name, 'string'
390
392
  field :global_brand_root_id, 'string'
391
393
  field :has_added_app, 'bool'
394
+ field :has_transitioned_to_new_page_experience, 'bool'
392
395
  field :has_whatsapp_business_number, 'bool'
393
396
  field :has_whatsapp_number, 'bool'
394
397
  field :hometown, 'string'
@@ -490,6 +493,10 @@ module FacebookAds
490
493
  end
491
494
  end
492
495
 
496
+ has_edge :admin_notes do |edge|
497
+ edge.get 'PageAdminNote'
498
+ end
499
+
493
500
  has_edge :ads_posts do |edge|
494
501
  edge.get 'PagePost' do |api|
495
502
  api.has_param :exclude_dynamic_ads, 'bool'
@@ -1116,6 +1123,13 @@ module FacebookAds
1116
1123
  end
1117
1124
  end
1118
1125
 
1126
+ has_edge :phone_data do |edge|
1127
+ edge.post do |api|
1128
+ api.has_param :call_ads_phone_data_use_case, { enum: %w{CALL_DESTINATION_AD CALL_EXTENSION_AD }}
1129
+ api.has_param :phone_number, 'string'
1130
+ end
1131
+ end
1132
+
1119
1133
  has_edge :photos do |edge|
1120
1134
  edge.get 'Photo' do |api|
1121
1135
  api.has_param :biz_tag_id, 'int'
@@ -1235,8 +1249,10 @@ module FacebookAds
1235
1249
 
1236
1250
  has_edge :published_posts do |edge|
1237
1251
  edge.get 'PagePost' do |api|
1238
- api.has_param :since, 'datetime'
1239
- api.has_param :until, 'datetime'
1252
+ api.has_param :include_hidden, 'bool'
1253
+ api.has_param :limit, 'int'
1254
+ api.has_param :show_expired, 'bool'
1255
+ api.has_param :with, { enum: -> { PagePost::WITH }}
1240
1256
  end
1241
1257
  end
1242
1258
 
@@ -1337,10 +1353,6 @@ module FacebookAds
1337
1353
  end
1338
1354
  end
1339
1355
 
1340
- has_edge :tours do |edge|
1341
- edge.get
1342
- end
1343
-
1344
1356
  has_edge :unlink_accounts do |edge|
1345
1357
  edge.post 'Page' do |api|
1346
1358
  api.has_param :psid, 'string'
@@ -0,0 +1,46 @@
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 PrivateLiftStudyInstance < AdObject
29
+ OPERATION = [
30
+ "AGGREGATE",
31
+ "COMPUTE",
32
+ "ID_MATCH",
33
+ "NONE",
34
+ ]
35
+
36
+
37
+ field :breakdown_key, 'string'
38
+ field :created_time, 'datetime'
39
+ field :id, 'string'
40
+ field :latest_status_update_time, 'datetime'
41
+ field :server_ips, { list: 'string' }
42
+ field :status, 'string'
43
+ has_no_delete
44
+
45
+ end
46
+ end