facebookbusiness 0.6.0.0 → 0.6.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.
- checksums.yaml +4 -4
- data/lib/facebook_ads/ad_objects/ad_campaign_learning_stage_info.rb +0 -2
- data/lib/facebook_ads/ad_objects/ad_report_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_set.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_study.rb +1 -4
- data/lib/facebook_ads/ad_objects/ad_video.rb +1 -0
- data/lib/facebook_ads/ad_objects/ads_pixel.rb +4 -0
- data/lib/facebook_ads/ad_objects/audio_copyright.rb +1 -0
- data/lib/facebook_ads/ad_objects/business.rb +7 -0
- data/lib/facebook_ads/ad_objects/business_asset_group.rb +6 -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/content_delivery_report.rb +1 -1
- data/lib/facebook_ads/ad_objects/group.rb +2 -10
- data/lib/facebook_ads/ad_objects/music_video_copyright.rb +1 -0
- data/lib/facebook_ads/ad_objects/open_graph_object.rb +9 -0
- data/lib/facebook_ads/ad_objects/page.rb +16 -1
- data/lib/facebook_ads/ad_objects/post.rb +0 -4
- data/lib/facebook_ads/ad_objects/product_catalog.rb +3 -0
- data/lib/facebook_ads/ad_objects/product_feed.rb +2 -0
- data/lib/facebook_ads/ad_objects/reach_frequency_activity.rb +0 -6
- data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +0 -1
- data/lib/facebook_ads/ad_objects/server_side/custom_data.rb +27 -5
- data/lib/facebook_ads/ad_objects/unified_thread.rb +0 -60
- data/lib/facebook_ads/ad_objects/user.rb +1 -92
- data/lib/facebook_ads/ad_objects/video_copyright.rb +1 -0
- data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +1 -1
- data/lib/facebook_ads/version.rb +1 -1
- metadata +2 -4
- data/lib/facebook_ads/ad_objects/ads_tal_health_check_error.rb +0 -38
- data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb +0 -48
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 024c4db63b2adfad79667e6553f21a17742c826f990f2e40446121e9f22939cd
|
|
4
|
+
data.tar.gz: 66864433b2635e5c2617b649f573522c68233fa66cb6785ba5138dfed12c28d9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 591f39f45845b9b00568aef451bdf766d51026bf61871ba08e897fb357106dd9922cede347ad61b818f6fe296e2eef22a70b6d236ecbb497c8bd22c5db56a40d
|
|
7
|
+
data.tar.gz: f4001c5d05f6ae63fdcdfe1b13707f7cecfa056e2476b92fb8dee0a735a5aae95fb3c954aac9e43d27bd55353b9a4ad9ba3eb749398bad28b682482bb2ec897e
|
|
@@ -29,10 +29,8 @@ module FacebookAds
|
|
|
29
29
|
|
|
30
30
|
field :attribution_windows, { list: 'string' }
|
|
31
31
|
field :conversions, 'int'
|
|
32
|
-
field :exit_reason, 'string'
|
|
33
32
|
field :last_sig_edit_ts, 'int'
|
|
34
33
|
field :status, 'string'
|
|
35
|
-
field :types, { list: 'string' }
|
|
36
34
|
has_no_id
|
|
37
35
|
has_no_get
|
|
38
36
|
has_no_post
|
|
@@ -198,6 +198,7 @@ module FacebookAds
|
|
|
198
198
|
field :instagram_actor_id, 'string'
|
|
199
199
|
field :is_dynamic_creative, 'bool'
|
|
200
200
|
field :issues_info, { list: 'AdCampaignIssuesInfo' }
|
|
201
|
+
field :learning_stage_info, 'AdCampaignLearningStageInfo'
|
|
201
202
|
field :lifetime_budget, 'string'
|
|
202
203
|
field :lifetime_imps, 'int'
|
|
203
204
|
field :lifetime_min_spend_target, 'string'
|
|
@@ -28,6 +28,7 @@ module FacebookAds
|
|
|
28
28
|
class AdStudy < AdObject
|
|
29
29
|
TYPE = [
|
|
30
30
|
"CONTINUOUS_LIFT_CONFIG",
|
|
31
|
+
"GEO_LIFT",
|
|
31
32
|
"LIFT",
|
|
32
33
|
"SPLIT_TEST",
|
|
33
34
|
]
|
|
@@ -58,10 +59,6 @@ module FacebookAds
|
|
|
58
59
|
edge.get 'AdStudyCell'
|
|
59
60
|
end
|
|
60
61
|
|
|
61
|
-
has_edge :health_check_errors do |edge|
|
|
62
|
-
edge.get 'AdsTalHealthCheckError'
|
|
63
|
-
end
|
|
64
|
-
|
|
65
62
|
has_edge :objectives do |edge|
|
|
66
63
|
edge.get 'AdStudyObjective'
|
|
67
64
|
edge.post 'AdStudyObjective' do |api|
|
|
@@ -99,9 +99,13 @@ module FacebookAds
|
|
|
99
99
|
has_edge :events do |edge|
|
|
100
100
|
edge.post 'AdsPixel' do |api|
|
|
101
101
|
api.has_param :data, { list: 'string' }
|
|
102
|
+
api.has_param :namespace_id, 'string'
|
|
102
103
|
api.has_param :partner_agent, 'string'
|
|
103
104
|
api.has_param :test_event_code, 'string'
|
|
104
105
|
api.has_param :trace, 'int'
|
|
106
|
+
api.has_param :upload_id, 'string'
|
|
107
|
+
api.has_param :upload_source, 'string'
|
|
108
|
+
api.has_param :upload_tag, 'string'
|
|
105
109
|
end
|
|
106
110
|
end
|
|
107
111
|
|
|
@@ -36,6 +36,7 @@ module FacebookAds
|
|
|
36
36
|
field :ownership_countries, { list: 'string' }
|
|
37
37
|
field :reference_file_status, 'string'
|
|
38
38
|
field :ridge_monitoring_status, 'string'
|
|
39
|
+
field :tags, { list: 'string' }
|
|
39
40
|
field :update_time, 'datetime'
|
|
40
41
|
field :whitelisted_fb_users, { list: 'object' }
|
|
41
42
|
field :whitelisted_ig_users, { list: 'string' }
|
|
@@ -87,6 +87,12 @@ module FacebookAds
|
|
|
87
87
|
"PLATFORM_MANAGE_PAGES",
|
|
88
88
|
"PLATFORM_PAGES_MANAGE_INSTANT_ARTICLES",
|
|
89
89
|
"PLATFORM_READ_INSIGHTS",
|
|
90
|
+
"PROFILE_PLUS_ADVERTISE",
|
|
91
|
+
"PROFILE_PLUS_ANALYZE",
|
|
92
|
+
"PROFILE_PLUS_CREATE_CONTENT",
|
|
93
|
+
"PROFILE_PLUS_MANAGE",
|
|
94
|
+
"PROFILE_PLUS_MESSAGING",
|
|
95
|
+
"PROFILE_PLUS_MODERATE",
|
|
90
96
|
"READ_PAGE_MAILBOXES",
|
|
91
97
|
"VIEW_MONETIZATION_INSIGHTS",
|
|
92
98
|
]
|
|
@@ -439,6 +445,7 @@ module FacebookAds
|
|
|
439
445
|
has_edge :owned_pages do |edge|
|
|
440
446
|
edge.get 'Page'
|
|
441
447
|
edge.post 'Business' do |api|
|
|
448
|
+
api.has_param :code, 'string'
|
|
442
449
|
api.has_param :ig_password, 'string'
|
|
443
450
|
api.has_param :page_id, 'int'
|
|
444
451
|
end
|
|
@@ -56,6 +56,12 @@ module FacebookAds
|
|
|
56
56
|
"PLATFORM_MANAGE_PAGES",
|
|
57
57
|
"PLATFORM_PAGES_MANAGE_INSTANT_ARTICLES",
|
|
58
58
|
"PLATFORM_READ_INSIGHTS",
|
|
59
|
+
"PROFILE_PLUS_ADVERTISE",
|
|
60
|
+
"PROFILE_PLUS_ANALYZE",
|
|
61
|
+
"PROFILE_PLUS_CREATE_CONTENT",
|
|
62
|
+
"PROFILE_PLUS_MANAGE",
|
|
63
|
+
"PROFILE_PLUS_MESSAGING",
|
|
64
|
+
"PROFILE_PLUS_MODERATE",
|
|
59
65
|
"READ_PAGE_MAILBOXES",
|
|
60
66
|
"VIEW_MONETIZATION_INSIGHTS",
|
|
61
67
|
]
|
|
@@ -43,6 +43,7 @@ module FacebookAds
|
|
|
43
43
|
"FEED",
|
|
44
44
|
"GROUPS",
|
|
45
45
|
"INSTAGRAM_EXPLORE",
|
|
46
|
+
"INSTAGRAM_IGTV",
|
|
46
47
|
"INSTAGRAM_STORIES",
|
|
47
48
|
"INSTANT_ARTICLE",
|
|
48
49
|
"INSTREAM_VIDEO",
|
|
@@ -53,7 +54,6 @@ module FacebookAds
|
|
|
53
54
|
"REWARDED_VIDEO",
|
|
54
55
|
"RIGHT_HAND_COLUMN",
|
|
55
56
|
"SEARCH",
|
|
56
|
-
"SEARCH_SERP",
|
|
57
57
|
"STATUS",
|
|
58
58
|
"SUGGESTED_VIDEO",
|
|
59
59
|
"UNKNOWN",
|
|
@@ -45,6 +45,7 @@ module FacebookAds
|
|
|
45
45
|
"COUPLE",
|
|
46
46
|
"COWORKERS",
|
|
47
47
|
"CUSTOM",
|
|
48
|
+
"DEALS",
|
|
48
49
|
"EPHEMERAL",
|
|
49
50
|
"EVENT_PLANNING",
|
|
50
51
|
"FAMILY",
|
|
@@ -95,6 +96,7 @@ module FacebookAds
|
|
|
95
96
|
"COUPLE",
|
|
96
97
|
"COWORKERS",
|
|
97
98
|
"CUSTOM",
|
|
99
|
+
"DEALS",
|
|
98
100
|
"EPHEMERAL",
|
|
99
101
|
"EVENT_PLANNING",
|
|
100
102
|
"FAMILY",
|
|
@@ -139,21 +141,11 @@ module FacebookAds
|
|
|
139
141
|
]
|
|
140
142
|
|
|
141
143
|
SUGGESTION_CATEGORY = [
|
|
142
|
-
"CLOSE_FRIENDS",
|
|
143
144
|
"CLOSE_FRIENDS_GENERIC",
|
|
144
|
-
"CURRENT_CITY",
|
|
145
145
|
"EVENT",
|
|
146
146
|
"FAMILY",
|
|
147
|
-
"FRIEND_LIST",
|
|
148
|
-
"GAMES",
|
|
149
147
|
"LIFE_EVENT",
|
|
150
148
|
"MESSENGER",
|
|
151
|
-
"MESSENGER_THREAD",
|
|
152
|
-
"NEARBY_FRIENDS",
|
|
153
|
-
"PAGE_ADMIN",
|
|
154
|
-
"SCHOOL",
|
|
155
|
-
"SCHOOL_GENERIC",
|
|
156
|
-
"TOP_PAGE",
|
|
157
149
|
"WORK",
|
|
158
150
|
"WORKPLACE",
|
|
159
151
|
"WORKPLACE_1_1",
|
|
@@ -36,6 +36,7 @@ module FacebookAds
|
|
|
36
36
|
field :ownership_countries, { list: 'string' }
|
|
37
37
|
field :reference_file_status, 'string'
|
|
38
38
|
field :ridge_monitoring_status, 'string'
|
|
39
|
+
field :tags, { list: 'string' }
|
|
39
40
|
field :update_time, 'datetime'
|
|
40
41
|
field :video_asset, 'CopyrightReferenceContainer'
|
|
41
42
|
field :whitelisted_fb_users, { list: 'object' }
|
|
@@ -51,6 +51,15 @@ module FacebookAds
|
|
|
51
51
|
has_no_post
|
|
52
52
|
has_no_delete
|
|
53
53
|
|
|
54
|
+
has_edge :comments do |edge|
|
|
55
|
+
edge.get 'Comment' do |api|
|
|
56
|
+
api.has_param :filter, { enum: -> { Comment::FILTER }}
|
|
57
|
+
api.has_param :live_filter, { enum: -> { Comment::LIVE_FILTER }}
|
|
58
|
+
api.has_param :order, { enum: -> { Comment::ORDER }}
|
|
59
|
+
api.has_param :since, 'datetime'
|
|
60
|
+
end
|
|
61
|
+
end
|
|
62
|
+
|
|
54
63
|
has_edge :reactions do |edge|
|
|
55
64
|
edge.get 'Profile' do |api|
|
|
56
65
|
api.has_param :type, { enum: -> { Profile::TYPE }}
|
|
@@ -106,6 +106,12 @@ module FacebookAds
|
|
|
106
106
|
"PLATFORM_MANAGE_PAGES",
|
|
107
107
|
"PLATFORM_PAGES_MANAGE_INSTANT_ARTICLES",
|
|
108
108
|
"PLATFORM_READ_INSIGHTS",
|
|
109
|
+
"PROFILE_PLUS_ADVERTISE",
|
|
110
|
+
"PROFILE_PLUS_ANALYZE",
|
|
111
|
+
"PROFILE_PLUS_CREATE_CONTENT",
|
|
112
|
+
"PROFILE_PLUS_MANAGE",
|
|
113
|
+
"PROFILE_PLUS_MESSAGING",
|
|
114
|
+
"PROFILE_PLUS_MODERATE",
|
|
109
115
|
"READ_PAGE_MAILBOXES",
|
|
110
116
|
"VIEW_MONETIZATION_INSIGHTS",
|
|
111
117
|
]
|
|
@@ -124,6 +130,12 @@ module FacebookAds
|
|
|
124
130
|
"PLATFORM_MANAGE_PAGES",
|
|
125
131
|
"PLATFORM_PAGES_MANAGE_INSTANT_ARTICLES",
|
|
126
132
|
"PLATFORM_READ_INSIGHTS",
|
|
133
|
+
"PROFILE_PLUS_ADVERTISE",
|
|
134
|
+
"PROFILE_PLUS_ANALYZE",
|
|
135
|
+
"PROFILE_PLUS_CREATE_CONTENT",
|
|
136
|
+
"PROFILE_PLUS_MANAGE",
|
|
137
|
+
"PROFILE_PLUS_MESSAGING",
|
|
138
|
+
"PROFILE_PLUS_MODERATE",
|
|
127
139
|
"READ_PAGE_MAILBOXES",
|
|
128
140
|
"VIEW_MONETIZATION_INSIGHTS",
|
|
129
141
|
]
|
|
@@ -147,8 +159,10 @@ module FacebookAds
|
|
|
147
159
|
|
|
148
160
|
SENDER_ACTION = [
|
|
149
161
|
"MARK_SEEN",
|
|
162
|
+
"REACT",
|
|
150
163
|
"TYPING_OFF",
|
|
151
164
|
"TYPING_ON",
|
|
165
|
+
"UNREACT",
|
|
152
166
|
]
|
|
153
167
|
|
|
154
168
|
MODEL = [
|
|
@@ -346,7 +360,6 @@ module FacebookAds
|
|
|
346
360
|
field :is_verified, 'bool'
|
|
347
361
|
field :is_webhooks_subscribed, 'bool'
|
|
348
362
|
field :keywords, 'object'
|
|
349
|
-
field :leadgen_form_preview_details, 'LeadGenFormPreviewDetails'
|
|
350
363
|
field :leadgen_tos_acceptance_time, 'datetime'
|
|
351
364
|
field :leadgen_tos_accepted, 'bool'
|
|
352
365
|
field :leadgen_tos_accepting_user, 'User'
|
|
@@ -403,6 +416,7 @@ module FacebookAds
|
|
|
403
416
|
field :store_location_descriptor, 'string'
|
|
404
417
|
field :store_number, 'int'
|
|
405
418
|
field :studio, 'string'
|
|
419
|
+
field :supports_donate_button_in_live_video, 'bool'
|
|
406
420
|
field :supports_instant_articles, 'bool'
|
|
407
421
|
field :talking_about_count, 'int'
|
|
408
422
|
field :unread_message_count, 'int'
|
|
@@ -1281,6 +1295,7 @@ module FacebookAds
|
|
|
1281
1295
|
api.has_param :monitoring_type, { enum: -> { VideoCopyright::MONITORING_TYPE }}
|
|
1282
1296
|
api.has_param :ownership_countries, { list: 'string' }
|
|
1283
1297
|
api.has_param :rule_id, 'string'
|
|
1298
|
+
api.has_param :tags, { list: 'string' }
|
|
1284
1299
|
api.has_param :whitelisted_ids, { list: 'string' }
|
|
1285
1300
|
api.has_param :whitelisted_ig_user_ids, { list: 'string' }
|
|
1286
1301
|
end
|
|
@@ -33,6 +33,7 @@ module FacebookAds
|
|
|
33
33
|
"flights",
|
|
34
34
|
"home_listings",
|
|
35
35
|
"hotels",
|
|
36
|
+
"offer_items",
|
|
36
37
|
"offline_commerce",
|
|
37
38
|
"ticketed_experiences",
|
|
38
39
|
"transactable_items",
|
|
@@ -275,10 +276,12 @@ module FacebookAds
|
|
|
275
276
|
api.has_param :file_name, 'string'
|
|
276
277
|
api.has_param :name, 'string'
|
|
277
278
|
api.has_param :override_type, { enum: -> { ProductFeed::OVERRIDE_TYPE }}
|
|
279
|
+
api.has_param :override_value, 'string'
|
|
278
280
|
api.has_param :quoted_fields_mode, { enum: -> { ProductFeed::QUOTED_FIELDS_MODE }}
|
|
279
281
|
api.has_param :rules, { list: 'string' }
|
|
280
282
|
api.has_param :schedule, 'string'
|
|
281
283
|
api.has_param :update_schedule, 'string'
|
|
284
|
+
api.has_param :whitelisted_properties, { list: 'string' }
|
|
282
285
|
end
|
|
283
286
|
end
|
|
284
287
|
|
|
@@ -91,7 +91,9 @@ module FacebookAds
|
|
|
91
91
|
field :schedule, 'ProductFeedSchedule'
|
|
92
92
|
field :update_schedule, 'ProductFeedSchedule'
|
|
93
93
|
field :feed_type, { enum: -> { FEED_TYPE }}
|
|
94
|
+
field :override_value, 'string'
|
|
94
95
|
field :rules, { list: 'string' }
|
|
96
|
+
field :whitelisted_properties, { list: 'string' }
|
|
95
97
|
|
|
96
98
|
has_edge :automotive_models do |edge|
|
|
97
99
|
edge.get 'AutomotiveModel' do |api|
|
|
@@ -31,12 +31,6 @@ module FacebookAds
|
|
|
31
31
|
field :campaign_active, 'bool'
|
|
32
32
|
field :campaign_started, 'bool'
|
|
33
33
|
field :creative_uploaded, 'bool'
|
|
34
|
-
field :delivered_budget, 'int'
|
|
35
|
-
field :delivered_daily_grp, { list: 'double' }
|
|
36
|
-
field :delivered_daily_impression, { list: 'double' }
|
|
37
|
-
field :delivered_impression, 'int'
|
|
38
|
-
field :delivered_reach, 'int'
|
|
39
|
-
field :delivered_total_impression, 'int'
|
|
40
34
|
field :io_approved, 'bool'
|
|
41
35
|
field :sf_link, 'string'
|
|
42
36
|
has_no_id
|
|
@@ -91,7 +91,6 @@ module FacebookAds
|
|
|
91
91
|
field :external_reach, 'int'
|
|
92
92
|
field :feed_ratio_0000, 'int'
|
|
93
93
|
field :frequency_cap, 'int'
|
|
94
|
-
field :frequency_distribution, { list: 'double' }
|
|
95
94
|
field :frequency_distribution_map, 'map<unsigned int, list<float>>'
|
|
96
95
|
field :frequency_distribution_map_agg, 'map<unsigned int, list<unsigned int>>'
|
|
97
96
|
field :grp_audience_size, 'double'
|
|
@@ -69,6 +69,9 @@ module FacebookAds
|
|
|
69
69
|
# Use only with Search events. A search query made by a user.
|
|
70
70
|
# Example: 'lettuce'.
|
|
71
71
|
attr_accessor :search_string
|
|
72
|
+
|
|
73
|
+
# Custom Properties bag for storing other custom fields
|
|
74
|
+
attr_accessor :custom_properties
|
|
72
75
|
|
|
73
76
|
|
|
74
77
|
# @param [Float] value
|
|
@@ -83,6 +86,7 @@ module FacebookAds
|
|
|
83
86
|
# @param [Integer] num_items
|
|
84
87
|
# @param [String] status
|
|
85
88
|
# @param [String] search_string
|
|
89
|
+
# @param [String] custom_properties
|
|
86
90
|
def initialize(value: nil,
|
|
87
91
|
currency: nil,
|
|
88
92
|
content_name: nil,
|
|
@@ -94,7 +98,8 @@ module FacebookAds
|
|
|
94
98
|
predicted_ltv: nil,
|
|
95
99
|
num_items: nil,
|
|
96
100
|
status: nil,
|
|
97
|
-
search_string: nil
|
|
101
|
+
search_string: nil,
|
|
102
|
+
custom_properties: {})
|
|
98
103
|
|
|
99
104
|
unless value.nil?
|
|
100
105
|
self.value = value
|
|
@@ -132,6 +137,9 @@ module FacebookAds
|
|
|
132
137
|
unless search_string.nil?
|
|
133
138
|
self.search_string = search_string
|
|
134
139
|
end
|
|
140
|
+
unless custom_properties.nil?
|
|
141
|
+
self.custom_properties = custom_properties
|
|
142
|
+
end
|
|
135
143
|
end
|
|
136
144
|
|
|
137
145
|
|
|
@@ -194,6 +202,10 @@ module FacebookAds
|
|
|
194
202
|
if attributes.has_key?(:'search_string')
|
|
195
203
|
self.search_string = attributes[:'search_string']
|
|
196
204
|
end
|
|
205
|
+
|
|
206
|
+
if attributes.has_key?(:'custom_properties')
|
|
207
|
+
self.custom_properties = attributes[:'custom_properties']
|
|
208
|
+
end
|
|
197
209
|
end
|
|
198
210
|
|
|
199
211
|
# Checks equality by comparing each attribute.
|
|
@@ -211,7 +223,8 @@ module FacebookAds
|
|
|
211
223
|
predicted_ltv == o.predicted_ltv &&
|
|
212
224
|
num_items == o.num_items &&
|
|
213
225
|
status == o.status &&
|
|
214
|
-
search_string == o.search_string
|
|
226
|
+
search_string == o.search_string &&
|
|
227
|
+
custom_properties == o.custom_properties
|
|
215
228
|
end
|
|
216
229
|
|
|
217
230
|
# @see the `==` method
|
|
@@ -234,7 +247,8 @@ module FacebookAds
|
|
|
234
247
|
predicted_ltv,
|
|
235
248
|
num_items,
|
|
236
249
|
status,
|
|
237
|
-
search_string
|
|
250
|
+
search_string,
|
|
251
|
+
custom_properties
|
|
238
252
|
].hash
|
|
239
253
|
end
|
|
240
254
|
|
|
@@ -278,12 +292,19 @@ module FacebookAds
|
|
|
278
292
|
unless search_string.nil?
|
|
279
293
|
hash['search_string'] = search_string
|
|
280
294
|
end
|
|
295
|
+
unless custom_properties.nil?
|
|
296
|
+
hash['custom_properties'] = custom_properties
|
|
297
|
+
end
|
|
281
298
|
hash.to_s
|
|
282
299
|
end
|
|
283
300
|
|
|
301
|
+
# Add other custom fields to custom properties.
|
|
302
|
+
def add_custom_property(key, value)
|
|
303
|
+
custom_properties[key] = value;
|
|
304
|
+
end
|
|
284
305
|
|
|
285
306
|
# Normalize input fields to server request format.
|
|
286
|
-
def normalize
|
|
307
|
+
def normalize
|
|
287
308
|
hash = {}
|
|
288
309
|
unless value.nil?
|
|
289
310
|
hash['value'] = value
|
|
@@ -326,9 +347,10 @@ module FacebookAds
|
|
|
326
347
|
end
|
|
327
348
|
hash['contents'] = content_array
|
|
328
349
|
end
|
|
350
|
+
|
|
351
|
+
hash.merge!(custom_properties) unless custom_properties.nil?
|
|
329
352
|
hash
|
|
330
353
|
end
|
|
331
|
-
|
|
332
354
|
end
|
|
333
355
|
end
|
|
334
356
|
end
|
|
@@ -49,66 +49,6 @@ module FacebookAds
|
|
|
49
49
|
edge.get do |api|
|
|
50
50
|
api.has_param :source, { enum: %w{ALL PARTICIPANTS }}
|
|
51
51
|
end
|
|
52
|
-
edge.post do |api|
|
|
53
|
-
api.has_param :aloha_action, 'string'
|
|
54
|
-
api.has_param :android_key_hash, 'string'
|
|
55
|
-
api.has_param :applied_art_data, 'object'
|
|
56
|
-
api.has_param :associated_object_id, 'object'
|
|
57
|
-
api.has_param :attribution_app_id, 'string'
|
|
58
|
-
api.has_param :attribution_app_metadata, 'string'
|
|
59
|
-
api.has_param :audio_duration, 'int'
|
|
60
|
-
api.has_param :audio_type, { enum: %w{FILE_ATTACHMENT VOICE_MESSAGE VOICE_MESSAGE_WITH_TRANSCRIPT }}
|
|
61
|
-
api.has_param :body, 'string'
|
|
62
|
-
api.has_param :broadcast_recipients, 'hash'
|
|
63
|
-
api.has_param :client_tags, 'hash'
|
|
64
|
-
api.has_param :coordinates, 'object'
|
|
65
|
-
api.has_param :copy_attachment, 'string'
|
|
66
|
-
api.has_param :copy_message, 'string'
|
|
67
|
-
api.has_param :customizations, 'hash'
|
|
68
|
-
api.has_param :entry_point, 'string'
|
|
69
|
-
api.has_param :external_attachment_url, 'string'
|
|
70
|
-
api.has_param :image_type, { enum: %w{FILE_ATTACHMENT MESSENGER_CAM TRANSPARENT }}
|
|
71
|
-
api.has_param :ios_bundle_id, 'string'
|
|
72
|
-
api.has_param :is_admin_model_v2_enabled, 'bool'
|
|
73
|
-
api.has_param :is_broadcast, 'bool'
|
|
74
|
-
api.has_param :is_montage, 'bool'
|
|
75
|
-
api.has_param :is_voicemail, 'bool'
|
|
76
|
-
api.has_param :lightweight_action_attachment, 'object'
|
|
77
|
-
api.has_param :link, 'string'
|
|
78
|
-
api.has_param :live_location_attachment, 'object'
|
|
79
|
-
api.has_param :location_attachment, 'object'
|
|
80
|
-
api.has_param :log_info, 'hash'
|
|
81
|
-
api.has_param :mark_read_watermark_timestamp, 'int'
|
|
82
|
-
api.has_param :media, { list: 'string' }
|
|
83
|
-
api.has_param :message_attempt_id, 'string'
|
|
84
|
-
api.has_param :message_source_data, 'object'
|
|
85
|
-
api.has_param :montage_business_platform_data, 'hash'
|
|
86
|
-
api.has_param :montage_frame_style, { enum: %w{no_border }}
|
|
87
|
-
api.has_param :montage_mentions, 'hash'
|
|
88
|
-
api.has_param :montage_overlays, { list: 'hash' }
|
|
89
|
-
api.has_param :montage_reply_data, 'object'
|
|
90
|
-
api.has_param :montage_supported_features, { list: { enum: %w{AUTHOR_IN_PRODUCER_QE_FOR_SMART_REPLIES LIGHTWEIGHT_REPLY SHOW_STORY_IN_MESSENGER_THREAD }} }
|
|
91
|
-
api.has_param :montage_targets, { list: 'string' }
|
|
92
|
-
api.has_param :object_attachment, 'string'
|
|
93
|
-
api.has_param :offline_threading_id, 'string'
|
|
94
|
-
api.has_param :platform_xmd, 'string'
|
|
95
|
-
api.has_param :prng, { list: 'string' }
|
|
96
|
-
api.has_param :proxied_app_id, 'string'
|
|
97
|
-
api.has_param :recipients, { list: 'object' }
|
|
98
|
-
api.has_param :replied_to_message_id, 'string'
|
|
99
|
-
api.has_param :selected_cta_token, 'string'
|
|
100
|
-
api.has_param :shareable_attachment, 'object'
|
|
101
|
-
api.has_param :shown_cta_tokens, { list: 'string' }
|
|
102
|
-
api.has_param :skip_android_hash_check, 'bool'
|
|
103
|
-
api.has_param :story_id, 'object'
|
|
104
|
-
api.has_param :tags, { list: 'string' }
|
|
105
|
-
api.has_param :tid, 'string'
|
|
106
|
-
api.has_param :tracking, 'string'
|
|
107
|
-
api.has_param :ttl, 'int'
|
|
108
|
-
api.has_param :use_existing_group, 'bool'
|
|
109
|
-
api.has_param :video_thumbnail, 'file'
|
|
110
|
-
api.has_param :video_type, { enum: %w{FILE_ATTACHMENT RECORDED_STICKER RECORDED_VIDEO SPEAKING_STICKER VIDEO_MAIL }}
|
|
111
|
-
end
|
|
112
52
|
end
|
|
113
53
|
|
|
114
54
|
end
|
|
@@ -36,11 +36,6 @@ module FacebookAds
|
|
|
36
36
|
"STATUS_ON",
|
|
37
37
|
]
|
|
38
38
|
|
|
39
|
-
RESUME_TYPE = [
|
|
40
|
-
"BOT_ACTION",
|
|
41
|
-
"NATIVE",
|
|
42
|
-
]
|
|
43
|
-
|
|
44
39
|
FILTERING = [
|
|
45
40
|
"ema",
|
|
46
41
|
"groups",
|
|
@@ -52,57 +47,6 @@ module FacebookAds
|
|
|
52
47
|
"generic",
|
|
53
48
|
]
|
|
54
49
|
|
|
55
|
-
SERVICE_TYPE = [
|
|
56
|
-
"AIM",
|
|
57
|
-
"ASK_FM",
|
|
58
|
-
"BBM",
|
|
59
|
-
"BBM_PPID",
|
|
60
|
-
"CYWORLD",
|
|
61
|
-
"EBUDDY",
|
|
62
|
-
"FOURSQUARE",
|
|
63
|
-
"GADU",
|
|
64
|
-
"GITHUB",
|
|
65
|
-
"GROUPWISE",
|
|
66
|
-
"GTALK",
|
|
67
|
-
"HYVES",
|
|
68
|
-
"ICLOUD",
|
|
69
|
-
"ICQ",
|
|
70
|
-
"INSTAGRAM",
|
|
71
|
-
"JABBER",
|
|
72
|
-
"KAKAOTALK",
|
|
73
|
-
"KIK",
|
|
74
|
-
"LINE",
|
|
75
|
-
"LINKED_IN",
|
|
76
|
-
"MAILRU",
|
|
77
|
-
"MEDIUM",
|
|
78
|
-
"MIXI",
|
|
79
|
-
"MSN",
|
|
80
|
-
"MYSPACE",
|
|
81
|
-
"NATEON",
|
|
82
|
-
"OCULUS",
|
|
83
|
-
"OK",
|
|
84
|
-
"ORKUT",
|
|
85
|
-
"OTHERS",
|
|
86
|
-
"PINTEREST",
|
|
87
|
-
"QIP",
|
|
88
|
-
"QQ",
|
|
89
|
-
"REDIFF_BOL",
|
|
90
|
-
"SKYPE",
|
|
91
|
-
"SNAPCHAT",
|
|
92
|
-
"SOUND_CLOUD",
|
|
93
|
-
"SPOTIFY",
|
|
94
|
-
"TUMBLR",
|
|
95
|
-
"TWITCH",
|
|
96
|
-
"TWITTER",
|
|
97
|
-
"VIMEO",
|
|
98
|
-
"VKONTAKTE",
|
|
99
|
-
"WECHAT",
|
|
100
|
-
"WHATSAPP",
|
|
101
|
-
"YAHOO",
|
|
102
|
-
"YAHOO_JP",
|
|
103
|
-
"YOU_TUBE",
|
|
104
|
-
]
|
|
105
|
-
|
|
106
50
|
|
|
107
51
|
field :about, 'string'
|
|
108
52
|
field :address, 'Location'
|
|
@@ -153,6 +97,7 @@ module FacebookAds
|
|
|
153
97
|
field :short_name, 'string'
|
|
154
98
|
field :significant_other, 'User'
|
|
155
99
|
field :sports, { list: 'Experience' }
|
|
100
|
+
field :supports_donate_button_in_live_video, 'bool'
|
|
156
101
|
field :test_group, 'int'
|
|
157
102
|
field :third_party_id, 'string'
|
|
158
103
|
field :timezone, 'double'
|
|
@@ -558,17 +503,6 @@ module FacebookAds
|
|
|
558
503
|
end
|
|
559
504
|
end
|
|
560
505
|
|
|
561
|
-
has_edge :insights do |edge|
|
|
562
|
-
edge.get 'InsightsResult' do |api|
|
|
563
|
-
api.has_param :date_preset, { enum: -> { InsightsResult::DATE_PRESET }}
|
|
564
|
-
api.has_param :metric, { list: 'object' }
|
|
565
|
-
api.has_param :period, { enum: -> { InsightsResult::PERIOD }}
|
|
566
|
-
api.has_param :show_description_from_api_doc, 'bool'
|
|
567
|
-
api.has_param :since, 'datetime'
|
|
568
|
-
api.has_param :until, 'datetime'
|
|
569
|
-
end
|
|
570
|
-
end
|
|
571
|
-
|
|
572
506
|
has_edge :likes do |edge|
|
|
573
507
|
edge.get 'Page' do |api|
|
|
574
508
|
api.has_param :target_id, 'string'
|
|
@@ -616,16 +550,6 @@ module FacebookAds
|
|
|
616
550
|
end
|
|
617
551
|
end
|
|
618
552
|
|
|
619
|
-
has_edge :mfs_account_pin_reset do |edge|
|
|
620
|
-
edge.post 'User' do |api|
|
|
621
|
-
api.has_param :password_token, 'string'
|
|
622
|
-
api.has_param :provider_id, 'string'
|
|
623
|
-
api.has_param :resume_payload, 'string'
|
|
624
|
-
api.has_param :resume_type, { enum: -> { User::RESUME_TYPE }}
|
|
625
|
-
api.has_param :should_bypass_token_proxy, 'bool'
|
|
626
|
-
end
|
|
627
|
-
end
|
|
628
|
-
|
|
629
553
|
has_edge :movies do |edge|
|
|
630
554
|
edge.get 'Page' do |api|
|
|
631
555
|
api.has_param :target_id, 'string'
|
|
@@ -734,14 +658,6 @@ module FacebookAds
|
|
|
734
658
|
end
|
|
735
659
|
end
|
|
736
660
|
|
|
737
|
-
has_edge :posts do |edge|
|
|
738
|
-
edge.get 'Post' do |api|
|
|
739
|
-
api.has_param :include_hidden, 'bool'
|
|
740
|
-
api.has_param :show_expired, 'bool'
|
|
741
|
-
api.has_param :with, { enum: -> { Post::WITH }}
|
|
742
|
-
end
|
|
743
|
-
end
|
|
744
|
-
|
|
745
661
|
has_edge :request_history do |edge|
|
|
746
662
|
edge.get 'RequestHistory'
|
|
747
663
|
end
|
|
@@ -752,13 +668,6 @@ module FacebookAds
|
|
|
752
668
|
end
|
|
753
669
|
end
|
|
754
670
|
|
|
755
|
-
has_edge :screennames do |edge|
|
|
756
|
-
edge.post 'User' do |api|
|
|
757
|
-
api.has_param :service_type, { enum: -> { User::SERVICE_TYPE }}
|
|
758
|
-
api.has_param :value, 'string'
|
|
759
|
-
end
|
|
760
|
-
end
|
|
761
|
-
|
|
762
671
|
has_edge :staging_resources do |edge|
|
|
763
672
|
edge.post 'User' do |api|
|
|
764
673
|
api.has_param :file, 'file'
|
|
@@ -63,7 +63,7 @@ module FacebookAds
|
|
|
63
63
|
api.has_param :language, { list: 'string' }
|
|
64
64
|
api.has_param :name, 'string'
|
|
65
65
|
api.has_param :name_or_content, 'string'
|
|
66
|
-
api.has_param :status, { list: { enum: %w{APPROVED DELETED DISABLED PENDING PENDING_DELETION REJECTED }} }
|
|
66
|
+
api.has_param :status, { list: { enum: %w{APPROVED DELETED DISABLED IN_APPEAL PENDING PENDING_DELETION REJECTED }} }
|
|
67
67
|
end
|
|
68
68
|
edge.post 'WhatsAppBusinessAccount' do |api|
|
|
69
69
|
api.has_param :category, { enum: -> { WhatsAppBusinessAccount::CATEGORY }}
|
data/lib/facebook_ads/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: facebookbusiness
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.6.0.
|
|
4
|
+
version: 0.6.0.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Facebook
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2020-
|
|
11
|
+
date: 2020-03-03 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: faraday
|
|
@@ -336,7 +336,6 @@ files:
|
|
|
336
336
|
- lib/facebook_ads/ad_objects/ads_pixel.rb
|
|
337
337
|
- lib/facebook_ads/ad_objects/ads_pixel_stats.rb
|
|
338
338
|
- lib/facebook_ads/ad_objects/ads_pixel_stats_result.rb
|
|
339
|
-
- lib/facebook_ads/ad_objects/ads_tal_health_check_error.rb
|
|
340
339
|
- lib/facebook_ads/ad_objects/age_range.rb
|
|
341
340
|
- lib/facebook_ads/ad_objects/agency_client_declaration.rb
|
|
342
341
|
- lib/facebook_ads/ad_objects/album.rb
|
|
@@ -461,7 +460,6 @@ files:
|
|
|
461
460
|
- lib/facebook_ads/ad_objects/lead_gen_conditional_questions_group_choices.rb
|
|
462
461
|
- lib/facebook_ads/ad_objects/lead_gen_conditional_questions_group_questions.rb
|
|
463
462
|
- lib/facebook_ads/ad_objects/lead_gen_draft_question.rb
|
|
464
|
-
- lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb
|
|
465
463
|
- lib/facebook_ads/ad_objects/lead_gen_post_submission_check_result.rb
|
|
466
464
|
- lib/facebook_ads/ad_objects/lead_gen_question.rb
|
|
467
465
|
- lib/facebook_ads/ad_objects/lead_gen_question_option.rb
|
|
@@ -1,38 +0,0 @@
|
|
|
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 AdsTalHealthCheckError < AdObject
|
|
29
|
-
|
|
30
|
-
field :error_code, 'int'
|
|
31
|
-
field :target_id, 'string'
|
|
32
|
-
has_no_id
|
|
33
|
-
has_no_get
|
|
34
|
-
has_no_post
|
|
35
|
-
has_no_delete
|
|
36
|
-
|
|
37
|
-
end
|
|
38
|
-
end
|
|
@@ -1,48 +0,0 @@
|
|
|
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 LeadGenFormPreviewDetails < AdObject
|
|
29
|
-
|
|
30
|
-
field :call_to_action_title, 'string'
|
|
31
|
-
field :default_appointment_scheduling_inline_context, 'string'
|
|
32
|
-
field :default_thank_you_page, 'object'
|
|
33
|
-
field :edit_text, 'string'
|
|
34
|
-
field :email_inline_context_text, 'string'
|
|
35
|
-
field :next_button_text, 'string'
|
|
36
|
-
field :personal_info_text, 'string'
|
|
37
|
-
field :phone_number_inline_context_text, 'string'
|
|
38
|
-
field :review_your_info_text, 'string'
|
|
39
|
-
field :secure_sharing_text, 'string'
|
|
40
|
-
field :slide_to_submit_text, 'string'
|
|
41
|
-
field :submit_button_text, 'string'
|
|
42
|
-
has_no_id
|
|
43
|
-
has_no_get
|
|
44
|
-
has_no_post
|
|
45
|
-
has_no_delete
|
|
46
|
-
|
|
47
|
-
end
|
|
48
|
-
end
|