facebookbusiness 0.7.0.0 → 0.7.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.rb +0 -1
- data/lib/facebook_ads/ad_objects/ad_account.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_account_creation_request.rb +0 -1
- data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_activity.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_creative.rb +1 -3
- data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_network_analytics_sync_query_result.rb +1 -0
- data/lib/facebook_ads/ad_objects/ad_preview.rb +2 -0
- data/lib/facebook_ads/ad_objects/ad_video.rb +1 -0
- data/lib/facebook_ads/ad_objects/adgroup_activity.rb +4 -4
- data/lib/facebook_ads/ad_objects/ads_insights.rb +5 -0
- data/lib/facebook_ads/ad_objects/album.rb +7 -0
- data/lib/facebook_ads/ad_objects/business.rb +20 -1
- data/lib/facebook_ads/ad_objects/{video_game_show.rb → business_agreement.rb} +10 -6
- data/lib/facebook_ads/ad_objects/business_image.rb +1 -0
- data/lib/facebook_ads/ad_objects/business_owned_object_on_behalf_of_request.rb +1 -0
- data/lib/facebook_ads/ad_objects/business_role_request.rb +1 -0
- data/lib/facebook_ads/ad_objects/business_user.rb +1 -0
- data/lib/facebook_ads/ad_objects/campaign.rb +1 -0
- data/lib/facebook_ads/ad_objects/comment.rb +1 -0
- data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb +99 -0
- data/lib/facebook_ads/ad_objects/{request_history.rb → commerce_merchant_settings_setup_status.rb} +6 -14
- data/lib/facebook_ads/ad_objects/commerce_order.rb +147 -0
- data/lib/facebook_ads/ad_objects/commerce_order_transaction_detail.rb +48 -0
- data/lib/facebook_ads/ad_objects/{custom_audience_prefill_state.rb → commerce_payout.rb} +5 -3
- data/lib/facebook_ads/ad_objects/cpas_parent_catalog_settings.rb +1 -0
- data/lib/facebook_ads/ad_objects/custom_audience.rb +1 -4
- data/lib/facebook_ads/ad_objects/custom_conversion.rb +1 -0
- data/lib/facebook_ads/ad_objects/ig_user.rb +1 -0
- data/lib/facebook_ads/ad_objects/life_event.rb +0 -4
- data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb +0 -6
- data/lib/facebook_ads/ad_objects/page.rb +41 -16
- data/lib/facebook_ads/ad_objects/page_call_to_action.rb +5 -0
- data/lib/facebook_ads/ad_objects/page_post.rb +8 -0
- data/lib/facebook_ads/ad_objects/post.rb +9 -1
- data/lib/facebook_ads/ad_objects/product_catalog.rb +8 -0
- data/lib/facebook_ads/ad_objects/{product_feed_upload_diagnostics.rb → product_feed_upload_diagnostics_report.rb} +2 -2
- data/lib/facebook_ads/ad_objects/profile.rb +1 -0
- data/lib/facebook_ads/ad_objects/server_side/user_data.rb +6 -0
- data/lib/facebook_ads/ad_objects/streaming_reaction.rb +1 -0
- data/lib/facebook_ads/ad_objects/system_user.rb +1 -0
- data/lib/facebook_ads/ad_objects/user.rb +0 -12
- data/lib/facebook_ads/ad_objects/whats_app_business_account.rb +4 -0
- data/lib/facebook_ads/version.rb +1 -1
- metadata +9 -7
- data/lib/facebook_ads/ad_objects/open_graph_object.rb +0 -70
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 20ef851cac669750e7aba58e6120cbd85343bffed78446722ed6991910b30f08
|
4
|
+
data.tar.gz: 2ed325e1cd2b5422a94e5347e1bba6da3de332e0ab8b15b2f6f1619ff5077b23
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 71701986ff59c11781aa63283d700eb460b022bb2e050525ff81eebcc903eb1a0538b9ae497cc487e441f0f3b0e8f9b32486934d9a2286a7d9f68048ee5c76bd
|
7
|
+
data.tar.gz: d69460340c74263dd3226f35ee92294dd29c0852aa1a6ded399b042b35f861159fe76f848a442b27e112c7d6dbb2e99483ca8516cdf5f8e68917c9e65330e790
|
@@ -123,7 +123,6 @@ module FacebookAds
|
|
123
123
|
field :engagement_audience, 'bool'
|
124
124
|
field :failed_delivery_checks, { list: 'DeliveryCheck' }
|
125
125
|
field :id, 'string'
|
126
|
-
field :is_autobid, 'bool'
|
127
126
|
field :issues_info, { list: 'AdgroupIssuesInfo' }
|
128
127
|
field :last_updated_by_app_id, 'string'
|
129
128
|
field :name, 'string'
|
@@ -47,7 +47,6 @@ module FacebookAds
|
|
47
47
|
field :id, 'string'
|
48
48
|
field :is_smb, 'bool'
|
49
49
|
field :is_test, 'bool'
|
50
|
-
field :is_under_authorization, 'bool'
|
51
50
|
field :legal_entity_name_in_local_language, 'string'
|
52
51
|
field :oe_request_id, 'string'
|
53
52
|
field :official_website_url, 'string'
|
@@ -134,6 +134,7 @@ module FacebookAds
|
|
134
134
|
"industries",
|
135
135
|
"instagram_hashtags",
|
136
136
|
"instagram_positions",
|
137
|
+
"instream_video_skippable_excluded",
|
137
138
|
"instream_video_sponsorship_placements",
|
138
139
|
"interest_defaults_source",
|
139
140
|
"interested_in",
|
@@ -204,6 +205,7 @@ module FacebookAds
|
|
204
205
|
"POST_ENGAGEMENT",
|
205
206
|
"PRODUCT_CATALOG_SALES",
|
206
207
|
"REACH",
|
208
|
+
"STORE_VISITS",
|
207
209
|
"VIDEO_VIEWS",
|
208
210
|
]
|
209
211
|
|
@@ -93,6 +93,7 @@ module FacebookAds
|
|
93
93
|
"update_audience",
|
94
94
|
"update_campaign_ad_scheduling",
|
95
95
|
"update_campaign_budget",
|
96
|
+
"update_campaign_budget_optimization_toggling_status",
|
96
97
|
"update_campaign_delivery_type",
|
97
98
|
"update_campaign_duration",
|
98
99
|
"update_campaign_group_ad_scheduling",
|
@@ -50,6 +50,7 @@ module FacebookAds
|
|
50
50
|
"FIND_A_GROUP",
|
51
51
|
"FIND_YOUR_GROUPS",
|
52
52
|
"FOLLOW_NEWS_STORYLINE",
|
53
|
+
"FOLLOW_PAGE",
|
53
54
|
"FOLLOW_USER",
|
54
55
|
"GET_DIRECTIONS",
|
55
56
|
"GET_OFFER",
|
@@ -210,9 +211,6 @@ module FacebookAds
|
|
210
211
|
field :is_dco_internal, 'bool'
|
211
212
|
|
212
213
|
has_edge :adlabels do |edge|
|
213
|
-
edge.delete do |api|
|
214
|
-
api.has_param :adlabels, { list: 'object' }
|
215
|
-
end
|
216
214
|
edge.post 'AdCreative' do |api|
|
217
215
|
api.has_param :adlabels, { list: 'object' }
|
218
216
|
end
|
@@ -40,6 +40,7 @@ module FacebookAds
|
|
40
40
|
"INSTANT_ARTICLE_RECIRCULATION_AD",
|
41
41
|
"INSTANT_ARTICLE_STANDARD",
|
42
42
|
"INSTREAM_VIDEO_DESKTOP",
|
43
|
+
"INSTREAM_VIDEO_IMAGE",
|
43
44
|
"INSTREAM_VIDEO_MOBILE",
|
44
45
|
"JOB_BROWSER_DESKTOP",
|
45
46
|
"JOB_BROWSER_MOBILE",
|
@@ -56,6 +57,7 @@ module FacebookAds
|
|
56
57
|
"RIGHT_COLUMN_STANDARD",
|
57
58
|
"SUGGESTED_VIDEO_DESKTOP",
|
58
59
|
"SUGGESTED_VIDEO_MOBILE",
|
60
|
+
"WATCH_FEED_HOME",
|
59
61
|
"WATCH_FEED_MOBILE",
|
60
62
|
]
|
61
63
|
|
@@ -69,8 +69,8 @@ module FacebookAds
|
|
69
69
|
]
|
70
70
|
|
71
71
|
|
72
|
-
field :ad_creative_id_new, '
|
73
|
-
field :ad_creative_id_old, '
|
72
|
+
field :ad_creative_id_new, 'AdCreative'
|
73
|
+
field :ad_creative_id_old, 'AdCreative'
|
74
74
|
field :asset_feed_id_new, 'string'
|
75
75
|
field :asset_feed_id_old, 'string'
|
76
76
|
field :bid_amount_new, 'int'
|
@@ -105,8 +105,8 @@ module FacebookAds
|
|
105
105
|
field :reason_old, 'string'
|
106
106
|
field :run_status_new, 'string'
|
107
107
|
field :run_status_old, 'string'
|
108
|
-
field :source_adgroup_id_new, '
|
109
|
-
field :source_adgroup_id_old, '
|
108
|
+
field :source_adgroup_id_new, 'Ad'
|
109
|
+
field :source_adgroup_id_old, 'Ad'
|
110
110
|
field :start_time_new, 'datetime'
|
111
111
|
field :start_time_old, 'datetime'
|
112
112
|
field :stop_time_new, 'datetime'
|
@@ -33,6 +33,7 @@ module FacebookAds
|
|
33
33
|
"28d_view",
|
34
34
|
"7d_click",
|
35
35
|
"7d_view",
|
36
|
+
"dda",
|
36
37
|
"default",
|
37
38
|
]
|
38
39
|
|
@@ -152,6 +153,10 @@ module FacebookAds
|
|
152
153
|
field :campaign_name, 'string'
|
153
154
|
field :canvas_avg_view_percent, 'string'
|
154
155
|
field :canvas_avg_view_time, 'string'
|
156
|
+
field :catalog_segment_value, { list: 'AdsActionStats' }
|
157
|
+
field :catalog_segment_value_mobile_purchase_roas, { list: 'AdsActionStats' }
|
158
|
+
field :catalog_segment_value_omni_purchase_roas, { list: 'AdsActionStats' }
|
159
|
+
field :catalog_segment_value_website_purchase_roas, { list: 'AdsActionStats' }
|
155
160
|
field :clicks, 'string'
|
156
161
|
field :conversion_rate_ranking, 'string'
|
157
162
|
field :conversion_values, { list: 'AdsActionStats' }
|
@@ -78,6 +78,7 @@ module FacebookAds
|
|
78
78
|
end
|
79
79
|
|
80
80
|
has_edge :likes do |edge|
|
81
|
+
edge.get 'Profile'
|
81
82
|
edge.post 'Album' do |api|
|
82
83
|
api.has_param :feedback_source, 'string'
|
83
84
|
api.has_param :nectar_module, 'string'
|
@@ -151,6 +152,12 @@ module FacebookAds
|
|
151
152
|
end
|
152
153
|
end
|
153
154
|
|
155
|
+
has_edge :reactions do |edge|
|
156
|
+
edge.get 'Profile' do |api|
|
157
|
+
api.has_param :type, { enum: -> { Profile::TYPE }}
|
158
|
+
end
|
159
|
+
end
|
160
|
+
|
154
161
|
has_edge :sharedposts do |edge|
|
155
162
|
edge.get 'Post'
|
156
163
|
end
|
@@ -302,6 +302,10 @@ module FacebookAds
|
|
302
302
|
edge.get 'Business'
|
303
303
|
end
|
304
304
|
|
305
|
+
has_edge :commerce_merchant_settings do |edge|
|
306
|
+
edge.get 'CommerceMerchantSettings'
|
307
|
+
end
|
308
|
+
|
305
309
|
has_edge :content_delivery_report do |edge|
|
306
310
|
edge.get 'ContentDeliveryReport' do |api|
|
307
311
|
api.has_param :end_date, 'datetime'
|
@@ -375,6 +379,13 @@ module FacebookAds
|
|
375
379
|
end
|
376
380
|
end
|
377
381
|
|
382
|
+
has_edge :initiated_sharing_agreements do |edge|
|
383
|
+
edge.get 'BusinessAgreement' do |api|
|
384
|
+
api.has_param :receiving_business_id, 'string'
|
385
|
+
api.has_param :request_status, { enum: -> { BusinessAgreement::REQUEST_STATUS }}
|
386
|
+
end
|
387
|
+
end
|
388
|
+
|
378
389
|
has_edge :instagram_accounts do |edge|
|
379
390
|
edge.delete do |api|
|
380
391
|
api.has_param :instagram_account, 'string'
|
@@ -458,7 +469,6 @@ module FacebookAds
|
|
458
469
|
edge.get 'Page'
|
459
470
|
edge.post 'Business' do |api|
|
460
471
|
api.has_param :code, 'string'
|
461
|
-
api.has_param :ig_password, 'string'
|
462
472
|
api.has_param :page_id, 'int'
|
463
473
|
end
|
464
474
|
end
|
@@ -470,10 +480,12 @@ module FacebookAds
|
|
470
480
|
has_edge :owned_product_catalogs do |edge|
|
471
481
|
edge.get 'ProductCatalog'
|
472
482
|
edge.post 'ProductCatalog' do |api|
|
483
|
+
api.has_param :commerce_merchant_settings, 'object'
|
473
484
|
api.has_param :da_display_settings, 'object'
|
474
485
|
api.has_param :destination_catalog_settings, 'hash'
|
475
486
|
api.has_param :flight_catalog_settings, 'hash'
|
476
487
|
api.has_param :name, 'string'
|
488
|
+
api.has_param :onsite_commerce_merchant, 'object'
|
477
489
|
api.has_param :store_catalog_settings, 'hash'
|
478
490
|
api.has_param :vertical, { enum: -> { ProductCatalog::VERTICAL }}
|
479
491
|
end
|
@@ -535,6 +547,13 @@ module FacebookAds
|
|
535
547
|
end
|
536
548
|
end
|
537
549
|
|
550
|
+
has_edge :received_sharing_agreements do |edge|
|
551
|
+
edge.get 'BusinessAgreement' do |api|
|
552
|
+
api.has_param :request_status, { enum: -> { BusinessAgreement::REQUEST_STATUS }}
|
553
|
+
api.has_param :requesting_business_id, 'string'
|
554
|
+
end
|
555
|
+
end
|
556
|
+
|
538
557
|
has_edge :system_users do |edge|
|
539
558
|
edge.get 'SystemUser'
|
540
559
|
edge.post 'SystemUser' do |api|
|
@@ -25,14 +25,18 @@ module FacebookAds
|
|
25
25
|
# on github and we'll fix in our codegen framework. We'll not be able to accept
|
26
26
|
# pull request for this class.
|
27
27
|
|
28
|
-
class
|
28
|
+
class BusinessAgreement < AdObject
|
29
|
+
REQUEST_STATUS = [
|
30
|
+
"APPROVE",
|
31
|
+
"DECLINE",
|
32
|
+
"EXPIRED",
|
33
|
+
"IN_PROGRESS",
|
34
|
+
"PENDING",
|
35
|
+
]
|
36
|
+
|
29
37
|
|
30
|
-
field :end_time, 'datetime'
|
31
|
-
field :game_status, 'string'
|
32
|
-
field :game_type, 'string'
|
33
38
|
field :id, 'string'
|
34
|
-
field :
|
35
|
-
has_no_post
|
39
|
+
field :request_status, 'string'
|
36
40
|
has_no_delete
|
37
41
|
|
38
42
|
end
|
@@ -0,0 +1,99 @@
|
|
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 CommerceMerchantSettings < AdObject
|
29
|
+
MERCHANT_STATUS = [
|
30
|
+
"ENABLED",
|
31
|
+
"EXTERNALLY_DISABLED",
|
32
|
+
]
|
33
|
+
|
34
|
+
|
35
|
+
field :braintree_merchant_id, 'string'
|
36
|
+
field :checkout_message, 'string'
|
37
|
+
field :contact_email, 'string'
|
38
|
+
field :disable_checkout_urls, 'bool'
|
39
|
+
field :display_name, 'string'
|
40
|
+
field :facebook_channel, 'object'
|
41
|
+
field :has_discount_code, 'bool'
|
42
|
+
field :id, 'string'
|
43
|
+
field :instagram_channel, 'object'
|
44
|
+
field :merchant_alert_email, 'string'
|
45
|
+
field :merchant_page, 'Profile'
|
46
|
+
field :merchant_status, 'string'
|
47
|
+
field :onsite_commerce_merchant, 'object'
|
48
|
+
field :payment_provider, 'string'
|
49
|
+
field :privacy_url_by_locale, 'hash'
|
50
|
+
field :review_rejection_messages, { list: 'string' }
|
51
|
+
field :review_rejection_reasons, { list: 'string' }
|
52
|
+
field :review_status, 'string'
|
53
|
+
field :supported_card_types, { list: 'string' }
|
54
|
+
field :terms, 'string'
|
55
|
+
field :terms_url_by_locale, 'hash'
|
56
|
+
has_no_delete
|
57
|
+
|
58
|
+
has_edge :facebook_channel do |edge|
|
59
|
+
edge.post 'CommerceMerchantSettings' do |api|
|
60
|
+
api.has_param :pages, { list: 'string' }
|
61
|
+
end
|
62
|
+
end
|
63
|
+
|
64
|
+
has_edge :instagram_channel do |edge|
|
65
|
+
edge.delete
|
66
|
+
edge.post 'CommerceMerchantSettings' do |api|
|
67
|
+
api.has_param :instagram_business_accounts, { list: 'string' }
|
68
|
+
api.has_param :instagram_users, { list: 'string' }
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
has_edge :order_management_apps do |edge|
|
73
|
+
edge.get 'Application'
|
74
|
+
edge.post 'CommerceMerchantSettings'
|
75
|
+
end
|
76
|
+
|
77
|
+
has_edge :product_catalogs do |edge|
|
78
|
+
edge.get 'ProductCatalog'
|
79
|
+
end
|
80
|
+
|
81
|
+
has_edge :returns do |edge|
|
82
|
+
edge.get do |api|
|
83
|
+
api.has_param :end_time_created, 'datetime'
|
84
|
+
api.has_param :merchant_return_id, 'string'
|
85
|
+
api.has_param :start_time_created, 'datetime'
|
86
|
+
api.has_param :statuses, { list: { enum: %w{APPROVED DISAPPROVED MERCHANT_MARKED_COMPLETED REFUNDED REQUESTED }} }
|
87
|
+
end
|
88
|
+
end
|
89
|
+
|
90
|
+
has_edge :setup_status do |edge|
|
91
|
+
edge.get 'CommerceMerchantSettingsSetupStatus'
|
92
|
+
end
|
93
|
+
|
94
|
+
has_edge :tax_settings do |edge|
|
95
|
+
edge.get
|
96
|
+
end
|
97
|
+
|
98
|
+
end
|
99
|
+
end
|
data/lib/facebook_ads/ad_objects/{request_history.rb → commerce_merchant_settings_setup_status.rb}
RENAMED
@@ -25,21 +25,13 @@ 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
|
29
|
-
HTTP_METHOD = [
|
30
|
-
"DELETE",
|
31
|
-
"GET",
|
32
|
-
"POST",
|
33
|
-
]
|
28
|
+
class CommerceMerchantSettingsSetupStatus < AdObject
|
34
29
|
|
35
|
-
|
36
|
-
field :
|
37
|
-
field :
|
38
|
-
field :
|
39
|
-
field :
|
40
|
-
field :http_method, { enum: -> { HTTP_METHOD }}
|
41
|
-
field :post_params, 'hash'
|
42
|
-
field :query_params, 'hash'
|
30
|
+
field :deals_setup, 'string'
|
31
|
+
field :marketplace_approval_status, 'string'
|
32
|
+
field :marketplace_approval_status_details, 'object'
|
33
|
+
field :payment_setup, 'string'
|
34
|
+
field :shop_setup, 'string'
|
43
35
|
has_no_id
|
44
36
|
has_no_get
|
45
37
|
has_no_post
|