Class: Epom::Banner

Inherits:

EpomElement

Object
EpomElement
Epom::Banner

show all

Defined in:: lib/epom/banner.rb

Class Method Summary collapse

Methods inherited from EpomElement

generic_method, login, method_missing, params_validation, respond_to?

Class Method Details

.extended_methods ⇒ `Object`

# File 'lib/epom/banner.rb', line 9

def self.extended_methods
	{
		:create_banner => {
			:url => '/rest-api/banner/create.do',
			:body_parameters => [:placementType, :campaignId, :active, :name, :allowNewPlacementsAutoLinking, :autolinkCategories, :weight, :adUnitId, :adUnitHeight, :adUnitWidth, :bannerType, :flashBannerLink, :imageBannerLink, :videoFileLink, :flashFile, :imageFile, :videoFile, :templateId, :thirdTrackingCode, :code, :url, :inStreamVideoType, :mobileAdvertisingNetwork, :mobileAdvertisingNetworkParameters, :applicationOperatingSystem, :applicationAdCategory, :applicationAdvertisingNetwork, :applicationAdvertisingNetworkParameters, :hash, :timestamp, :username],
			:method => :post
		},
      :delete_banner => {
          :url => '/rest-api/banner/BANNER_ID/delete.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :delete
      },
      :get_ad_unit_values_by_banner_type => {
          :url => '/rest-api/banners/BANNER_TYPE/adunit/values.do',
          :url_parameters => [:bannerType],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_banner_ad_unit_values => {
          :url => '/rest-api/banner/adunit/values.do',
          :body_parameters => [:placementType, :hash, :timestamp, :username],
          :method => :get
      },
      :get_banner_pricing => {
          :url => '/rest-api/banner/BANNER_ID/pricing.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_mobile_networks => {
          :url => '/rest-api/banner/mobilenetworks.do',
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_placements_for_banner => {
          :url => '/rest-api/banner/BANNER_ID/placements.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :update_banners_urls_batch => {
          :url => '/rest-api/banner/BANNER_ID/placements.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :post
      },

      #######################
      #Banner Capping API
      #######################

      :get_action_capping => {
          :url => '/rest-api/banner/BANNER_ID/actionCapping.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_click_capping => {
          :url => '/rest-api/banner/BANNER_ID/clickCapping.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_frequency_capping => {
          :url => '/rest-api/banner/BANNER_ID/frequencyCapping.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },

      :remove_action_capping => {
          :url => '/rest-api/banner/BANNER_ID/actionCapping.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :delete
      },
      :remove_click_capping => {
          :url => '/rest-api/banner/BANNER_ID/clickCapping.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :delete
      },
      :remove_frequency_capping => {
          :url => '/rest-api/banner/BANNER_ID/frequencyCapping.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :delete
      },

      :set_action_capping => {
          :url => '/rest-api/banner/BANNER_ID/actionCapping/set.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:amount, :period, :periodType, :evenDistribution, :hash, :timestamp, :username],
          :method => :post
      },
      :set_click_capping => {
          :url => '/rest-api/banner/BANNER_ID/clickCapping/set.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:amount, :period, :periodType, :evenDistribution, :hash, :timestamp, :username],
          :method => :post
      },
      :set_frequency_capping => {
          :url => '/rest-api/banner/BANNER_ID/frequencyCapping/set.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:amount, :period, :periodType, :evenDistribution, :hash, :timestamp, :username],
          :method => :post
      },

      :update_action_capping => {
          :url => '/rest-api/banner/BANNER_ID/actionCapping/update.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:amount, :period, :periodType, :evenDistribution, :hash, :timestamp, :username],
          :method => :post
      },
      :update_click_capping => {
          :url => '/rest-api/banner/BANNER_ID/clickCapping/update.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:amount, :period, :periodType, :evenDistribution, :hash, :timestamp, :username],
          :method => :post
      },
      :update_frequency_capping => {
          :url => '/rest-api/banner/BANNER_ID/frequencyCapping/update.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:amount, :period, :periodType, :evenDistribution, :hash, :timestamp, :username],
          :method => :post
      },

      #######################
      #Banner Limits API
      #######################

      :disable_limits => {
          :url => '/rest-api/banner/BANNER_ID/limits.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :delete
      },
      :get_limits => {
          :url => '/rest-api/banner/BANNER_ID/limits.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :reset_limits => {
          :url => '/rest-api/banner/BANNER_ID/limits/reset.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:limitCounters, :hash, :timestamp, :username],
          :method => :post
      },
      :set_limits => {
          :url => '/rest-api/banner/BANNER_ID/limits/set.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:totalImpressionsLimit, :totalClicksLimit, :totalBudgetLimit, :dailyImpressionsLimit, :dailyClicksLimit, :dailyBudgetLimit, :totalImpressions, :totalClicks, :totalBudget, :dailyImpressions, :dailyClicks, :startDate, :endDate, :hash, :timestamp, :username],
          :method => :post
      },
      :update_limits => {
          :url => '/rest-api/banner/BANNER_ID/limits/update.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:totalImpressionsLimit, :totalClicksLimit, :totalBudgetLimit, :dailyImpressionsLimit, :dailyClicksLimit, :dailyBudgetLimit, :totalImpressions, :totalClicks, :totalBudget, :dailyImpressions, :dailyClicks, :startDate, :endDate, :hash, :timestamp, :username],
          :method => :post
      },

      #######################
      #Banner Targeting API
      #######################

      :create_browser_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:rule, :browser, :relation, :browserVersion, :hash, :timestamp, :username],
          :method => :post
      },
      :create_channel_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/channel/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:channel, :rule, :hash, :timestamp, :username],
          :method => :post
      },
      :create_cookie_value_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/cookie/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:cookieName, :cookieValue, :rule, :hash, :timestamp, :username],
          :method => :post
      },
      :create_country_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/country/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:countryCode, :rule, :hash, :timestamp, :username],
          :method => :post
      },
      :create_custom_parameter_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/custom/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:expression, :rule, :hash, :timestamp, :username],
          :method => :post
      },
      :create_day_of_week_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/dayofweek/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:dayOfWeek, :rule, :hash, :timestamp, :username],
          :method => :post
      },
      :create_device_format_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/deviceformat/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:deviceFormat, :rule, :hash, :timestamp, :username],
          :method => :post
      },
      :create_device_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/mobilecarrier/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:deviceFormat, :rule, :hash, :timestamp, :username],
          :method => :post
      },
      :create_device_vendor_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/devicevendor/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:deviceVendor, :rule, :hash, :timestamp, :username],
          :method => :post
      },
      :create_domain_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/domain/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:domain, :rule, :hash, :timestamp, :username],
          :method => :post
      },
      :create_ip_range_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/iprange/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:ipFrom, :ipTo, :rule, :hash, :timestamp, :username],
          :method => :post
      },
      :create_language_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/language/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:languageCode, :rule, :hash, :timestamp, :username],
          :method => :post
      },
      :create_location_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/location/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:countryCode, :regionName, :cityName, :rule, :hash, :timestamp, :username],
          :method => :post
      },
      :create_mobile_carrier_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/mobilecarrier/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:mobileCarriers, :rule, :hash, :timestamp, :username],
          :method => :post
      },
      :create_os_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/os/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:operatingSystem, :rule, :hash, :timestamp, :username],
          :method => :post
      },
      :create_screen_resolution_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/os/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:relation, :screenWidth, :screenHeight, :rule, :hash, :timestamp, :username],
          :method => :post
      },
      :create_time_range_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/timerange/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:timeFrom, :timeTo, :rule, :hash, :timestamp, :username],
          :method => :post
      },
      :create_wifi_traffic_target => {
          :url => '/rest-api/banner/BANNER_ID/targeting/wifi/create.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:rule, :hash, :timestamp, :username],
          :method => :post
      },

      :disable_targeting => {
          :url => '/rest-api/banner/BANNER_ID/targeting/disable.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :post
      },
      :enable_targeting => {
          :url => '/rest-api/banner/BANNER_ID/targeting/enable.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :post
      },

      :get_browsers => {
          :url => '/rest-api/banner/BANNER_ID/targeting/browsers/values.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_chrome_browsers => {
          :url => '/rest-api/banner/BANNER_ID/targeting/browsers/chrome/values.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_firefox_browsers => {
          :url => '/rest-api/banner/BANNER_ID/targeting/browsers/firefox/values.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_ie_browsers => {
          :url => '/rest-api/banner/BANNER_ID/targeting/browsers/ie/values.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_safari_browsers => {
          :url => '/rest-api/banner/BANNER_ID/targeting/browsers/safari/values.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },

      :get_country_regions => {
          :url => '/rest-api/banner/BANNER_ID/targeting/country/region/values.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:countryCode, :hash, :timestamp, :username],
          :method => :get
      },
      :get_device_format_values => {
          :url => '/rest-api/banner/BANNER_ID/targeting/device/format/values.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_device_values => {
          :url => '/rest-api/banner/BANNER_ID/targeting/device/values.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_device_vendor_values => {
          :url => '/rest-api/banner/BANNER_ID/targeting/device/vendor/values.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_languages => {
          :url => '/rest-api/banner/BANNER_ID/targeting/language/values.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_mobile_carriers => {
          :url => '/rest-api/banner/BANNER_ID/targeting/mobilecarriers/values.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_os_values => {
          :url => '/rest-api/banner/BANNER_ID/targeting/os/values.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_os_versions_by_os_name => {
          :url => '/rest-api/banner/BANNER_ID/targeting/os/OS_NAME/versions.do',
          :url_parameters => [:bannerId, :osName],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_region_cities => {
          :url => '/rest-api/banner/BANNER_ID/targeting/country/region/city/values.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:countryCode, :regionName, :hash, :timestamp, :username],
          :method => :get
      },
      :get_screen_resolution_values => {
          :url => '/rest-api/banner/BANNER_ID/targeting/resolution/values.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_targeting => {
          :url => '/rest-api/banner/BANNER_ID/targeting/TARGET_ID.do',
          :url_parameters => [:bannerId, :targetId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_targetings => {
          :url => '/rest-api/banner/BANNER_ID/targetings.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_targeting_types => {
          :url => '/rest-api/banner/BANNER_ID/targeting/types.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },

      :remove_targeting => {
          :url => '/rest-api/banner/BANNER_ID/targeting/TARGET_ID/delete.do',
          :url_parameters => [:bannerId, :targetId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :delete
      },

      #############################
      #Banner Placement Linking API
      #############################

      :create_or_update_banner_placements => {
          :url => '/rest-api/banners/BANNER_ID/placements.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:ids, :hash, :timestamp, :username],
          :method => :put
      },
      :delete_banner_placements => {
          :url => '/rest-api/banners/BANNER_ID/placements.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:removeIds, :hash, :timestamp, :username],
          :method => :delete
      },
      :get_banner_placements_list => {
          :url => '/rest-api/banners/BANNER_ID/placements.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :disable_banner_country_pricing => {
          :url => '/rest-api/banner/BANNER_ID/pricing/COUNTRY_CODE.do',
          :url_parameters => [:bannerId, :countryCode],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :delete
      },
      :disable_banner_frequency_capping => {
          :url => '/rest-api/banner/BANNER_ID/capping/frequency.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :delete
      },
      :disable_banner_pricing => {
          :url => '/rest-api/banner/BANNER_ID/pricing.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :delete
      },

      :get_advertising_categories => {
          :url => '/rest-api/categories/advertising.do',
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_banner => {
          :url => '/rest-api/banner/BANNER_ID.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      },
      :get_banners => {
          :url => '/rest-api/banners.do',
          :body_parameters => [:campaignId, :advertisingCategories, :hash, :timestamp, :username],
          :method => :get
      },
      :get_banners_urls => {
          :url => '/rest-api/banners/urls.do',
          :body_parameters => [:bannerIds, :advertisingCategories, :hash, :timestamp, :username],
          :method => :get
      },
      :update_banner => {
          :url => '/rest-api/banner/BANNER_ID/update.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:active, :allowNewPlacementsAutoLinking, :autolinkCategories, :hash, :timestamp, :username],
          :method => :post
      },
      :update_banner_country_pricing => {
          :url => '/rest-api/banner/{BANNER_ID}/pricing/COUNTRY_CODE.do',
          :url_parameters => [:bannerId, :countryCode],
          :body_parameters => [:active, :allowNewPlacementsAutoLinking, :autolinkCategories, :hash, :timestamp, :username],
          :method => :post
      },
      :update_banner_country_pricing_batch => {
          :url => '/rest-api/banner/BANNER_ID/pricing/batch',
          :url_parameters => [:bannerId],
          :body_parameters => [:countryPrices, :hash, :timestamp, :username],
          :method => :post
      },
      :update_banner_frequency_capping => {
          :url => '/rest-api/banner/BANNER_ID/capping/frequency.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:amount, :periodType, :flat, :period, :hash, :timestamp, :username],
          :method => :post
      },
      :update_banner_pricing => {
          :url => '/rest-api/banner/BANNER_ID/pricing.do',
          :url_parameters => [:bannerId],
          :body_parameters => [:price, :paymentModel, :hash, :timestamp, :username],
          :method => :post
      },
      :get_linked_banners_for_placement => {
          :url => '/rest-api/banner/placement/PLACEMENT_ID/banners.do',
          :url_parameters => [:placementId],
          :body_parameters => [:hash, :timestamp, :username],
          :method => :get
      }
	}
end

.replace_params_in_url(url, url_params) ⇒ `Object`

# File 'lib/epom/banner.rb', line 516

def self.replace_params_in_url(url, url_params)
  url.gsub!('BANNER_ID', url_params[:bannerId].to_s) if url.include?("BANNER_ID")
  url.gsub!('BANNER_TYPE', url_params[:bannerType]) if url.include?('BANNER_TYPE')
  url.gsub!('OS_NAME', url_params[:osName]) if url.include?('OS_NAME')
  url.gsub!('TARGET_ID', url_params[:targetId]) if url.include?('TARGET_ID')
  url.gsub!('COUNTRY_CODE', url_params[:countryCode]) if url.include?('COUNTRY_CODE')
  url.gsub!('PLACEMENT_ID', url_params[:placementId]) if url.include?('PLACEMENT_ID')
  url
end

Class: Epom::Banner

Class Method Summary collapse

Methods inherited from EpomElement

Class Method Details

.extended_methods ⇒ Object

.replace_params_in_url(url, url_params) ⇒ Object

.extended_methods ⇒ `Object`

.replace_params_in_url(url, url_params) ⇒ `Object`