facebookads 0.0.1 → 0.2.9

data/lib/facebook_ads/ad_objects/product_group.rb

@@ -0,0 +1,98 @@
+# 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 ProductGroup < AdObject
+
+    field :id, 'string'
+    field :product_catalog, 'ProductCatalog'
+    field :retailer_id, 'string'
+    field :variants, { list: 'ProductVariant' }
+
+    has_edge :product_sets do |edge|
+      edge.get 'ProductSet'
+    end
+
+    has_edge :products do |edge|
+      edge.get 'ProductItem'
+      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 :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
+
+  end
+end

data/lib/facebook_ads/ad_objects/product_item.rb

@@ -0,0 +1,147 @@
+# 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 ProductItem < AdObject
+    AGE_GROUP = [
+      "adult",
+      "infant",
+      "kids",
+      "newborn",
+      "toddler",
+    ]
+
+    AVAILABILITY = [
+      "in stock",
+      "out of stock",
+      "preorder",
+      "available for order",
+      "discontinued",
+    ]
+
+    CONDITION = [
+      "new",
+      "refurbished",
+      "used",
+    ]
+
+    GENDER = [
+      "female",
+      "male",
+      "unisex",
+    ]
+
+    REVIEW_STATUS = [
+      "",
+      "pending",
+      "rejected",
+      "approved",
+    ]
+
+    SHIPPING_WEIGHT_UNIT = [
+      "g",
+      "kg",
+      "oz",
+      "lb",
+    ]
+
+    VISIBILITY = [
+      "staging",
+      "published",
+    ]
+
+
+    field :additional_image_urls, { list: 'string' }
+    field :age_group, { enum: -> { AGE_GROUP }}
+    field :applinks, 'AppLinks'
+    field :availability, { enum: -> { AVAILABILITY }}
+    field :brand, 'string'
+    field :category, 'string'
+    field :color, 'string'
+    field :commerce_insights, 'ProductItemCommerceInsights'
+    field :condition, { enum: -> { CONDITION }}
+    field :currency, 'string'
+    field :custom_data, { list: 'object' }
+    field :custom_label_0, 'string'
+    field :custom_label_1, 'string'
+    field :custom_label_2, 'string'
+    field :custom_label_3, 'string'
+    field :custom_label_4, 'string'
+    field :description, 'string'
+    field :expiration_date, 'string'
+    field :gender, { enum: -> { GENDER }}
+    field :gtin, 'string'
+    field :id, 'string'
+    field :image_url, 'string'
+    field :manufacturer_part_number, 'string'
+    field :material, 'string'
+    field :name, 'string'
+    field :ordering_index, 'int'
+    field :pattern, 'string'
+    field :price, 'string'
+    field :product_catalog, 'ProductCatalog'
+    field :product_feed, 'ProductFeed'
+    field :product_group, 'ProductGroup'
+    field :product_type, 'string'
+    field :retailer_id, 'string'
+    field :retailer_product_group_id, 'string'
+    field :review_rejection_reasons, { list: 'string' }
+    field :review_status, { enum: -> { REVIEW_STATUS }}
+    field :sale_price, 'string'
+    field :sale_price_end_date, 'string'
+    field :sale_price_start_date, 'string'
+    field :shipping_weight_unit, { enum: -> { SHIPPING_WEIGHT_UNIT }}
+    field :shipping_weight_value, 'double'
+    field :short_description, 'string'
+    field :size, 'string'
+    field :start_date, 'string'
+    field :url, 'string'
+    field :visibility, { enum: -> { VISIBILITY }}
+    field :android_app_name, 'string'
+    field :android_class, 'string'
+    field :android_package, 'string'
+    field :android_url, 'string'
+    field :checkout_url, 'string'
+    field :inventory, 'int'
+    field :ios_app_name, 'string'
+    field :ios_app_store_id, 'int'
+    field :ios_url, 'string'
+    field :ipad_app_name, 'string'
+    field :ipad_app_store_id, 'int'
+    field :ipad_url, 'string'
+    field :iphone_app_name, 'string'
+    field :iphone_app_store_id, 'int'
+    field :iphone_url, 'string'
+    field :windows_phone_app_id, 'int'
+    field :windows_phone_app_name, 'string'
+    field :windows_phone_url, 'string'
+
+    has_edge :product_sets do |edge|
+      edge.get 'ProductSet'
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/product_item_commerce_insights.rb

@@ -0,0 +1,39 @@
+# 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 ProductItemCommerceInsights < AdObject
+
+    field :message_sends, 'int'
+    field :organic_impressions, 'int'
+    field :paid_impressions, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/product_set.rb

@@ -0,0 +1,49 @@
+# 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 ProductSet < AdObject
+
+    field :auto_creation_url, 'string'
+    field :filter, 'string'
+    field :id, 'string'
+    field :name, 'string'
+    field :product_catalog, 'ProductCatalog'
+    field :product_count, 'int'
+
+    has_edge :product_groups do |edge|
+      edge.get 'ProductGroup'
+    end
+
+    has_edge :products do |edge|
+      edge.get 'ProductItem' do |api|
+        api.has_param :bulk_pagination, 'bool'
+        api.has_param :filter, 'object'
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/product_variant.rb

@@ -0,0 +1,39 @@
+# 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 ProductVariant < AdObject
+
+    field :label, 'string'
+    field :options, { list: 'string' }
+    field :product_field, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/profile_picture_source.rb

@@ -0,0 +1,52 @@
+# 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 ProfilePictureSource < AdObject
+    TYPE = [
+      "small",
+      "normal",
+      "album",
+      "large",
+      "square",
+    ]
+
+
+    field :bottom, 'int'
+    field :height, 'int'
+    field :is_silhouette, 'bool'
+    field :left, 'int'
+    field :right, 'int'
+    field :top, 'int'
+    field :url, 'string'
+    field :width, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/rate_card.rb

@@ -0,0 +1,39 @@
+# 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 RateCard < AdObject
+
+    field :country, 'string'
+    field :currency, 'string'
+    field :rate, 'double'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end