facebookbusiness 0.9.0.0 → 0.10.0.1

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.
Files changed (93) hide show
  1. checksums.yaml +4 -4
  2. data/lib/facebook_ads/ad_objects/ad.rb +4 -1
  3. data/lib/facebook_ads/ad_objects/ad_account.rb +11 -45
  4. data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +1 -0
  5. data/lib/facebook_ads/ad_objects/ad_account_matched_search_applications_edge_data.rb +1 -0
  6. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +3 -1
  7. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +3 -0
  8. data/lib/facebook_ads/ad_objects/ad_campaign_activity.rb +6 -2
  9. data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +1 -0
  10. data/lib/facebook_ads/ad_objects/ad_creative.rb +9 -7
  11. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +2 -0
  12. data/lib/facebook_ads/ad_objects/{read_only_analytics_user_property_config.rb → ad_creative_omnichannel_link_spec.rb} +5 -3
  13. data/lib/facebook_ads/ad_objects/ad_creative_portrait_customizations.rb +1 -0
  14. data/lib/facebook_ads/ad_objects/ad_preview.rb +4 -0
  15. data/lib/facebook_ads/ad_objects/ad_report_run.rb +1 -0
  16. data/lib/facebook_ads/ad_objects/ad_rule_evaluation_spec.rb +1 -2
  17. data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb +1 -2
  18. data/lib/facebook_ads/ad_objects/ad_set.rb +6 -2
  19. data/lib/facebook_ads/ad_objects/ad_study.rb +8 -11
  20. data/lib/facebook_ads/ad_objects/ad_study_objective.rb +3 -0
  21. data/lib/facebook_ads/ad_objects/ad_video.rb +18 -17
  22. data/lib/facebook_ads/ad_objects/adgroup_activity.rb +0 -2
  23. data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb +1 -0
  24. data/lib/facebook_ads/ad_objects/adoptable_pet.rb +18 -0
  25. data/lib/facebook_ads/ad_objects/ads_action_stats.rb +2 -0
  26. data/lib/facebook_ads/ad_objects/ads_insights.rb +3 -1
  27. data/lib/facebook_ads/ad_objects/ads_pixel.rb +5 -0
  28. data/lib/facebook_ads/ad_objects/album.rb +0 -10
  29. data/lib/facebook_ads/ad_objects/application.rb +22 -10
  30. data/lib/facebook_ads/ad_objects/atlas_campaign.rb +0 -8
  31. data/lib/facebook_ads/ad_objects/automotive_model.rb +43 -0
  32. data/lib/facebook_ads/ad_objects/business.rb +40 -3
  33. data/lib/facebook_ads/ad_objects/business_asset_group.rb +2 -0
  34. data/lib/facebook_ads/ad_objects/campaign.rb +5 -4
  35. data/lib/facebook_ads/ad_objects/{user_payment_modules_options.rb → catalog_item_channels_to_integrity_status.rb} +3 -5
  36. data/lib/facebook_ads/ad_objects/catalog_sub_vertical_list.rb +3 -1
  37. data/lib/facebook_ads/ad_objects/comment.rb +3 -1
  38. data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +2 -0
  39. data/lib/facebook_ads/ad_objects/content_delivery_report.rb +4 -0
  40. data/lib/facebook_ads/ad_objects/{offline_terms_of_service.rb → contextual_bundling_spec.rb} +4 -4
  41. data/lib/facebook_ads/ad_objects/cpas_parent_catalog_settings.rb +1 -0
  42. data/lib/facebook_ads/ad_objects/custom_audience.rb +8 -12
  43. data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb +1 -0
  44. data/lib/facebook_ads/ad_objects/delivery_window.rb +287 -0
  45. data/lib/facebook_ads/ad_objects/destination.rb +18 -0
  46. data/lib/facebook_ads/ad_objects/flight.rb +18 -0
  47. data/lib/facebook_ads/ad_objects/group.rb +38 -22
  48. data/lib/facebook_ads/ad_objects/home_listing.rb +18 -0
  49. data/lib/facebook_ads/ad_objects/hotel.rb +18 -0
  50. data/lib/facebook_ads/ad_objects/ig_media.rb +2 -1
  51. data/lib/facebook_ads/ad_objects/ig_user.rb +6 -1
  52. data/lib/facebook_ads/ad_objects/image_copyright.rb +302 -0
  53. data/lib/facebook_ads/ad_objects/insights_result.rb +1 -1
  54. data/lib/facebook_ads/ad_objects/instagram_user.rb +0 -3
  55. data/lib/facebook_ads/ad_objects/{invoice_campaign.rb → invoice_campaign_new.rb} +1 -1
  56. data/lib/facebook_ads/ad_objects/link.rb +0 -10
  57. data/lib/facebook_ads/ad_objects/live_video.rb +20 -13
  58. data/lib/facebook_ads/ad_objects/messenger_profile.rb +1 -0
  59. data/lib/facebook_ads/ad_objects/{event_tour.rb → omega_customer_trx.rb} +28 -20
  60. data/lib/facebook_ads/ad_objects/oracle_transaction.rb +1 -6
  61. data/lib/facebook_ads/ad_objects/page.rb +49 -11
  62. data/lib/facebook_ads/ad_objects/page_call_to_action.rb +3 -0
  63. data/lib/facebook_ads/ad_objects/page_commerce_eligibility.rb +38 -0
  64. data/lib/facebook_ads/ad_objects/page_post.rb +0 -10
  65. data/lib/facebook_ads/ad_objects/payment_engine_payment.rb +73 -0
  66. data/lib/facebook_ads/ad_objects/payment_subscription.rb +3 -3
  67. data/lib/facebook_ads/ad_objects/photo.rb +0 -10
  68. data/lib/facebook_ads/ad_objects/post.rb +12 -40
  69. data/lib/facebook_ads/ad_objects/private_lift_study_instance.rb +46 -0
  70. data/lib/facebook_ads/ad_objects/product_catalog.rb +29 -2
  71. data/lib/facebook_ads/ad_objects/product_feed.rb +17 -1
  72. data/lib/facebook_ads/ad_objects/product_feed_schedule.rb +2 -0
  73. data/lib/facebook_ads/ad_objects/product_item.rb +17 -1
  74. data/lib/facebook_ads/ad_objects/{user_payment_methods_info.rb → product_item_ar_data.rb} +24 -8
  75. data/lib/facebook_ads/ad_objects/product_set.rb +7 -0
  76. data/lib/facebook_ads/ad_objects/saved_audience.rb +1 -0
  77. data/lib/facebook_ads/ad_objects/server_side/action_source.rb +48 -0
  78. data/lib/facebook_ads/ad_objects/server_side/event.rb +32 -6
  79. data/lib/facebook_ads/ad_objects/server_side/user_data.rb +290 -96
  80. data/lib/facebook_ads/ad_objects/server_side/util.rb +29 -1
  81. data/lib/facebook_ads/ad_objects/system_user.rb +20 -0
  82. data/lib/facebook_ads/ad_objects/targeting.rb +0 -2
  83. data/lib/facebook_ads/ad_objects/unified_thread.rb +0 -1
  84. data/lib/facebook_ads/ad_objects/user.rb +18 -13
  85. data/lib/facebook_ads/ad_objects/vehicle.rb +18 -0
  86. data/lib/facebook_ads/ad_objects/vehicle_offer.rb +18 -0
  87. data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +1 -0
  88. data/lib/facebook_ads/ad_objects/{friend_list.rb → whats_app_business_profile.rb} +3 -5
  89. data/lib/facebook_ads/edge.rb +2 -1
  90. data/lib/facebook_ads/version.rb +2 -2
  91. metadata +23 -19
  92. data/lib/facebook_ads/ad_objects/ad_account_creation_request.rb +0 -71
  93. data/lib/facebook_ads/ad_objects/ad_account_roas.rb +0 -65
@@ -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
@@ -27,13 +27,13 @@ module FacebookAds
27
27
 
28
28
  class IgMedia < AdObject
29
29
 
30
- field :alt_text, 'string'
31
30
  field :caption, 'string'
32
31
  field :comments_count, 'int'
33
32
  field :id, 'string'
34
33
  field :ig_id, 'string'
35
34
  field :is_comment_enabled, 'bool'
36
35
  field :like_count, 'int'
36
+ field :media_product_type, 'string'
37
37
  field :media_type, 'string'
38
38
  field :media_url, 'string'
39
39
  field :owner, 'IgUser'
@@ -42,6 +42,7 @@ module FacebookAds
42
42
  field :thumbnail_url, 'string'
43
43
  field :timestamp, 'datetime'
44
44
  field :username, 'string'
45
+ field :video_title, 'string'
45
46
  has_no_delete
46
47
 
47
48
  has_edge :children do |edge|
@@ -33,7 +33,6 @@ module FacebookAds
33
33
  field :follows_count, 'int'
34
34
  field :id, 'string'
35
35
  field :ig_id, 'int'
36
- field :is_ig_shopping_seller_policy_enabled, 'bool'
37
36
  field :media_count, 'int'
38
37
  field :mentioned_comment, 'IgComment'
39
38
  field :mentioned_media, 'IgMedia'
@@ -45,6 +44,12 @@ module FacebookAds
45
44
  has_no_post
46
45
  has_no_delete
47
46
 
47
+ has_edge :content_publishing_limit do |edge|
48
+ edge.get do |api|
49
+ api.has_param :since, 'datetime'
50
+ end
51
+ end
52
+
48
53
  has_edge :insights do |edge|
49
54
  edge.get 'InstagramInsightsResult' do |api|
50
55
  api.has_param :metric, { list: { enum: -> { InstagramInsightsResult::METRIC }} }
@@ -0,0 +1,302 @@
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 ImageCopyright < AdObject
29
+ GEO_OWNERSHIP = [
30
+ "AD",
31
+ "AE",
32
+ "AF",
33
+ "AG",
34
+ "AI",
35
+ "AL",
36
+ "AM",
37
+ "AN",
38
+ "AO",
39
+ "AQ",
40
+ "AR",
41
+ "AS",
42
+ "AT",
43
+ "AU",
44
+ "AW",
45
+ "AX",
46
+ "AZ",
47
+ "BA",
48
+ "BB",
49
+ "BD",
50
+ "BE",
51
+ "BF",
52
+ "BG",
53
+ "BH",
54
+ "BI",
55
+ "BJ",
56
+ "BL",
57
+ "BM",
58
+ "BN",
59
+ "BO",
60
+ "BQ",
61
+ "BR",
62
+ "BS",
63
+ "BT",
64
+ "BV",
65
+ "BW",
66
+ "BY",
67
+ "BZ",
68
+ "CA",
69
+ "CC",
70
+ "CD",
71
+ "CF",
72
+ "CG",
73
+ "CH",
74
+ "CI",
75
+ "CK",
76
+ "CL",
77
+ "CM",
78
+ "CN",
79
+ "CO",
80
+ "CR",
81
+ "CU",
82
+ "CV",
83
+ "CW",
84
+ "CX",
85
+ "CY",
86
+ "CZ",
87
+ "DE",
88
+ "DJ",
89
+ "DK",
90
+ "DM",
91
+ "DO",
92
+ "DZ",
93
+ "EC",
94
+ "EE",
95
+ "EG",
96
+ "EH",
97
+ "ER",
98
+ "ES",
99
+ "ET",
100
+ "FI",
101
+ "FJ",
102
+ "FK",
103
+ "FM",
104
+ "FO",
105
+ "FR",
106
+ "GA",
107
+ "GB",
108
+ "GD",
109
+ "GE",
110
+ "GF",
111
+ "GG",
112
+ "GH",
113
+ "GI",
114
+ "GL",
115
+ "GM",
116
+ "GN",
117
+ "GP",
118
+ "GQ",
119
+ "GR",
120
+ "GS",
121
+ "GT",
122
+ "GU",
123
+ "GW",
124
+ "GY",
125
+ "HK",
126
+ "HM",
127
+ "HN",
128
+ "HR",
129
+ "HT",
130
+ "HU",
131
+ "ID",
132
+ "IE",
133
+ "IL",
134
+ "IM",
135
+ "IN",
136
+ "IO",
137
+ "IQ",
138
+ "IR",
139
+ "IS",
140
+ "IT",
141
+ "JE",
142
+ "JM",
143
+ "JO",
144
+ "JP",
145
+ "KE",
146
+ "KG",
147
+ "KH",
148
+ "KI",
149
+ "KM",
150
+ "KN",
151
+ "KP",
152
+ "KR",
153
+ "KW",
154
+ "KY",
155
+ "KZ",
156
+ "LA",
157
+ "LB",
158
+ "LC",
159
+ "LI",
160
+ "LK",
161
+ "LR",
162
+ "LS",
163
+ "LT",
164
+ "LU",
165
+ "LV",
166
+ "LY",
167
+ "MA",
168
+ "MC",
169
+ "MD",
170
+ "ME",
171
+ "MF",
172
+ "MG",
173
+ "MH",
174
+ "MK",
175
+ "ML",
176
+ "MM",
177
+ "MN",
178
+ "MO",
179
+ "MP",
180
+ "MQ",
181
+ "MR",
182
+ "MS",
183
+ "MT",
184
+ "MU",
185
+ "MV",
186
+ "MW",
187
+ "MX",
188
+ "MY",
189
+ "MZ",
190
+ "NA",
191
+ "NC",
192
+ "NE",
193
+ "NF",
194
+ "NG",
195
+ "NI",
196
+ "NL",
197
+ "NO",
198
+ "NP",
199
+ "NR",
200
+ "NU",
201
+ "NZ",
202
+ "OM",
203
+ "PA",
204
+ "PE",
205
+ "PF",
206
+ "PG",
207
+ "PH",
208
+ "PK",
209
+ "PL",
210
+ "PM",
211
+ "PN",
212
+ "PR",
213
+ "PS",
214
+ "PT",
215
+ "PW",
216
+ "PY",
217
+ "QA",
218
+ "RE",
219
+ "RO",
220
+ "RS",
221
+ "RU",
222
+ "RW",
223
+ "SA",
224
+ "SB",
225
+ "SC",
226
+ "SD",
227
+ "SE",
228
+ "SG",
229
+ "SH",
230
+ "SI",
231
+ "SJ",
232
+ "SK",
233
+ "SL",
234
+ "SM",
235
+ "SN",
236
+ "SO",
237
+ "SR",
238
+ "SS",
239
+ "ST",
240
+ "SV",
241
+ "SX",
242
+ "SY",
243
+ "SZ",
244
+ "TC",
245
+ "TD",
246
+ "TF",
247
+ "TG",
248
+ "TH",
249
+ "TJ",
250
+ "TK",
251
+ "TL",
252
+ "TM",
253
+ "TN",
254
+ "TO",
255
+ "TP",
256
+ "TR",
257
+ "TT",
258
+ "TV",
259
+ "TW",
260
+ "TZ",
261
+ "UA",
262
+ "UG",
263
+ "UM",
264
+ "US",
265
+ "UY",
266
+ "UZ",
267
+ "VA",
268
+ "VC",
269
+ "VE",
270
+ "VG",
271
+ "VI",
272
+ "VN",
273
+ "VU",
274
+ "WF",
275
+ "WS",
276
+ "XK",
277
+ "YE",
278
+ "YT",
279
+ "ZA",
280
+ "ZM",
281
+ "ZW",
282
+ ]
283
+
284
+
285
+ field :artist, 'string'
286
+ field :copyright_monitoring_status, 'string'
287
+ field :creation_time, 'datetime'
288
+ field :creator, 'string'
289
+ field :custom_id, 'string'
290
+ field :description, 'string'
291
+ field :filename, 'string'
292
+ field :id, 'string'
293
+ field :image, 'Photo'
294
+ field :matches_count, 'int'
295
+ field :original_content_creation_date, 'datetime'
296
+ field :ownership_countries, 'VideoCopyrightGeoGate'
297
+ field :tags, { list: 'string' }
298
+ field :title, 'string'
299
+ field :update_time, 'datetime'
300
+
301
+ end
302
+ end
@@ -38,7 +38,7 @@ module FacebookAds
38
38
  "last_week_mon_sun",
39
39
  "last_week_sun_sat",
40
40
  "last_year",
41
- "lifetime",
41
+ "maximum",
42
42
  "this_month",
43
43
  "this_quarter",
44
44
  "this_week_mon_today",
@@ -40,9 +40,6 @@ module FacebookAds
40
40
  has_no_delete
41
41
 
42
42
  has_edge :agencies do |edge|
43
- edge.delete do |api|
44
- api.has_param :business, 'string'
45
- end
46
43
  edge.get 'Business'
47
44
  end
48
45
 
@@ -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'