adparlor-facebook 0.5.9

data/lib/adparlor/facebook/graph_api/fields/activity.rb

@@ -0,0 +1,12 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module Activity
+          FIELDS = [:actor_id, :actor_name, :extra_data, :event_time,
+                    :event_type, :object_id, :object_name]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/ad.rb

@@ -0,0 +1,60 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module Ad
+          FIELDS = [
+            :id,
+            :account_id,
+            :adset,
+            :campaign_id,
+            :campaign,
+            :adlabels,
+            :adset_id,
+            :ad_review_feedback,
+            :bid_amount,
+            :bid_info,
+            :bid_type,
+            :configured_status,
+            :conversion_specs,
+            :created_time,
+            :creative,
+            :effective_status,
+            :last_updated_by_app_id,
+            :name,
+            :tracking_specs,
+            :updated_time
+          ]
+
+          CREATE_FIELDS = [
+            :adset_id,
+            :date_format,
+            :creative,
+            :name,
+            :status,
+            :tracking_specs,
+            :display_sequence,
+            :execution_options,
+            :ad_labels,
+            :bid_amount,
+            :redownload,
+            :object_story_spec
+          ]
+
+          UPDATE_FIELDS = [
+            :adset_id,
+            :creative,
+            :name,
+            :status,
+            :tracking_specs,
+            :display_sequence,
+            :execution_options,
+            :adlabels,
+            :bid_amount,
+            :redownload
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/ad_account.rb

@@ -0,0 +1,21 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module AdAccount
+          FIELDS = [:id, :account_id, :account_status, :age,
+                    :agency_client_declaration, :amount_spent, :balance, :business,
+                    :business_city, :business_country_code, :business_name,
+                    :business_state, :business_street2, :business_street, :business_zip,
+                    :created_time, :end_advertiser, :media_agency, :partner, :capabilities,
+                    :currency, :is_personal, :name, :offsite_pixels_tos_accepted,
+                    :spend_cap, :funding_source, :funding_source_details,
+                    :timezone_id, :timezone_name, :timezone_offset_hours_utc, :tos_accepted,
+                    :users, :tax_id_status, :min_daily_budget, :min_campaign_group_spend_cap]
+          CREATE_FIELDS = [:adaccounts, :replace]
+          UPDATE_FIELDS = [:adaccounts, :replace]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/ad_creative.rb

@@ -0,0 +1,23 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module AdCreative
+          FIELDS = [:actor_id, :adlabels, :applink_treatment,
+                    :body, :call_to_action_type, :dynamic_ad_voice, :effective_instagram_story_id,
+                    :effective_object_story_id, :id, :image_hash, :image_url, :image_crops,
+                    :instagram_actor_id, :instagram_permalink_url, :link_deep_link_url,
+                    :link_url, :name, :object_id, :object_story_id, :object_story_spec,
+                    :object_store_url, :object_type, :object_url, :product_set_id,
+                    :template_url, :thumbnail_url, :title, :url_tags, :video_id]
+          CREATE_FIELDS = [:actor_id, :adlabels, :applink_treatment, :body, :call_to_action,
+                           :dynamic_ad_voice, :follow_redirect, :image_crops, :image_file,
+                           :image_hash, :image_url, :instagram_actor_id, :instagram_permalink_url,
+                           :link_og_id, :link_url, :name, :object_id, :object_story_id,
+                           :object_type, :object_url, :product_set_id, :template_url, :thumbnail_url,
+                           :title, :url_tags, :video_id, :object_story_spec, :id]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/ad_image.rb

@@ -0,0 +1,14 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module AdImage
+          FIELDS = [:id, :account_id, :hash, :url, :creatives, :filename, :width, :height,
+                    :original_width, :original_height, :name, :status,
+                    :created_time, :updated_time, :permalink_url, :url_128]
+          CREATE_FIELDS = [:account_id, :copy_from, :source]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/ad_label.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module AdLabel
+          FIELDS = [:id, :name]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/ad_preview.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module AdPreview
+          FIELDS = [:body]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/ad_set.rb

@@ -0,0 +1,100 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module AdSet
+          FIELDS = [
+            :id,
+            :account_id,
+            :adlabels,
+            :adset_schedule,
+            :attribution_spec,
+            :bid_amount,
+            :bid_info,
+            :billing_event,
+            :campaign,
+            :campaign_id,
+            :configured_status,
+            :created_time,
+            :creative_sequence,
+            :effective_status,
+            :end_time,
+            :frequency_control_specs,
+            :lifetime_imps,
+            :name,
+            :optimization_goal,
+            :promoted_object,
+            :rf_prediction_id,
+            :start_time,
+            :targeting,
+            :updated_time,
+            :use_new_app_click,
+            :pacing_type,
+            :budget_remaining,
+            :daily_budget,
+            :lifetime_budget,
+            :bid_strategy
+          ]
+
+          CREATE_FIELDS = [
+            :account_id,
+            :adlabels,
+            :attribution_spec,
+            :bid_amount,
+            :billing_event,
+            :campaign_id,
+            :adset_schedule,
+            :status,
+            :creative_sequence,
+            :daily_budget,
+            :daily_imps,
+            :end_time,
+            :execution_options,
+            :frequency_control_specs,
+            :lifetime_budget,
+            :lifetime_imps,
+            :name,
+            :optimization_goal,
+            :pacing_type,
+            :product_ad_behavior,
+            :promoted_object,
+            :redownload,
+            :rf_prediction_id,
+            :start_time,
+            :targeting,
+            :bid_strategy
+          ]
+
+          UPDATE_FIELDS = [
+            :id,
+            :account_id,
+            :adlabels,
+            :attribution_spec,
+            :bid_amount,
+            :billing_event,
+            :campaign_id,
+            :adset_schedule,
+            :status,
+            :creative_sequence,
+            :daily_budget,
+            :daily_imps,
+            :end_time,
+            :execution_options,
+            :lifetime_budget,
+            :lifetime_imps,
+            :name,
+            :optimization_goal,
+            :pacing_type,
+            :product_ad_behavior,
+            :promoted_object,
+            :redownload,
+            :rf_prediction_id,
+            :start_time,
+            :targeting,
+            :bid_strategy
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/ad_video.rb

@@ -0,0 +1,22 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module AdVideo
+          FIELDS = [:id, :created_time, :description, :embed_html, :format, :from,
+                    :icon, :is_instagram_eligible, :length, :title, :status, :source,
+                    :updated_time, :privacy, :published, :scheduled_publish_time,
+                    :embeddable, :content_category, :permalink_url, :event, :place,
+                    :backdated_time, :backdated_time_granularity, :picture]
+          CREATE_FIELDS = [:account_id, :user_id, :event_id, :page_id, :group_id,
+                           :id, :title, :description, :source, :unpublished_content_type,
+                           :file_url, :thumb, :upload_phase, :file_size, :start_offset,
+                           :video_file_chunk, :upload_session_id, :content_category,
+                           :ebeddable, :slideshow_spec, :backdated_post, :call_to_action,
+                           :feed_targeting, :published, :scheduled_publish_time, :targeting,
+                           :no_story, :secret, :social_actions]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/ads_pixel.rb

@@ -0,0 +1,12 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module AdsPixel
+          FIELDS = [:id, :owner_ad_account, :name, :creation_time,
+                    :last_fired_time, :code]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/ads_pixel_stat.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module AdsPixelStat
+          FIELDS = [:aggregation, :timestamp, :data, :start_time]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/advertisable_application.rb

@@ -0,0 +1,17 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module AdvertisableApplication
+          FIELDS = [
+            :id,
+            :name,
+            :supported_platforms,
+            :picture,
+            :object_store_urls
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/app_event_type.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module AppEventType
+          FIELDS = [:description, :display_name, :event_name, :parameters]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/application.rb

@@ -0,0 +1,31 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module Application
+          FIELDS = [:id, :android_key_hash, :android_sdk_error_categories,
+                    :app_domains, :app_events_feature_bitmask, :app_install_tracked, :app_name,
+                    :app_type, :auth_dialog_data_help_url, :auth_dialog_headline,
+                    :auth_dialog_perms_explanation, :auth_referral_default_activity_privacy,
+                    :auth_referral_enabled, :auth_referral_extended_perms, :auth_referral_friend_perms,
+                    :auth_referral_response_type, :auth_referral_user_perms, :canvas_fluid_height,
+                    :canvas_fluid_width, :canvas_url, :category, :client_config, :company,
+                    :configured_ios_sso, :contact_email, :context, :created_time, :creator_uid,
+                    :deauth_callback_url,
+                    :default_share_mode, :description, :hosting_url, :icon_url, :ios_bundle_id,
+                    :ios_sdk_error_categories, :ios_supports_system_auth,
+                    :ios_supports_native_proxy_auth_flow, :ios_sdk_dialog_flows, :ipad_app_store_id,
+                    :iphone_app_store_id, :link, :logo_url, :migrations, :mobile_profile_section_url,
+                    :mobile_web_url, :name,
+                    :namespace, :object_store_urls, :page_tab_default_name, :page_tab_url,
+                    :privacy_policy_url, :profile_section_url, :restrictions, :secure_canvas_url,
+                    :secure_page_tab_url, :server_ip_whitelist, :social_discovery, :subcategory,
+                    :supports_apprequests_fast_app_switch, :supported_platforms, :supports_attribution,
+                    :supports_implicit_sdk_logging, :suppress_native_ios_gdp, :terms_of_service_url,
+                    :url_scheme_suffix, :user_support_email, :user_support_url, :website_url,
+                    :gdpv4_enabled, :gdpv4_nux_enabled, :gdpv4_nux_content]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/broad_targeting_category.rb

@@ -0,0 +1,12 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module BroadTargetingCategory
+          FIELDS = [:id, :name, :category_description, :parent_category, :path, 
+                    :size, :type, :type_name, :untranslated_name, :untranslated_parent_name]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/business.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module Business
+          FIELDS = [:id, :created_by, :creation_time, :name, :primary_page, :timezone_id, :update_time, :updated_by]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/campaign.rb

@@ -0,0 +1,17 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module Campaign
+          FIELDS = [:id, :adlabels, :account_id, :buying_type, :can_use_spend_cap,
+                    :configured_status, :created_time, :effective_status, :name,
+                    :objective, :start_time, :stop_time, :updated_time, :spend_cap]
+          CREATE_FIELDS = [:name, :objective, :status, :buying_type, :promoted_object,
+                           :spend_cap, :execution_options, :adlabels, :budget_rebalance_flag]
+          UPDATE_FIELDS = [:name, :objective, :status, :spend_cap, :execution_options,
+                           :adlabels, :budget_rebalance_flag]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/connection_object.rb

@@ -0,0 +1,16 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module ConnectionObject
+          FIELDS = [:id, :name, :name_with_location_descriptor, :url, :type, :checkin_capable,
+                    :picture, :tabs, :is_game, :supported_platforms, :native_app_store_ids,
+                    :object_store_urls, :app_installs_tracked, :native_app_targeting_ids,
+                    :og_namespace, :og_actions, :og_objects, :website, :logo_url, :icon_url,
+                    :event_parent_page_id, :event_parent_page_name, :event_start_timestamp,
+                    :event_is_viewer_admin, :cpa_access, :engagement_score]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/custom_audience.rb

@@ -0,0 +1,22 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module CustomAudience
+          FIELDS = [:id, :account_id, :approximate_count, :data_source, :delivery_status,
+                    :description, :excluded_custom_audiences, :included_custom_audiences,
+                    :external_event_source, :lookalike_audience_ids, :lookalike_spec,
+                    :name, :operation_status, :opt_out_link, :permission_for_actions,
+                    :pixel_id, :rule, :retention_days, :subtype, :time_created,
+                    :time_updated, :time_content_updated, :customer_file_source]
+          CREATE_FIELDS = [:creation_params, :description, :id, :name, :opt_out_link,
+                           :subtype, :lookalike_spec, :retention_days, :rule, :prefill,
+                           :pixel_id, :inclusions, :exclusions, :origin_audience_id, :customer_file_source]
+          UPDATE_FIELDS = [:description, :name, :opt_out_link, :parent_audience_id,
+                           :lookalike_spec, :retention_days, :rule, :inclusions,
+                           :exclusions, :customer_file_source]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/custom_audience_tos.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module CustomAudienceTos
+          FIELDS = [:id, :type, :content]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/custom_audience_user.rb

@@ -0,0 +1,14 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module CustomAudienceUser
+          FIELDS = [:cities, :emails, :facebook_uids, :first_names, :genders, :last_names,
+                    :mobile_adversiter_ids, :mobile_device_ids, :payload, :phone_numbers,
+                    :states, :zip_codes]
+          UPDATE_FIELDS = [:payload, :other, :account_id]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/custom_conversion.rb

@@ -0,0 +1,14 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module CustomConversion
+          FIELDS = [:id, :account_id, :creation_time, :custom_event_type, :default_conversion_value, :description,
+                    :first_fired_time, :is_archived, :last_fired_time, :name, :pixel, :rule]
+          CREATE_FIELDS = [:custom_event_type, :description, :default_conversion_value, :name, :event_source_id, :rule]
+          UPDATE_FIELDS = [:default_conversion_value, :description, :name]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/delivery_estimate.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module DeliveryEstimate
+          FIELDS = [:bid_estimate, :daily_outcomes_curve, :estimate_dau, :estimate_mau, :estimate_ready]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/field_decorator.rb

@@ -0,0 +1,51 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module FieldDecorator
+          GLOBAL_FIELDS = [:account_id, :conn, :files, :message, :source]
+
+          def self.included(base)
+            base.extend(ClassMethods)
+          end
+
+          module ClassMethods
+            def fields(*args)
+              if args.first == :all
+                @fields.map(&:to_s).join(',')
+              else
+                invalid_fields = args.map(&:to_s) - @fields.map(&:to_s)
+                invalid_fields_error(invalid_fields) if invalid_fields.any?
+                (@fields & args).map(&:to_s).join(',')
+              end
+            end
+
+            def validate_initialize_fields(*args)
+              create_fields = self.const_defined?('CREATE_FIELDS') ? const_get('CREATE_FIELDS') : []
+              invalid_fields = args.map(&:to_s) - ((@fields || []) + GLOBAL_FIELDS + create_fields).map(&:to_s)
+              invalid_fields_error(invalid_fields) if invalid_fields.any?
+            end
+
+            def validate_post_fields(*args, method)
+              valid_fields = self.const_defined?('CREATE_FIELDS') ? const_get('CREATE_FIELDS') : [] if method == 'CREATE'
+              valid_fields = self.const_defined?('UPDATE_FIELDS') ? const_get('UPDATE_FIELDS') : [] if method == 'UPDATE' || method == 'DELETE'
+              invalid_fields = args.map(&:to_s) - (@fields + GLOBAL_FIELDS + valid_fields).map(&:to_s)
+              invalid_fields_error(invalid_fields) if invalid_fields.any?
+            end
+
+            def field_attrs(fields)
+              @fields = fields
+              @fields.each { |field| attr_accessor field }
+            end
+
+            private
+
+            def invalid_fields_error(invalid_fields)
+              raise Adparlor::Facebook::Error.new("Invalid field#{invalid_fields.length > 1 ? 's' : ''} #{invalid_fields.join(', ')} passed", 500)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/insight.rb

@@ -0,0 +1,16 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module Insight
+          FIELDS = [:account_id, :action_attribution_windows, :action_breakdowns, :action_report_time,
+                    :breakdowns, :date_preset, :default_summary, :export_columns, :export_format,
+                    :export_name, :fields, :filtering, :level, :product_id_limit, :sort,
+                    :summary, :summary_action_breakdowns, :time_increment, :time_range, :time_ranges,
+                    :date_start, :date_stop, :campaign_id, :account_id, :adset_id, :ad_id,
+                    :reach, :frequency, :estimated_ad_recallers, :estimated_ad_recall_rate]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/instagram_account.rb

@@ -0,0 +1,11 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module InstagramAccount
+          FIELDS = [:id, :profile_pic, :username]
+        end
+      end
+    end
+  end
+end

data/lib/adparlor/facebook/graph_api/fields/leadgen_form.rb

@@ -0,0 +1,23 @@
+module Adparlor
+  module Facebook
+    module GraphApi
+      module Fields
+        module LeadgenForm
+          FIELDS = [
+            :id,
+            :follow_up_action_text,
+            :follow_up_action_url,
+            :form_url,
+            :is_tcpa_compliant,
+            :leadgen_export_csv_url,
+            :locale,
+            :name,
+            :page_id,
+            :privacy_policy_url,
+            :status
+          ]
+        end
+      end
+    end
+  end
+end