facebookads 0.0.1 → 0.2.9

data/lib/facebook_ads/ad_objects/conversion_action_query.rb

@@ -0,0 +1,63 @@
+# 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 ConversionActionQuery < AdObject
+
+    field :_action_type, { list: 'object' }
+    field :application, { list: 'object' }
+    field :conversion_id, { list: 'string' }
+    field :creative, { list: 'object' }
+    field :dataset, { list: 'string' }
+    field :event, { list: 'string' }
+    field :_event_creator, { list: 'string' }
+    field :event_type, { list: 'string' }
+    field :fb_pixel, { list: 'string' }
+    field :fb_pixel_event, { list: 'string' }
+    field :leadgen, { list: 'string' }
+    field :object, { list: 'string' }
+    field :_object_domain, { list: 'string' }
+    field :offer, { list: 'string' }
+    field :_offer_creator, { list: 'string' }
+    field :offsite_pixel, { list: 'string' }
+    field :page, { list: 'string' }
+    field :_page_parent, { list: 'string' }
+    field :post, { list: 'string' }
+    field :_post_object, { list: 'string' }
+    field :_post_object_wall, { list: 'string' }
+    field :_post_wall, { list: 'string' }
+    field :product_set_id, { list: 'string' }
+    field :question, { list: 'string' }
+    field :_question_creator, { list: 'string' }
+    field :response, { list: 'string' }
+    field :subtype, { list: 'string' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/custom_audience.rb

@@ -0,0 +1,166 @@
+# 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 CustomAudience < AdObject
+    include CustomAudienceHelpers
+    CLAIM_OBJECTIVE = [
+      "HOME_LISTING",
+      "PRODUCT",
+      "TRAVEL",
+    ]
+
+    CONTENT_TYPE = [
+      "DESTINATION",
+      "FLIGHT",
+      "HOTEL",
+      "HOME_LISTING",
+    ]
+
+    SUBTYPE = [
+      "CUSTOM",
+      "WEBSITE",
+      "APP",
+      "OFFLINE_CONVERSION",
+      "CLAIM",
+      "PARTNER",
+      "MANAGED",
+      "VIDEO",
+      "LOOKALIKE",
+      "ENGAGEMENT",
+      "DATA_SET",
+      "BAG_OF_ACCOUNTS",
+      "STUDY_RULE_AUDIENCE",
+    ]
+
+    FIELDS = [
+      "id",
+      "account_id",
+      "approximate_count",
+      "data_source",
+      "delivery_status",
+      "description",
+      "external_event_source",
+      "is_value_based",
+      "lookalike_audience_ids",
+      "lookalike_spec",
+      "name",
+      "operation_status",
+      "opt_out_link",
+      "permission_for_actions",
+      "pixel_id",
+      "retention_days",
+      "rule",
+      "subtype",
+      "time_content_updated",
+      "time_created",
+      "time_updated",
+    ]
+
+
+    field :account_id, 'string'
+    field :approximate_count, 'int'
+    field :data_source, 'CustomAudienceDataSource'
+    field :delivery_status, 'CustomAudienceStatus'
+    field :description, 'string'
+    field :external_event_source, 'AdsPixel'
+    field :id, 'string'
+    field :is_value_based, 'bool'
+    field :lookalike_audience_ids, { list: 'string' }
+    field :lookalike_spec, 'LookalikeSpec'
+    field :name, 'string'
+    field :operation_status, 'CustomAudienceStatus'
+    field :opt_out_link, 'string'
+    field :permission_for_actions, 'CustomAudiencePermission'
+    field :pixel_id, 'string'
+    field :retention_days, 'int'
+    field :rule, 'string'
+    field :rule_aggregation, 'string'
+    field :subtype, 'string'
+    field :time_content_updated, 'int'
+    field :time_created, 'int'
+    field :time_updated, 'int'
+    field :claim_objective, { enum: -> { CLAIM_OBJECTIVE }}
+    field :content_type, { enum: -> { CONTENT_TYPE }}
+    field :dataset_id, 'string'
+    field :event_source_group, 'string'
+    field :list_of_accounts, { list: 'int' }
+    field :origin_audience_id, 'string'
+    field :prefill, 'bool'
+    field :product_set_id, 'string'
+    field :associated_audience_id, 'int'
+    field :creation_params, 'hash'
+    field :exclusions, { list: 'object' }
+    field :inclusions, { list: 'object' }
+    field :parent_audience_id, 'int'
+    field :tags, { list: 'string' }
+
+    has_edge :adaccounts do |edge|
+      edge.delete do |api|
+        api.has_param :adaccounts, { list: 'string' }
+      end
+      edge.get 'AdAccount' do |api|
+        api.has_param :permissions, 'string'
+      end
+      edge.post 'AdAccount' do |api|
+        api.has_param :adaccounts, { list: 'string' }
+        api.has_param :permissions, 'string'
+        api.has_param :replace, 'bool'
+      end
+    end
+
+    has_edge :ads do |edge|
+      edge.get 'Ad' do |api|
+        api.has_param :effective_status, { list: 'string' }
+        api.has_param :status, { list: 'string' }
+      end
+    end
+
+    has_edge :prefills do |edge|
+      edge.get 'CustomAudiencePrefillState'
+    end
+
+    has_edge :sessions do |edge|
+      edge.get 'CustomAudienceSession' do |api|
+        api.has_param :session_id, 'int'
+      end
+    end
+
+    has_edge :users do |edge|
+      edge.delete do |api|
+        api.has_param :namespace, 'string'
+        api.has_param :payload, 'object'
+        api.has_param :session, 'object'
+      end
+      edge.post 'User' do |api|
+        api.has_param :namespace, 'string'
+        api.has_param :payload, 'object'
+        api.has_param :session, 'object'
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/custom_audience_ad_account.rb

@@ -0,0 +1,36 @@
+# 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 CustomAudienceAdAccount < AdObject
+
+    field :id, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb

@@ -0,0 +1,94 @@
+# 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 CustomAudienceDataSource < AdObject
+    SUB_TYPE = [
+      "ANYTHING",
+      "NOTHING",
+      "HASHES",
+      "USER_IDS",
+      "HASHES_OR_USER_IDS",
+      "MOBILE_ADVERTISER_IDS",
+      "EXTERNAL_IDS",
+      "MULTI_HASHES",
+      "TOKENS",
+      "EXTERNAL_IDS_MIX",
+      "WEB_PIXEL_HITS",
+      "MOBILE_APP_EVENTS",
+      "MOBILE_APP_COMBINATION_EVENTS",
+      "VIDEO_EVENTS",
+      "WEB_PIXEL_COMBINATION_EVENTS",
+      "PLATFORM",
+      "ENGAGEMENT_EVENT_USERS",
+      "CUSTOM_AUDIENCE_USERS",
+      "PAGE_FANS",
+      "CONVERSION_PIXEL_HITS",
+      "APP_USERS",
+      "S_EXPR",
+      "DYNAMIC_RULE",
+      "CAMPAIGN_CONVERSIONS",
+      "WEB_PIXEL_HITS_CUSTOM_AUDIENCE_USERS",
+      "MOBILE_APP_CUSTOM_AUDIENCE_USERS",
+      "COMBINATION_CUSTOM_AUDIENCE_USERS",
+      "VIDEO_EVENT_USERS",
+      "FB_PIXEL_HITS",
+      "IG_PROMOTED_POST",
+      "PLACE_VISITS",
+      "OFFLINE_EVENT_USERS",
+      "EXPANDED_AUDIENCE",
+      "SEED_LIST",
+      "PARTNER_CATEGORY_USERS",
+      "PAGE_SMART_AUDIENCE",
+      "MULTICOUNTRY_COMBINATION",
+      "PLATFORM_USERS",
+      "MAIL_CHIMP_EMAIL_HASHES",
+      "CONSTANT_CONTACTS_EMAIL_HASHES",
+      "COPY_PASTE_EMAIL_HASHES",
+      "CONTACT_IMPORTER",
+    ]
+
+    TYPE = [
+      "UNKNOWN",
+      "FILE_IMPORTED",
+      "EVENT_BASED",
+      "SEED_BASED",
+      "THIRD_PARTY_IMPORTED",
+      "COPY_PASTE",
+      "CONTACT_IMPORTER",
+    ]
+
+
+    field :creation_params, 'string'
+    field :sub_type, { enum: -> { SUB_TYPE }}
+    field :type, { enum: -> { TYPE }}
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/custom_audience_permission.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 CustomAudiencePermission < AdObject
+
+    field :can_edit, 'bool'
+    field :can_see_insight, 'bool'
+    field :can_share, 'bool'
+    field :subtype_supports_lookalike, 'bool'
+    field :supports_recipient_lookalike, 'bool'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/custom_audience_prefill_state.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 CustomAudiencePrefillState < AdObject
+
+    field :description, 'string'
+    field :num_added, 'int'
+    field :status, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/custom_audience_session.rb

@@ -0,0 +1,44 @@
+# 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 CustomAudienceSession < AdObject
+
+    field :end_time, 'string'
+    field :num_invalid_entries, 'string'
+    field :num_matched, 'string'
+    field :num_received, 'string'
+    field :progress, 'string'
+    field :session_id, 'string'
+    field :stage, 'string'
+    field :start_time, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end