facebookads 0.0.1 → 0.2.9

data/lib/facebook_ads/ad_objects/minimum_budget.rb

@@ -0,0 +1,41 @@
+# 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-genereated.
+
+  # 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 MinimumBudget < AdObject
+
+    field :currency, 'string'
+    field :min_daily_budget_high_freq, 'int'
+    field :min_daily_budget_imp, 'int'
+    field :min_daily_budget_low_freq, 'int'
+    field :min_daily_budget_video_views, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/offsite_pixel.rb

@@ -0,0 +1,57 @@
+# 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-genereated.
+
+  # 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 OffsitePixel < AdObject
+    TAG = [
+      "CHECKOUT",
+      "REGISTRATION",
+      "LEAD",
+      "KEY_PAGE_VIEW",
+      "ADD_TO_CART",
+      "OTHER",
+    ]
+
+
+    field :creator, 'string'
+    field :id, 'string'
+    field :js_pixel, 'string'
+    field :last_firing_time, 'datetime'
+    field :name, 'string'
+    field :tag, 'string'
+
+    has_edge :adaccounts do |edge|
+      edge.delete do |api|
+        api.has_param :adaccounts, { list: 'string' }
+      end
+      edge.get 'AdAccount'
+      edge.post 'AdAccount' do |api|
+        api.has_param :adaccounts, { list: 'string' }
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/outcome_prediction_point.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-genereated.
+
+  # 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 OutcomePredictionPoint < AdObject
+
+    field :actions, 'double'
+    field :impressions, 'double'
+    field :reach, 'double'
+    field :spend, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/partner_category.rb

@@ -0,0 +1,51 @@
+# 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-genereated.
+
+  # 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 PartnerCategory < AdObject
+    PRIVATE_OR_PUBLIC = [
+      "PRIVATE",
+      "PUBLIC",
+    ]
+
+
+    field :approximate_count, 'int'
+    field :country, 'string'
+    field :description, 'string'
+    field :details, 'string'
+    field :id, 'string'
+    field :is_private, 'bool'
+    field :name, 'string'
+    field :parent_category, 'string'
+    field :source, 'string'
+    field :status, 'string'
+    field :targeting_type, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/product_catalog.rb

@@ -0,0 +1,257 @@
+# 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-genereated.
+
+  # 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 ProductCatalog < AdObject
+    VERTICAL = [
+      "commerce",
+      "destinations",
+      "flights",
+      "hotels",
+    ]
+
+
+    field :business, 'Business'
+    field :da_display_settings, 'ProductCatalogImageSettings'
+    field :default_image_url, 'string'
+    field :fallback_image_url, { list: 'string' }
+    field :feed_count, 'int'
+    field :id, 'string'
+    field :image_padding_landscape, 'bool'
+    field :image_padding_square, 'bool'
+    field :name, 'string'
+    field :product_count, 'int'
+    field :vertical, 'string'
+
+    has_edge :agencies do |edge|
+      edge.get 'Business'
+    end
+
+    has_edge :destinations do |edge|
+      edge.get do |api|
+        api.has_param :bulk_pagination, 'bool'
+        api.has_param :filter, 'object'
+      end
+    end
+
+    has_edge :external_event_sources do |edge|
+      edge.delete do |api|
+        api.has_param :external_event_sources, { list: 'string' }
+      end
+      edge.get 'ExternalEventSource'
+      edge.post 'ExternalEventSource' do |api|
+        api.has_param :external_event_sources, { list: 'string' }
+      end
+    end
+
+    has_edge :flights do |edge|
+      edge.get do |api|
+        api.has_param :bulk_pagination, 'bool'
+        api.has_param :filter, 'object'
+      end
+    end
+
+    has_edge :hotel_rooms_batch do |edge|
+      edge.get 'ProductCatalogHotelRoomsBatch' do |api|
+        api.has_param :handle, 'string'
+      end
+      edge.post 'ProductCatalogHotelRoomsBatch' do |api|
+        api.has_param :file, 'file'
+        api.has_param :password, 'string'
+        api.has_param :standard, { enum: -> { ProductCatalogHotelRoomsBatch::STANDARD }}
+        api.has_param :update_only, 'bool'
+        api.has_param :url, 'string'
+        api.has_param :username, 'string'
+      end
+    end
+
+    has_edge :hotels do |edge|
+      edge.get 'Hotel' do |api|
+        api.has_param :bulk_pagination, 'bool'
+        api.has_param :filter, 'object'
+      end
+      edge.post 'Hotel' do |api|
+        api.has_param :address, 'object'
+        api.has_param :applinks, 'object'
+        api.has_param :brand, 'string'
+        api.has_param :description, 'string'
+        api.has_param :guest_ratings, { list: 'object' }
+        api.has_param :hotel_id, 'string'
+        api.has_param :images, { list: 'object' }
+        api.has_param :name, 'string'
+        api.has_param :phone, 'string'
+        api.has_param :star_rating, 'double'
+        api.has_param :url, 'string'
+      end
+    end
+
+    has_edge :pricing_variables_batch do |edge|
+      edge.get 'ProductCatalogPricingVariablesBatch' do |api|
+        api.has_param :handle, 'string'
+      end
+      edge.post 'ProductCatalogPricingVariablesBatch' do |api|
+        api.has_param :file, 'file'
+        api.has_param :password, 'string'
+        api.has_param :standard, { enum: -> { ProductCatalogPricingVariablesBatch::STANDARD }}
+        api.has_param :update_only, 'bool'
+        api.has_param :url, 'string'
+        api.has_param :username, 'string'
+      end
+    end
+
+    has_edge :product_feeds do |edge|
+      edge.get 'ProductFeed'
+      edge.post 'ProductFeed' do |api|
+        api.has_param :country, 'string'
+        api.has_param :default_currency, 'string'
+        api.has_param :deletion_enabled, 'bool'
+        api.has_param :delimiter, { enum: -> { ProductFeed::DELIMITER }}
+        api.has_param :encoding, { enum: -> { ProductFeed::ENCODING }}
+        api.has_param :file_name, 'string'
+        api.has_param :name, 'string'
+        api.has_param :quoted_fields_mode, { enum: -> { ProductFeed::QUOTED_FIELDS_MODE }}
+        api.has_param :schedule, 'string'
+      end
+    end
+
+    has_edge :product_groups do |edge|
+      edge.get 'ProductGroup'
+      edge.post 'ProductGroup' do |api|
+        api.has_param :retailer_id, 'string'
+        api.has_param :variants, { list: 'object' }
+      end
+    end
+
+    has_edge :product_sets do |edge|
+      edge.get 'ProductSet' do |api|
+        api.has_param :ancestor_id, 'string'
+        api.has_param :has_children, 'bool'
+        api.has_param :parent_id, 'string'
+        api.has_param :retailer_id, 'string'
+      end
+      edge.post 'ProductSet' do |api|
+        api.has_param :filter, 'object'
+        api.has_param :name, 'string'
+      end
+    end
+
+    has_edge :product_sets_batch do |edge|
+      edge.get do |api|
+        api.has_param :handle, 'string'
+      end
+    end
+
+    has_edge :products do |edge|
+      edge.get 'ProductItem' do |api|
+        api.has_param :bulk_pagination, 'bool'
+        api.has_param :filter, 'object'
+      end
+      edge.post 'ProductItem' do |api|
+        api.has_param :additional_image_urls, { list: 'string' }
+        api.has_param :android_app_name, 'string'
+        api.has_param :android_class, 'string'
+        api.has_param :android_package, 'string'
+        api.has_param :android_url, 'string'
+        api.has_param :availability, { enum: -> { ProductItem::AVAILABILITY }}
+        api.has_param :brand, 'string'
+        api.has_param :category, 'string'
+        api.has_param :checkout_url, 'string'
+        api.has_param :color, 'string'
+        api.has_param :condition, { enum: -> { ProductItem::CONDITION }}
+        api.has_param :currency, 'string'
+        api.has_param :custom_data, 'hash'
+        api.has_param :custom_label_0, 'string'
+        api.has_param :custom_label_1, 'string'
+        api.has_param :custom_label_2, 'string'
+        api.has_param :custom_label_3, 'string'
+        api.has_param :custom_label_4, 'string'
+        api.has_param :description, 'string'
+        api.has_param :expiration_date, 'string'
+        api.has_param :gender, { enum: -> { ProductItem::GENDER }}
+        api.has_param :gtin, 'string'
+        api.has_param :image_url, 'string'
+        api.has_param :inventory, 'int'
+        api.has_param :ios_app_name, 'string'
+        api.has_param :ios_app_store_id, 'int'
+        api.has_param :ios_url, 'string'
+        api.has_param :ipad_app_name, 'string'
+        api.has_param :ipad_app_store_id, 'int'
+        api.has_param :ipad_url, 'string'
+        api.has_param :iphone_app_name, 'string'
+        api.has_param :iphone_app_store_id, 'int'
+        api.has_param :iphone_url, 'string'
+        api.has_param :manufacturer_part_number, 'string'
+        api.has_param :material, 'string'
+        api.has_param :name, 'string'
+        api.has_param :ordering_index, 'int'
+        api.has_param :pattern, 'string'
+        api.has_param :price, 'int'
+        api.has_param :product_type, 'string'
+        api.has_param :retailer_id, 'string'
+        api.has_param :retailer_product_group_id, 'string'
+        api.has_param :sale_price, 'int'
+        api.has_param :sale_price_end_date, 'datetime'
+        api.has_param :sale_price_start_date, 'datetime'
+        api.has_param :short_description, 'string'
+        api.has_param :size, 'string'
+        api.has_param :start_date, 'string'
+        api.has_param :url, 'string'
+        api.has_param :visibility, { enum: -> { ProductItem::VISIBILITY }}
+        api.has_param :windows_phone_app_id, 'int'
+        api.has_param :windows_phone_app_name, 'string'
+        api.has_param :windows_phone_url, 'string'
+      end
+    end
+
+    has_edge :videos do |edge|
+      edge.post do |api|
+        api.has_param :content_category, { enum: %w{BEAUTY_FASHION BUSINESS CARS_TRUCKS COMEDY CUTE_ANIMALS ENTERTAINMENT FAMILY FOOD_HEALTH HOME LIFESTYLE MUSIC NEWS POLITICS SCIENCE SPORTS TECHNOLOGY VIDEO_GAMING OTHER }}
+        api.has_param :description, 'string'
+        api.has_param :embeddable, 'bool'
+        api.has_param :file_size, 'int'
+        api.has_param :file_url, 'string'
+        api.has_param :fov, 'int'
+        api.has_param :initial_heading, 'int'
+        api.has_param :initial_pitch, 'int'
+        api.has_param :original_projection_type, { enum: %w{equirectangular cubemap }}
+        api.has_param :referenced_sticker_id, 'string'
+        api.has_param :replace_video_id, 'string'
+        api.has_param :slideshow_spec, 'hash'
+        api.has_param :source, 'string'
+        api.has_param :spherical, 'bool'
+        api.has_param :start_offset, 'int'
+        api.has_param :swap_mode, { enum: %w{replace }}
+        api.has_param :thumb, 'file'
+        api.has_param :title, 'string'
+        api.has_param :unpublished_content_type, { enum: %w{SCHEDULED DRAFT ADS_POST }}
+        api.has_param :upload_phase, { enum: %w{start transfer finish cancel }}
+        api.has_param :upload_session_id, 'string'
+        api.has_param :video_file_chunk, 'string'
+      end
+    end
+
+  end
+end