facebookads 0.0.1 → 0.2.9

data/lib/facebook_ads/ad_objects/ad_async_request_set.rb

@@ -0,0 +1,68 @@
+# 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 AdAsyncRequestSet < AdObject
+    NOTIFICATION_MODE = [
+      "OFF",
+      "ON_COMPLETE",
+    ]
+
+    NOTIFICATION_STATUS = [
+      "NOT_SENT",
+      "SENDING",
+      "SENT",
+    ]
+
+
+    field :canceled_count, 'int'
+    field :created_time, 'datetime'
+    field :error_count, 'int'
+    field :id, 'string'
+    field :in_progress_count, 'int'
+    field :initial_count, 'int'
+    field :is_completed, 'bool'
+    field :name, 'string'
+    field :notification_mode, { enum: -> { NOTIFICATION_MODE }}
+    field :notification_result, 'AdAsyncRequestSetNotificationResult'
+    field :notification_status, { enum: -> { NOTIFICATION_STATUS }}
+    field :notification_uri, 'string'
+    field :owner_id, 'string'
+    field :success_count, 'int'
+    field :total_count, 'int'
+    field :updated_time, 'datetime'
+    field :ad_specs, { list: 'hash' }
+    has_no_post
+    has_no_delete
+
+    has_edge :requests do |edge|
+      edge.get 'AdAsyncRequest' do |api|
+        api.has_param :statuses, { list: { enum: -> { AdAsyncRequest::STATUSES }} }
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_async_request_set_notification_result.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-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 AdAsyncRequestSetNotificationResult < AdObject
+
+    field :response, 'string'
+    field :status, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_creative.rb

@@ -0,0 +1,163 @@
+# 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 AdCreative < AdObject
+    APPLINK_TREATMENT = [
+      "deeplink_with_web_fallback",
+      "deeplink_with_appstore_fallback",
+      "web_only",
+    ]
+
+    CALL_TO_ACTION_TYPE = [
+      "OPEN_LINK",
+      "LIKE_PAGE",
+      "SHOP_NOW",
+      "PLAY_GAME",
+      "INSTALL_APP",
+      "USE_APP",
+      "INSTALL_MOBILE_APP",
+      "USE_MOBILE_APP",
+      "BOOK_TRAVEL",
+      "LISTEN_MUSIC",
+      "LEARN_MORE",
+      "SIGN_UP",
+      "DOWNLOAD",
+      "WATCH_MORE",
+      "NO_BUTTON",
+      "CALL_NOW",
+      "APPLY_NOW",
+      "BUY_NOW",
+      "GET_OFFER",
+      "GET_OFFER_VIEW",
+      "GET_DIRECTIONS",
+      "MESSAGE_PAGE",
+      "MESSAGE_USER",
+      "SUBSCRIBE",
+      "SELL_NOW",
+      "DONATE_NOW",
+      "GET_QUOTE",
+      "CONTACT_US",
+      "RECORD_NOW",
+      "VOTE_NOW",
+      "REGISTER_NOW",
+      "REQUEST_TIME",
+      "SEE_MENU",
+      "OPEN_MOVIES",
+    ]
+
+    OBJECT_TYPE = [
+      "APPLICATION",
+      "DOMAIN",
+      "EVENT",
+      "OFFER",
+      "PAGE",
+      "PHOTO",
+      "SHARE",
+      "STATUS",
+      "STORE_ITEM",
+      "VIDEO",
+      "INVALID",
+    ]
+
+    STATUS = [
+      "ACTIVE",
+      "DELETED",
+    ]
+
+    DYNAMIC_AD_VOICE = [
+      "DYNAMIC",
+      "STORY_OWNER",
+    ]
+
+    OPERATOR = [
+      "ALL",
+      "ANY",
+    ]
+
+
+    field :account_id, 'string'
+    field :actor_id, 'string'
+    field :adlabels, { list: 'AdLabel' }
+    field :applink_treatment, { enum: -> { APPLINK_TREATMENT }}
+    field :body, 'string'
+    field :call_to_action_type, { enum: -> { CALL_TO_ACTION_TYPE }}
+    field :effective_instagram_story_id, 'string'
+    field :effective_object_story_id, 'string'
+    field :id, 'string'
+    field :image_crops, 'AdsImageCrops'
+    field :image_hash, 'string'
+    field :image_url, 'string'
+    field :instagram_actor_id, 'string'
+    field :instagram_permalink_url, 'string'
+    field :instagram_story_id, 'string'
+    field :link_og_id, 'string'
+    field :link_url, 'string'
+    field :name, 'string'
+    field :object_id, 'string'
+    field :object_story_id, 'string'
+    field :object_story_spec, 'AdCreativeObjectStorySpec'
+    field :object_type, { enum: -> { OBJECT_TYPE }}
+    field :object_url, 'string'
+    field :platform_customizations, 'object'
+    field :product_set_id, 'string'
+    field :status, { enum: -> { STATUS }}
+    field :template_url, 'string'
+    field :template_url_spec, 'object'
+    field :thumbnail_url, 'string'
+    field :title, 'string'
+    field :url_tags, 'string'
+    field :use_page_actor_override, 'bool'
+    field :video_id, 'string'
+    field :call_to_action, 'object'
+    field :dynamic_ad_voice, { enum: -> { DYNAMIC_AD_VOICE }}
+    field :image_file, 'string'
+
+    has_edge :adlabels do |edge|
+      edge.delete do |api|
+        api.has_param :adlabels, { list: 'object' }
+      end
+      edge.post 'AdLabel' do |api|
+        api.has_param :adlabels, { list: 'object' }
+      end
+    end
+
+    has_edge :previews do |edge|
+      edge.get 'AdPreview' do |api|
+        api.has_param :ad_format, { enum: -> { AdPreview::AD_FORMAT }}
+        api.has_param :end_date, 'datetime'
+        api.has_param :height, 'int'
+        api.has_param :locale, 'string'
+        api.has_param :place_page_id, 'int'
+        api.has_param :post, 'object'
+        api.has_param :product_item_ids, { list: 'string' }
+        api.has_param :start_date, 'datetime'
+        api.has_param :width, 'int'
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_creative_link_data.rb

@@ -0,0 +1,62 @@
+# 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 AdCreativeLinkData < AdObject
+    ATTACHMENT_STYLE = [
+      "link",
+      "default",
+    ]
+
+
+    field :additional_image_index, 'int'
+    field :app_link_spec, 'AdCreativeLinkDataAppLinkSpec'
+    field :attachment_style, { enum: -> { ATTACHMENT_STYLE }}
+    field :branded_content_sponsor_page_id, 'string'
+    field :branded_content_sponsor_relationship, 'string'
+    field :call_to_action, 'AdCreativeLinkDataCallToAction'
+    field :caption, 'string'
+    field :child_attachments, { list: 'AdCreativeLinkDataChildAttachment' }
+    field :description, 'string'
+    field :event_id, 'string'
+    field :force_single_link, 'bool'
+    field :image_crops, 'AdsImageCrops'
+    field :image_hash, 'string'
+    field :link, 'string'
+    field :message, 'string'
+    field :multi_share_end_card, 'bool'
+    field :multi_share_optimized, 'bool'
+    field :name, 'string'
+    field :offer_id, 'string'
+    field :page_welcome_message, 'string'
+    field :picture, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_creative_link_data_app_link_spec.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 AdCreativeLinkDataAppLinkSpec < AdObject
+
+    field :android, { list: 'AndroidAppLink' }
+    field :ios, { list: 'IosAppLink' }
+    field :ipad, { list: 'IosAppLink' }
+    field :iphone, { list: 'IosAppLink' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb

@@ -0,0 +1,75 @@
+# 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 AdCreativeLinkDataCallToAction < AdObject
+    TYPE = [
+      "OPEN_LINK",
+      "LIKE_PAGE",
+      "SHOP_NOW",
+      "PLAY_GAME",
+      "INSTALL_APP",
+      "USE_APP",
+      "INSTALL_MOBILE_APP",
+      "USE_MOBILE_APP",
+      "BOOK_TRAVEL",
+      "LISTEN_MUSIC",
+      "LEARN_MORE",
+      "SIGN_UP",
+      "DOWNLOAD",
+      "WATCH_MORE",
+      "NO_BUTTON",
+      "CALL_NOW",
+      "APPLY_NOW",
+      "BUY_NOW",
+      "GET_OFFER",
+      "GET_OFFER_VIEW",
+      "GET_DIRECTIONS",
+      "MESSAGE_PAGE",
+      "MESSAGE_USER",
+      "SUBSCRIBE",
+      "SELL_NOW",
+      "DONATE_NOW",
+      "GET_QUOTE",
+      "CONTACT_US",
+      "RECORD_NOW",
+      "VOTE_NOW",
+      "REGISTER_NOW",
+      "REQUEST_TIME",
+      "SEE_MENU",
+      "OPEN_MOVIES",
+    ]
+
+
+    field :type, { enum: -> { TYPE }}
+    field :value, 'AdCreativeLinkDataCallToActionValue'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end