facebookads 0.0.1 → 0.2.9

data/lib/facebook_ads/ad_objects/ad_account_roas.rb

@@ -0,0 +1,97 @@
+# 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 AdAccountRoas < AdObject
+    FIELDS = [
+      "adgroup_id",
+      "arpu_180d",
+      "arpu_1d",
+      "arpu_30d",
+      "arpu_365d",
+      "arpu_3d",
+      "arpu_7d",
+      "arpu_90d",
+      "campaign_group_id",
+      "campaign_id",
+      "date_start",
+      "date_stop",
+      "installs",
+      "revenue",
+      "revenue_180d",
+      "revenue_1d",
+      "revenue_30d",
+      "revenue_365d",
+      "revenue_3d",
+      "revenue_7d",
+      "revenue_90d",
+      "spend",
+      "yield_180d",
+      "yield_1d",
+      "yield_30d",
+      "yield_365d",
+      "yield_3d",
+      "yield_7d",
+      "yield_90d",
+    ]
+
+
+    field :adgroup_id, 'string'
+    field :arpu_180d, 'double'
+    field :arpu_1d, 'double'
+    field :arpu_30d, 'double'
+    field :arpu_365d, 'double'
+    field :arpu_3d, 'double'
+    field :arpu_7d, 'double'
+    field :arpu_90d, 'double'
+    field :campaign_group_id, 'string'
+    field :campaign_id, 'string'
+    field :date_start, 'string'
+    field :date_stop, 'string'
+    field :installs, 'int'
+    field :revenue, 'double'
+    field :revenue_180d, 'double'
+    field :revenue_1d, 'double'
+    field :revenue_30d, 'double'
+    field :revenue_365d, 'double'
+    field :revenue_3d, 'double'
+    field :revenue_7d, 'double'
+    field :revenue_90d, 'double'
+    field :spend, 'double'
+    field :yield_180d, 'double'
+    field :yield_1d, 'double'
+    field :yield_30d, 'double'
+    field :yield_365d, 'double'
+    field :yield_3d, 'double'
+    field :yield_7d, 'double'
+    field :yield_90d, 'double'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb

@@ -0,0 +1,136 @@
+# 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 AdAccountTargetingUnified < AdObject
+    LIMIT_TYPE = [
+      "adgroup_id",
+      "genders",
+      "age_min",
+      "age_max",
+      "country_groups",
+      "countries",
+      "country",
+      "cities",
+      "radius",
+      "regions",
+      "zips",
+      "interests",
+      "keywords",
+      "education_schools",
+      "education_majors",
+      "work_positions",
+      "work_employers",
+      "relationship_statuses",
+      "interested_in",
+      "locales",
+      "user_adclusters",
+      "excluded_user_adclusters",
+      "conjunctive_user_adclusters",
+      "custom_audiences",
+      "excluded_custom_audiences",
+      "college_years",
+      "education_statuses",
+      "connections",
+      "excluded_connections",
+      "friends_of_connections",
+      "user_event",
+      "dynamic_audience_ids",
+      "excluded_dynamic_audience_ids",
+      "rtb_flag",
+      "site_category",
+      "geo_locations",
+      "excluded_geo_locations",
+      "timezones",
+      "place_page_set_ids",
+      "page_types",
+      "publisher_platforms",
+      "effective_publisher_platforms",
+      "facebook_positions",
+      "effective_facebook_positions",
+      "instagram_positions",
+      "effective_instagram_positions",
+      "messenger_positions",
+      "effective_messenger_positions",
+      "device_platforms",
+      "effective_device_platforms",
+      "audience_network_positions",
+      "effective_audience_network_positions",
+      "excluded_publisher_categories",
+      "excluded_publisher_list_ids",
+      "excluded_publisher_domains",
+      "publisher_visibility_categories",
+      "user_device",
+      "mobile_device_model",
+      "excluded_user_device",
+      "excluded_mobile_device_model",
+      "user_os",
+      "wireless_carrier",
+      "family_statuses",
+      "industries",
+      "life_events",
+      "political_views",
+      "politics",
+      "behaviors",
+      "income",
+      "net_worth",
+      "home_type",
+      "home_ownership",
+      "home_value",
+      "ethnic_affinity",
+      "generation",
+      "household_composition",
+      "moms",
+      "office_type",
+      "targeting_optimization",
+      "engagement_specs",
+      "excluded_engagement_specs",
+      "product_audience_specs",
+      "excluded_product_audience_specs",
+      "exclusions",
+      "flexible_spec",
+      "exclude_reached_since",
+      "exclude_previous_days",
+      "app_install_state",
+      "fb_deal_id",
+      "interest_defaults_source",
+      "alternate_auto_targeting_option",
+    ]
+
+
+    field :audience_size, 'int'
+    field :description, 'string'
+    field :id, 'string'
+    field :name, 'string'
+    field :path, { list: 'string' }
+    field :type, 'string'
+    field :valid, 'bool'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_account_user.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 AdAccountUser < AdObject
+
+    field :id, 'string'
+    field :name, 'string'
+    field :permissions, { list: 'int' }
+    field :role, 'int'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_activity.rb

@@ -0,0 +1,123 @@
+# 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 AdActivity < AdObject
+    EVENT_TYPE = [
+      "ad_account_update_spend_limit",
+      "ad_account_reset_spend_limit",
+      "ad_account_remove_spend_limit",
+      "ad_account_set_business_information",
+      "ad_account_update_status",
+      "ad_account_add_user_to_role",
+      "ad_account_remove_user_from_role",
+      "add_images",
+      "edit_images",
+      "delete_images",
+      "ad_account_billing_charge",
+      "ad_account_billing_charge_failed",
+      "ad_account_billing_chargeback",
+      "ad_account_billing_chargeback_reversal",
+      "ad_account_billing_decline",
+      "ad_account_billing_refund",
+      "billing_event",
+      "add_funding_source",
+      "remove_funding_source",
+      "create_campaign_group",
+      "update_campaign_name",
+      "update_campaign_run_status",
+      "update_campaign_group_spend_cap",
+      "create_campaign",
+      "create_campaign_legacy",
+      "update_campaign_budget",
+      "update_campaign_duration",
+      "create_ad_set",
+      "update_ad_set_bidding",
+      "update_ad_set_budget",
+      "update_ad_set_duration",
+      "update_ad_set_run_status",
+      "update_ad_set_name",
+      "create_ad",
+      "update_ad_creative",
+      "edit_and_update_ad_creative",
+      "update_ad_bid_info",
+      "update_ad_bid_type",
+      "update_ad_run_status",
+      "update_ad_friendly_name",
+      "update_ad_targets_spec",
+      "update_adgroup_stop_delivery",
+      "update_ad_set_target_spec",
+      "ad_review_approved",
+      "ad_review_declined",
+      "first_delivery_event",
+      "create_audience",
+      "update_audience",
+      "delete_audience",
+      "share_audience",
+      "receive_audience",
+      "unshare_audience",
+      "remove_shared_audience",
+      "unknown",
+      "account_spending_limit_reached",
+      "campaign_spending_limit_reached",
+      "lifetime_budget_spent",
+      "funding_event_initiated",
+      "funding_event_successful",
+      "update_ad_labels",
+    ]
+
+    CATEGORY = [
+      "ACCOUNT",
+      "AD",
+      "AD_SET",
+      "AUDIENCE",
+      "BID",
+      "BUDGET",
+      "CAMPAIGN",
+      "DATE",
+      "STATUS",
+      "TARGETING",
+    ]
+
+
+    field :actor_id, 'string'
+    field :actor_name, 'string'
+    field :application_id, 'string'
+    field :application_name, 'string'
+    field :date_time_in_timezone, 'string'
+    field :event_time, 'datetime'
+    field :event_type, { enum: -> { EVENT_TYPE }}
+    field :extra_data, 'string'
+    field :object_id, 'string'
+    field :object_name, 'string'
+    field :translated_event_type, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ad_async_request.rb

@@ -0,0 +1,66 @@
+# 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 AdAsyncRequest < AdObject
+    STATUS = [
+      "INITIAL",
+      "IN_PROGRESS",
+      "SUCCESS",
+      "ERROR",
+      "CANCELED",
+      "PENDING_DEPENDENCY",
+      "CANCELED_DEPENDENCY",
+      "ERROR_DEPENDENCY",
+      "ERROR_CONFLICTS",
+    ]
+
+    STATUSES = [
+      "INITIAL",
+      "IN_PROGRESS",
+      "SUCCESS",
+      "ERROR",
+      "CANCELED",
+      "PENDING_DEPENDENCY",
+      "CANCELED_DEPENDENCY",
+      "ERROR_DEPENDENCY",
+      "ERROR_CONFLICTS",
+    ]
+
+
+    field :async_request_set, 'AdAsyncRequestSet'
+    field :created_time, 'datetime'
+    field :id, 'string'
+    field :input, 'hash'
+    field :result, 'hash'
+    field :scope_object_id, 'string'
+    field :status, { enum: -> { STATUS }}
+    field :updated_time, 'datetime'
+    has_no_post
+    has_no_delete
+
+  end
+end