facebookbusiness 0.3.2.8 → 0.3.2.9

Sign up to get free protection for your applications and to get access to all the features.
Files changed (105) hide show
  1. checksums.yaml +4 -4
  2. data/lib/facebook_ads/ad_objects/ad.rb +26 -26
  3. data/lib/facebook_ads/ad_objects/ad_account.rb +26 -23
  4. data/lib/facebook_ads/ad_objects/ad_account_creation_request.rb +16 -16
  5. data/lib/facebook_ads/ad_objects/ad_account_default_objective.rb +26 -26
  6. data/lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb +8 -8
  7. data/lib/facebook_ads/ad_objects/ad_account_matched_search_applications_edge_data.rb +7 -7
  8. data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb +176 -176
  9. data/lib/facebook_ads/ad_objects/ad_activity.rb +46 -46
  10. data/lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb +38 -38
  11. data/lib/facebook_ads/ad_objects/ad_async_request.rb +12 -12
  12. data/lib/facebook_ads/ad_objects/ad_campaign_activity.rb +18 -18
  13. data/lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb +8 -8
  14. data/lib/facebook_ads/ad_objects/ad_campaign_group_activity.rb +26 -26
  15. data/lib/facebook_ads/ad_objects/ad_creative.rb +42 -40
  16. data/lib/facebook_ads/ad_objects/ad_creative_link_data.rb +1 -1
  17. data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb +38 -38
  18. data/lib/facebook_ads/ad_objects/ad_creative_link_data_custom_overlay_spec.rb +20 -20
  19. data/lib/facebook_ads/ad_objects/ad_creative_link_data_image_overlay_spec.rb +20 -20
  20. data/lib/facebook_ads/ad_objects/ad_creative_video_data_custom_overlay_spec.rb +9 -9
  21. data/lib/facebook_ads/ad_objects/ad_monetization_property.rb +29 -28
  22. data/lib/facebook_ads/ad_objects/ad_network_analytics_sync_query_result.rb +0 -70
  23. data/lib/facebook_ads/ad_objects/ad_place_page_set.rb +1 -1
  24. data/lib/facebook_ads/ad_objects/ad_promoted_object.rb +19 -19
  25. data/lib/facebook_ads/ad_objects/ad_recommendation.rb +2 -2
  26. data/lib/facebook_ads/ad_objects/ad_report_spec.rb +12 -12
  27. data/lib/facebook_ads/ad_objects/ad_rule.rb +2 -2
  28. data/lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb +3 -3
  29. data/lib/facebook_ads/ad_objects/ad_rule_filters.rb +9 -9
  30. data/lib/facebook_ads/ad_objects/ad_rule_history_result.rb +2 -2
  31. data/lib/facebook_ads/ad_objects/ad_rule_trigger.rb +11 -11
  32. data/lib/facebook_ads/ad_objects/ad_set.rb +35 -35
  33. data/lib/facebook_ads/ad_objects/ad_study_cell.rb +4 -4
  34. data/lib/facebook_ads/ad_objects/ad_study_objective.rb +6 -6
  35. data/lib/facebook_ads/ad_objects/ad_video.rb +84 -85
  36. data/lib/facebook_ads/ad_objects/adgroup_activity.rb +26 -26
  37. data/lib/facebook_ads/ad_objects/ads_insights.rb +23 -25
  38. data/lib/facebook_ads/ad_objects/ads_pixel.rb +6 -6
  39. data/lib/facebook_ads/ad_objects/ads_pixel_stats_result.rb +4 -4
  40. data/lib/facebook_ads/ad_objects/application.rb +47 -46
  41. data/lib/facebook_ads/ad_objects/async_request.rb +4 -4
  42. data/lib/facebook_ads/ad_objects/audio_copyright.rb +1 -1
  43. data/lib/facebook_ads/ad_objects/business.rb +103 -25
  44. data/lib/facebook_ads/ad_objects/business_agreement.rb +1 -1
  45. data/lib/facebook_ads/ad_objects/business_asset_sharing_agreement.rb +1 -1
  46. data/lib/facebook_ads/ad_objects/business_matched_search_applications_edge_data.rb +7 -7
  47. data/lib/facebook_ads/ad_objects/business_owned_object_on_behalf_of_request.rb +1 -1
  48. data/lib/facebook_ads/ad_objects/business_role_request.rb +4 -4
  49. data/lib/facebook_ads/ad_objects/business_user.rb +3 -3
  50. data/lib/facebook_ads/ad_objects/campaign.rb +21 -21
  51. data/lib/facebook_ads/ad_objects/check_batch_request_status.rb +2 -0
  52. data/lib/facebook_ads/ad_objects/comment.rb +3 -3
  53. data/lib/facebook_ads/ad_objects/cpas_parent_catalog_settings.rb +4 -4
  54. data/lib/facebook_ads/ad_objects/custom_audience.rb +13 -13
  55. data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb +46 -46
  56. data/lib/facebook_ads/ad_objects/custom_conversion.rb +7 -7
  57. data/lib/facebook_ads/ad_objects/entity_at_text_range.rb +3 -3
  58. data/lib/facebook_ads/ad_objects/event.rb +19 -19
  59. data/lib/facebook_ads/ad_objects/extended_credit_allocation_config.rb +3 -3
  60. data/lib/facebook_ads/ad_objects/favorite_request.rb +4 -4
  61. data/lib/facebook_ads/ad_objects/group.rb +85 -85
  62. data/lib/facebook_ads/ad_objects/insights_result.rb +11 -11
  63. data/lib/facebook_ads/ad_objects/instagram_insights_result.rb +8 -8
  64. data/lib/facebook_ads/ad_objects/instagram_user.rb +0 -1
  65. data/lib/facebook_ads/ad_objects/instant_article_insights_query_result.rb +6 -6
  66. data/lib/facebook_ads/ad_objects/lead_gen_data_draft.rb +11 -11
  67. data/lib/facebook_ads/ad_objects/leadgen_form.rb +11 -11
  68. data/lib/facebook_ads/ad_objects/live_video.rb +15 -15
  69. data/lib/facebook_ads/ad_objects/measurement_report.rb +4 -4
  70. data/lib/facebook_ads/ad_objects/measurement_upload_event.rb +36 -2
  71. data/lib/facebook_ads/ad_objects/media_fingerprint.rb +5 -5
  72. data/lib/facebook_ads/ad_objects/native_offer.rb +6 -6
  73. data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb +6 -6
  74. data/lib/facebook_ads/ad_objects/page.rb +101 -85
  75. data/lib/facebook_ads/ad_objects/page_call_to_action.rb +25 -25
  76. data/lib/facebook_ads/ad_objects/page_post.rb +11 -11
  77. data/lib/facebook_ads/ad_objects/page_saved_filter.rb +81 -80
  78. data/lib/facebook_ads/ad_objects/partner_integration_linked.rb +5 -5
  79. data/lib/facebook_ads/ad_objects/permission.rb +1 -1
  80. data/lib/facebook_ads/ad_objects/photo.rb +7 -7
  81. data/lib/facebook_ads/ad_objects/post.rb +5 -5
  82. data/lib/facebook_ads/ad_objects/product_catalog.rb +34 -3
  83. data/lib/facebook_ads/ad_objects/product_da_event_samples_batch.rb +4 -4
  84. data/lib/facebook_ads/ad_objects/product_event_stat.rb +4 -4
  85. data/lib/facebook_ads/ad_objects/product_feed.rb +6 -6
  86. data/lib/facebook_ads/ad_objects/product_feed_rule.rb +3 -3
  87. data/lib/facebook_ads/ad_objects/product_feed_schedule.rb +6 -6
  88. data/lib/facebook_ads/ad_objects/product_feed_upload.rb +1 -1
  89. data/lib/facebook_ads/ad_objects/product_item.rb +9 -9
  90. data/lib/facebook_ads/ad_objects/profile.rb +8 -8
  91. data/lib/facebook_ads/ad_objects/profile_picture_source.rb +2 -2
  92. data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb +11 -10
  93. data/lib/facebook_ads/ad_objects/request_history.rb +1 -1
  94. data/lib/facebook_ads/ad_objects/saved_message_response.rb +5 -5
  95. data/lib/facebook_ads/ad_objects/streaming_reaction.rb +5 -5
  96. data/lib/facebook_ads/ad_objects/system_user.rb +3 -3
  97. data/lib/facebook_ads/ad_objects/targeting.rb +4 -4
  98. data/lib/facebook_ads/ad_objects/unified_thread.rb +1 -1
  99. data/lib/facebook_ads/ad_objects/user.rb +55 -72
  100. data/lib/facebook_ads/ad_objects/vehicle.rb +75 -0
  101. data/lib/facebook_ads/ad_objects/video_copyright.rb +1 -1
  102. data/lib/facebook_ads/ad_objects/video_game_show.rb +1 -1
  103. data/lib/facebook_ads/ad_objects/video_poll.rb +2 -2
  104. data/lib/facebook_ads/version.rb +1 -1
  105. metadata +2 -2
@@ -27,8 +27,8 @@ module FacebookAds
27
27
 
28
28
  class AdPlacePageSet < AdObject
29
29
  LOCATION_TYPES = [
30
- "recent",
31
30
  "home",
31
+ "recent",
32
32
  ]
33
33
 
34
34
  TARGETED_AREA_TYPE = [
@@ -27,34 +27,34 @@ module FacebookAds
27
27
 
28
28
  class AdPromotedObject < AdObject
29
29
  CUSTOM_EVENT_TYPE = [
30
- "RATE",
31
- "TUTORIAL_COMPLETION",
30
+ "ACHIEVEMENT_UNLOCKED",
31
+ "ADD_PAYMENT_INFO",
32
+ "ADD_TO_CART",
33
+ "ADD_TO_WISHLIST",
34
+ "COMPLETE_REGISTRATION",
32
35
  "CONTACT",
36
+ "CONTENT_VIEW",
33
37
  "CUSTOMIZE_PRODUCT",
38
+ "D2_RETENTION",
39
+ "D7_RETENTION",
34
40
  "DONATE",
35
41
  "FIND_LOCATION",
36
- "SCHEDULE",
37
- "START_TRIAL",
38
- "SUBMIT_APPLICATION",
39
- "SUBSCRIBE",
40
- "ADD_TO_CART",
41
- "ADD_TO_WISHLIST",
42
42
  "INITIATED_CHECKOUT",
43
- "ADD_PAYMENT_INFO",
44
- "PURCHASE",
45
43
  "LEAD",
46
- "COMPLETE_REGISTRATION",
47
- "CONTENT_VIEW",
48
- "SEARCH",
49
- "SERVICE_BOOKING_REQUEST",
50
- "MESSAGING_CONVERSATION_STARTED_7D",
51
44
  "LEVEL_ACHIEVED",
52
- "ACHIEVEMENT_UNLOCKED",
53
- "SPENT_CREDITS",
54
45
  "LISTING_INTERACTION",
55
- "D2_RETENTION",
56
- "D7_RETENTION",
46
+ "MESSAGING_CONVERSATION_STARTED_7D",
57
47
  "OTHER",
48
+ "PURCHASE",
49
+ "RATE",
50
+ "SCHEDULE",
51
+ "SEARCH",
52
+ "SERVICE_BOOKING_REQUEST",
53
+ "SPENT_CREDITS",
54
+ "START_TRIAL",
55
+ "SUBMIT_APPLICATION",
56
+ "SUBSCRIBE",
57
+ "TUTORIAL_COMPLETION",
58
58
  ]
59
59
 
60
60
 
@@ -28,14 +28,14 @@ module FacebookAds
28
28
  class AdRecommendation < AdObject
29
29
  CONFIDENCE = [
30
30
  "HIGH",
31
- "MEDIUM",
32
31
  "LOW",
32
+ "MEDIUM",
33
33
  ]
34
34
 
35
35
  IMPORTANCE = [
36
36
  "HIGH",
37
- "MEDIUM",
38
37
  "LOW",
38
+ "MEDIUM",
39
39
  ]
40
40
 
41
41
 
@@ -31,6 +31,7 @@ module FacebookAds
31
31
  "action_canvas_component_name",
32
32
  "action_carousel_card_id",
33
33
  "action_carousel_card_name",
34
+ "action_converted_product_id",
34
35
  "action_destination",
35
36
  "action_device",
36
37
  "action_event_channel",
@@ -38,42 +39,41 @@ module FacebookAds
38
39
  "action_type",
39
40
  "action_video_sound",
40
41
  "action_video_type",
41
- "action_converted_product_id",
42
42
  "interactive_component_sticker_id",
43
43
  "interactive_component_sticker_response",
44
44
  ]
45
45
 
46
46
  CREATION_SOURCE = [
47
+ "adsExcelAddin",
47
48
  "adsManagerReporting",
48
49
  "newAdsManager",
49
- "adsExcelAddin",
50
50
  ]
51
51
 
52
52
  DATE_PRESET = [
53
- "today",
54
- "yesterday",
55
- "this_month",
56
- "last_month",
57
- "this_quarter",
58
- "lifetime",
59
- "last_3d",
60
- "last_7d",
61
53
  "last_14d",
62
54
  "last_28d",
63
55
  "last_30d",
56
+ "last_3d",
57
+ "last_7d",
64
58
  "last_90d",
59
+ "last_month",
60
+ "last_quarter",
65
61
  "last_week_mon_sun",
66
62
  "last_week_sun_sat",
67
- "last_quarter",
68
63
  "last_year",
64
+ "lifetime",
65
+ "this_month",
66
+ "this_quarter",
69
67
  "this_week_mon_today",
70
68
  "this_week_sun_today",
71
69
  "this_year",
70
+ "today",
71
+ "yesterday",
72
72
  ]
73
73
 
74
74
  FORMAT = [
75
- "JSON",
76
75
  "CSV",
76
+ "JSON",
77
77
  "XLS",
78
78
  "XLSX",
79
79
  ]
@@ -27,9 +27,9 @@ module FacebookAds
27
27
 
28
28
  class AdRule < AdObject
29
29
  STATUS = [
30
- "ENABLED",
31
- "DISABLED",
32
30
  "DELETED",
31
+ "DISABLED",
32
+ "ENABLED",
33
33
  ]
34
34
 
35
35
 
@@ -27,12 +27,12 @@ module FacebookAds
27
27
 
28
28
  class AdRuleExecutionSpec < AdObject
29
29
  EXECUTION_TYPE = [
30
- "PING_ENDPOINT",
30
+ "CHANGE_BID",
31
+ "CHANGE_BUDGET",
31
32
  "NOTIFICATION",
32
33
  "PAUSE",
34
+ "PING_ENDPOINT",
33
35
  "REBALANCE_BUDGET",
34
- "CHANGE_BUDGET",
35
- "CHANGE_BID",
36
36
  "ROTATE",
37
37
  "UNPAUSE",
38
38
  ]
@@ -27,19 +27,19 @@ module FacebookAds
27
27
 
28
28
  class AdRuleFilters < AdObject
29
29
  OPERATOR = [
30
+ "ALL",
31
+ "ANY",
32
+ "CONTAIN",
33
+ "EQUAL",
30
34
  "GREATER_THAN",
35
+ "IN",
36
+ "IN_RANGE",
31
37
  "LESS_THAN",
32
- "EQUAL",
38
+ "NONE",
39
+ "NOT_CONTAIN",
33
40
  "NOT_EQUAL",
34
- "IN_RANGE",
35
- "NOT_IN_RANGE",
36
- "IN",
37
41
  "NOT_IN",
38
- "CONTAIN",
39
- "NOT_CONTAIN",
40
- "ANY",
41
- "ALL",
42
- "NONE",
42
+ "NOT_IN_RANGE",
43
43
  ]
44
44
 
45
45
 
@@ -27,9 +27,9 @@ module FacebookAds
27
27
 
28
28
  class AdRuleHistoryResult < AdObject
29
29
  OBJECT_TYPE = [
30
- "CAMPAIGN",
31
- "ADSET",
32
30
  "AD",
31
+ "ADSET",
32
+ "CAMPAIGN",
33
33
  ]
34
34
 
35
35
 
@@ -27,27 +27,27 @@ module FacebookAds
27
27
 
28
28
  class AdRuleTrigger < AdObject
29
29
  OPERATOR = [
30
+ "ALL",
31
+ "ANY",
32
+ "CONTAIN",
33
+ "EQUAL",
30
34
  "GREATER_THAN",
35
+ "IN",
36
+ "IN_RANGE",
31
37
  "LESS_THAN",
32
- "EQUAL",
38
+ "NONE",
39
+ "NOT_CONTAIN",
33
40
  "NOT_EQUAL",
34
- "IN_RANGE",
35
- "NOT_IN_RANGE",
36
- "IN",
37
41
  "NOT_IN",
38
- "CONTAIN",
39
- "NOT_CONTAIN",
40
- "ANY",
41
- "ALL",
42
- "NONE",
42
+ "NOT_IN_RANGE",
43
43
  ]
44
44
 
45
45
  TYPE = [
46
+ "DELIVERY_INSIGHTS_CHANGE",
46
47
  "METADATA_CREATION",
47
48
  "METADATA_UPDATE",
48
- "STATS_MILESTONE",
49
49
  "STATS_CHANGE",
50
- "DELIVERY_INSIGHTS_CHANGE",
50
+ "STATS_MILESTONE",
51
51
  ]
52
52
 
53
53
 
@@ -41,105 +41,105 @@ module FacebookAds
41
41
  "OFFER_CLAIMS",
42
42
  "PAGE_LIKES",
43
43
  "POST_ENGAGEMENT",
44
- "VIDEO_VIEWS",
45
44
  "THRUPLAY",
45
+ "VIDEO_VIEWS",
46
46
  ]
47
47
 
48
48
  CONFIGURED_STATUS = [
49
49
  "ACTIVE",
50
- "PAUSED",
51
- "DELETED",
52
50
  "ARCHIVED",
51
+ "DELETED",
52
+ "PAUSED",
53
53
  ]
54
54
 
55
55
  EFFECTIVE_STATUS = [
56
56
  "ACTIVE",
57
- "PAUSED",
57
+ "ADSET_PAUSED",
58
+ "ARCHIVED",
59
+ "CAMPAIGN_PAUSED",
58
60
  "DELETED",
59
- "PENDING_REVIEW",
60
61
  "DISAPPROVED",
61
- "PREAPPROVED",
62
+ "PAUSED",
62
63
  "PENDING_BILLING_INFO",
63
- "CAMPAIGN_PAUSED",
64
- "ARCHIVED",
65
- "ADSET_PAUSED",
64
+ "PENDING_REVIEW",
65
+ "PREAPPROVED",
66
66
  "WITH_ISSUES",
67
67
  ]
68
68
 
69
69
  OPTIMIZATION_GOAL = [
70
- "NONE",
70
+ "AD_RECALL_LIFT",
71
+ "APP_DOWNLOADS",
71
72
  "APP_INSTALLS",
72
73
  "BRAND_AWARENESS",
73
- "AD_RECALL_LIFT",
74
74
  "CLICKS",
75
+ "DERIVED_EVENTS",
75
76
  "ENGAGED_USERS",
76
77
  "EVENT_RESPONSES",
77
78
  "IMPRESSIONS",
79
+ "LANDING_PAGE_VIEWS",
78
80
  "LEAD_GENERATION",
79
81
  "LINK_CLICKS",
82
+ "NONE",
80
83
  "OFFER_CLAIMS",
81
84
  "OFFSITE_CONVERSIONS",
82
85
  "PAGE_ENGAGEMENT",
83
86
  "PAGE_LIKES",
84
87
  "POST_ENGAGEMENT",
85
88
  "REACH",
89
+ "REPLIES",
86
90
  "SOCIAL_IMPRESSIONS",
87
- "VIDEO_VIEWS",
88
- "APP_DOWNLOADS",
91
+ "THRUPLAY",
89
92
  "TWO_SECOND_CONTINUOUS_VIDEO_VIEWS",
90
- "LANDING_PAGE_VIEWS",
91
93
  "VALUE",
92
- "THRUPLAY",
93
- "REPLIES",
94
- "DERIVED_EVENTS",
94
+ "VIDEO_VIEWS",
95
95
  ]
96
96
 
97
97
  STATUS = [
98
98
  "ACTIVE",
99
- "PAUSED",
100
- "DELETED",
101
99
  "ARCHIVED",
100
+ "DELETED",
101
+ "PAUSED",
102
102
  ]
103
103
 
104
104
  DATE_PRESET = [
105
- "today",
106
- "yesterday",
107
- "this_month",
108
- "last_month",
109
- "this_quarter",
110
- "lifetime",
111
- "last_3d",
112
- "last_7d",
113
105
  "last_14d",
114
106
  "last_28d",
115
107
  "last_30d",
108
+ "last_3d",
109
+ "last_7d",
116
110
  "last_90d",
111
+ "last_month",
112
+ "last_quarter",
117
113
  "last_week_mon_sun",
118
114
  "last_week_sun_sat",
119
- "last_quarter",
120
115
  "last_year",
116
+ "lifetime",
117
+ "this_month",
118
+ "this_quarter",
121
119
  "this_week_mon_today",
122
120
  "this_week_sun_today",
123
121
  "this_year",
122
+ "today",
123
+ "yesterday",
124
124
  ]
125
125
 
126
126
  DESTINATION_TYPE = [
127
- "UNDEFINED",
128
- "WEBSITE",
129
127
  "APP",
130
- "MESSENGER",
131
128
  "APPLINKS_AUTOMATIC",
129
+ "MESSENGER",
130
+ "UNDEFINED",
131
+ "WEBSITE",
132
132
  ]
133
133
 
134
134
  EXECUTION_OPTIONS = [
135
- "validate_only",
136
135
  "include_recommendations",
136
+ "validate_only",
137
137
  ]
138
138
 
139
139
  FULL_FUNNEL_EXPLORATION_MODE = [
140
- "NONE_EXPLORATION",
141
- "LIMITED_EXPLORATION",
142
140
  "EXTENDED_EXPLORATION",
141
+ "LIMITED_EXPLORATION",
142
+ "NONE_EXPLORATION",
143
143
  ]
144
144
 
145
145
  OPERATOR = [
@@ -149,8 +149,8 @@ module FacebookAds
149
149
 
150
150
  STATUS_OPTION = [
151
151
  "ACTIVE",
152
- "PAUSED",
153
152
  "INHERITED_FROM_SOURCE",
153
+ "PAUSED",
154
154
  ]
155
155
 
156
156
 
@@ -34,17 +34,17 @@ module FacebookAds
34
34
  "FACEBOOK_INSTAGRAM",
35
35
  "FACEBOOK_NEWS_FEED",
36
36
  "FACEBOOK_NEWS_FEED_IN_STREAM_VIDEO",
37
- "IN_STREAM_VIDEO",
37
+ "HIGH_FREQUENCY",
38
38
  "INSTAGRAM",
39
+ "IN_STREAM_VIDEO",
40
+ "LOW_FREQUENCY",
41
+ "MEDIUM_FREQUENCY",
39
42
  "MOBILE_OPTIMIZED_VIDEO",
40
43
  "PAGE_POST_ENGAGEMENT",
41
44
  "REACH",
42
45
  "TV_COMMERCIAL",
43
46
  "TV_FACEBOOK",
44
47
  "VIDEO_VIEW_OPTIMIZATION",
45
- "LOW_FREQUENCY",
46
- "MEDIUM_FREQUENCY",
47
- "HIGH_FREQUENCY",
48
48
  ]
49
49
 
50
50
 
@@ -27,15 +27,15 @@ module FacebookAds
27
27
 
28
28
  class AdStudyObjective < AdObject
29
29
  TYPE = [
30
- "SALES",
31
- "NONSALES",
32
- "MAE",
33
- "TELCO",
30
+ "BRAND",
31
+ "BRANDLIFT",
34
32
  "FTL",
33
+ "MAE",
35
34
  "MAI",
35
+ "NONSALES",
36
36
  "PARTNER",
37
- "BRANDLIFT",
38
- "BRAND",
37
+ "SALES",
38
+ "TELCO",
39
39
  ]
40
40
 
41
41