Class Evernote::EDAM::Type::Ad
In: ruby/lib/Evernote/EDAM/types_types.rb
Parent: Object

An advertisement that may be displayed within an Evernote client. Advertisements are either a snippet of HTML or else they are an image (of type: JPEG, GIF, PNG) with an associated destination URL.

<dl>

  <dt>id</dt>
  <dd>The unique identifier of this advertisement within Evernote's ad
  inventory.
  </dd>

  <dt>width</dt>
  <dd>This ad should be displayed within a rectangle that is this wide,
  in pixels.
  </dd>

  <dt>height</dt>
  <dd>This ad should be displayed within a rectangle that is this high,
  in pixels.
  </dd>

  <dt>advertiserName</dt>
  <dd>A string containing a readable version of the name of this advertiser.
  </dd>

  <dt>imageUrl</dt>
  <dd>The location of the image to display for this ad.</dd>

  <dt>destinationUrl</dt>
  <dd>When a user clicks on the ad, this is the destination they should be
  sent to in a browser.</dd>

  <dt>displaySeconds</dt>
  <dd>The number of seconds that the ad should be displayed before it is
  replaced with a different ad.</dd>

  <dt>score</dt>
  <dd>A numeric indicator of the relative value of this ad, which can be
  compared against other ads from the same day.
  </dd>

  <dt>image</dt>
  <dd>If present, this is the raw image bits of the image file to display
  for the ad.  If not present, the imageUrl should be retrieved directly.
  </dd>

  <dt>imageMime</dt>
  <dd>The MIME type of the 'image' bytes, if those are set.</dd>

  <dt>html</dt>
  <dd>The exact HTML to display for this ad, to support rich or external
  advertisements.</dd>

  <dt>displayFrequency</dt>
  <dd>If this value is set, this is the relatively frequency that this
  ad should be displayed in the daily set of ads, relative to a base
  frequency of 1.0.  I.e. an ad with a frequency of 3.0 should be displayed
  three times more frequently than an ad with a frequency of 1.0.</dd>

</dl>

Methods

Included Modules

::Thrift::Struct ::Thrift::Struct_Union

Constants

ID = 1
WIDTH = 2
HEIGHT = 3
ADVERTISERNAME = 4
IMAGEURL = 5
DESTINATIONURL = 6
DISPLAYSECONDS = 7
SCORE = 8
IMAGE = 9
IMAGEMIME = 10
HTML = 11
DISPLAYFREQUENCY = 12
FIELDS = { ID => {:type => ::Thrift::Types::I32, :name => 'id', :optional => true}, WIDTH => {:type => ::Thrift::Types::I16, :name => 'width', :optional => true}, HEIGHT => {:type => ::Thrift::Types::I16, :name => 'height', :optional => true}, ADVERTISERNAME => {:type => ::Thrift::Types::STRING, :name => 'advertiserName', :optional => true}, IMAGEURL => {:type => ::Thrift::Types::STRING, :name => 'imageUrl', :optional => true}, DESTINATIONURL => {:type => ::Thrift::Types::STRING, :name => 'destinationUrl', :optional => true}, DISPLAYSECONDS => {:type => ::Thrift::Types::I16, :name => 'displaySeconds', :optional => true}, SCORE => {:type => ::Thrift::Types::DOUBLE, :name => 'score', :optional => true}, IMAGE => {:type => ::Thrift::Types::STRING, :name => 'image', :binary => true, :optional => true}, IMAGEMIME => {:type => ::Thrift::Types::STRING, :name => 'imageMime', :optional => true}, HTML => {:type => ::Thrift::Types::STRING, :name => 'html', :optional => true}, DISPLAYFREQUENCY => {:type => ::Thrift::Types::DOUBLE, :name => 'displayFrequency', :optional => true}

Public Instance methods

[Source]

      # File ruby/lib/Evernote/EDAM/types_types.rb, line 1427
1427:               def struct_fields; FIELDS; end

[Source]

      # File ruby/lib/Evernote/EDAM/types_types.rb, line 1429
1429:               def validate
1430:               end

[Validate]