facebookbusiness 0.3.0.1

data/lib/facebook_ads/ad_objects/ad_study.rb

@@ -0,0 +1,104 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class AdStudy < AdObject
+    AUDIENCE_TYPE = [
+      "MOST_RESPONSIVE",
+      "NOT_MOST_RESPONSIVE",
+    ]
+
+    ROLE = [
+      "ADMIN",
+      "ANALYST",
+    ]
+
+    TYPE = [
+      "LIFT",
+      "SPLIT_TEST",
+    ]
+
+
+    field :business, 'Business'
+    field :canceled_time, 'datetime'
+    field :cooldown_start_time, 'datetime'
+    field :created_by, 'User'
+    field :created_time, 'datetime'
+    field :description, 'string'
+    field :end_time, 'datetime'
+    field :id, 'string'
+    field :name, 'string'
+    field :observation_end_time, 'datetime'
+    field :start_time, 'datetime'
+    field :type, 'string'
+    field :updated_by, 'User'
+    field :updated_time, 'datetime'
+    field :cells, { list: 'object' }
+    field :client_business, 'string'
+    field :confidence_level, 'double'
+    field :objectives, { list: 'object' }
+    field :viewers, { list: 'int' }
+    has_no_delete
+
+    has_edge :customaudiences do |edge|
+      edge.post 'AdStudy' do |api|
+        api.has_param :account_id, 'string'
+        api.has_param :audience_name, 'string'
+        api.has_param :audience_type, { enum: -> { AdStudy::AUDIENCE_TYPE }}
+        api.has_param :cell_id, 'string'
+        api.has_param :objective_id, 'string'
+      end
+    end
+
+    has_edge :objectives do |edge|
+      edge.post 'AdStudyObjective' do |api|
+        api.has_param :adspixels, { list: 'object' }
+        api.has_param :applications, { list: 'object' }
+        api.has_param :customconversions, { list: 'object' }
+        api.has_param :is_primary, 'bool'
+        api.has_param :name, 'string'
+        api.has_param :offline_conversion_data_sets, { list: 'object' }
+        api.has_param :offsitepixels, { list: 'object' }
+        api.has_param :type, { enum: -> { AdStudyObjective::TYPE }}
+      end
+    end
+
+    has_edge :userpermissions do |edge|
+      edge.delete do |api|
+        api.has_param :business, 'string'
+        api.has_param :email, 'string'
+        api.has_param :user, 'int'
+      end
+      edge.post 'AdStudy' do |api|
+        api.has_param :business, 'string'
+        api.has_param :email, 'string'
+        api.has_param :role, { enum: -> { AdStudy::ROLE }}
+        api.has_param :user, 'int'
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_study_ads_asset_user_permissions.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class AdStudyAdsAssetUserPermissions < AdObject
+
+    field :business, 'Business'
+    field :business_persona, 'object'
+    field :created_by, 'User'
+    field :created_time, 'datetime'
+    field :email, 'string'
+    field :role, 'string'
+    field :status, 'string'
+    field :updated_by, 'User'
+    field :updated_time, 'datetime'
+    field :user, 'User'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_study_cell.rb

@@ -0,0 +1,59 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class AdStudyCell < AdObject
+    CREATION_TEMPLATE = [
+      "AUTOMATIC_PLACEMENTS",
+      "BRAND_AWARENESS",
+      "FACEBOOK",
+      "FACEBOOK_AUDIENCE_NETWORK",
+      "FACEBOOK_INSTAGRAM",
+      "FACEBOOK_NEWS_FEED",
+      "FACEBOOK_NEWS_FEED_IN_STREAM_VIDEO",
+      "IN_STREAM_VIDEO",
+      "INSTAGRAM",
+      "MOBILE_OPTIMIZED_VIDEO",
+      "PAGE_POST_ENGAGEMENT",
+      "REACH",
+      "TV_COMMERCIAL",
+      "TV_FACEBOOK",
+      "VIDEO_VIEW_OPTIMIZATION",
+      "LOW_FREQUENCY",
+      "MEDIUM_FREQUENCY",
+      "HIGH_FREQUENCY",
+    ]
+
+
+    field :ad_entities_count, 'int'
+    field :control_percentage, 'double'
+    field :id, 'string'
+    field :name, 'string'
+    field :treatment_percentage, 'double'
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_study_objective.rb

@@ -0,0 +1,58 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class AdStudyObjective < AdObject
+    BREAKDOWNS = [
+      "age",
+      "cell_id",
+      "gender",
+      "country",
+    ]
+
+    TYPE = [
+      "SALES",
+      "NONSALES",
+      "MAE",
+      "TELCO",
+      "FTL",
+      "MAI",
+      "PARTNER",
+      "BRANDLIFT",
+      "BRAND",
+    ]
+
+
+    field :custom_attributes, { list: 'string' }
+    field :id, 'string'
+    field :is_primary, 'bool'
+    field :last_updated_results, 'string'
+    field :name, 'string'
+    field :results, { list: 'string' }
+    field :type, 'string'
+
+  end
+end

data/lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb

@@ -0,0 +1,50 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class AdgroupPlacementSpecificReviewFeedback < AdObject
+
+    field :account_admin, 'hash'
+    field :ad, 'hash'
+    field :b2c, 'hash'
+    field :bsg, 'hash'
+    field :city_community, 'hash'
+    field :dpa, 'hash'
+    field :facebook, 'hash'
+    field :instagram, 'hash'
+    field :instagram_shop, 'hash'
+    field :marketplace, 'hash'
+    field :page_admin, 'hash'
+    field :product, 'hash'
+    field :product_service, 'hash'
+    field :seller, 'hash'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/adgroup_relevance_score.rb

@@ -0,0 +1,40 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class AdgroupRelevanceScore < AdObject
+
+    field :negative_feedback, 'string'
+    field :positive_feedback, 'string'
+    field :score, 'string'
+    field :status, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/adgroup_review_feedback.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class AdgroupReviewFeedback < AdObject
+
+    field :global, 'hash'
+    field :placement_specific, 'AdgroupPlacementSpecificReviewFeedback'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ads_action_stats.rb

@@ -0,0 +1,55 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class AdsActionStats < AdObject
+
+    field :_1d_click, 'string'
+    field :_1d_view, 'string'
+    field :_28d_click, 'string'
+    field :_28d_view, 'string'
+    field :_7d_click, 'string'
+    field :_7d_view, 'string'
+    field :action_canvas_component_name, 'string'
+    field :action_carousel_card_id, 'string'
+    field :action_carousel_card_name, 'string'
+    field :action_destination, 'string'
+    field :action_device, 'string'
+    field :action_link_click_destination, 'string'
+    field :action_reaction, 'string'
+    field :action_target_id, 'string'
+    field :action_type, 'string'
+    field :action_video_sound, 'string'
+    field :action_video_type, 'string'
+    field :inline, 'string'
+    field :value, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end