Class Evernote::EDAM::NoteStore::AdParameters
In: ruby/lib/Evernote/EDAM/note_store_types.rb
Parent: Object

Parameters that will be given by a client to the service when it requests a set of advertisements to display. If any of these values are omitted, the service will use default values.

<dl>

 <dt>clientLanguage</dt>
   <dd>
     The ISO 639-1 language code for the primary language for the client.
     If omitted, English will be assumed ('en').
   </dd>

 <dt>impressions</dt>
   <dd>
     A list of the impression counts and total display time for the ads
     that were displayed in the last day.
   </dd>

 <dt>supportHtml</dt>
   <dd>
     If true, the client requesting the ads supports ads specified via
     general HTML (with rich media, Javascript, etc.).
   </dd>

 <dt>clientProperties</dt>
   <dd>
     If provided, this may contain a set of key/value pairs that identify
     the characteristics of a particular client that may be used to help
     determine appropriate ads for that client.  These tuples may be used
     either to reduce or increase the likelihood that each ad will be
     returned.
   </dd>

</dl>

Methods

Included Modules

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

Constants

CLIENTLANGUAGE = 2
IMPRESSIONS = 4
SUPPORTHTML = 5
CLIENTPROPERTIES = 6
FIELDS = { CLIENTLANGUAGE => {:type => ::Thrift::Types::STRING, :name => 'clientLanguage', :optional => true}, IMPRESSIONS => {:type => ::Thrift::Types::LIST, :name => 'impressions', :element => {:type => ::Thrift::Types::STRUCT, :class => Evernote::EDAM::NoteStore::AdImpressions}, :optional => true}, SUPPORTHTML => {:type => ::Thrift::Types::BOOL, :name => 'supportHtml', :optional => true}, CLIENTPROPERTIES => {:type => ::Thrift::Types::MAP, :name => 'clientProperties', :key => {:type => ::Thrift::Types::STRING}, :value => {:type => ::Thrift::Types::STRING}, :optional => true}

Public Instance methods

[Source]

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

[Source]

     # File ruby/lib/Evernote/EDAM/note_store_types.rb, line 491
491:               def validate
492:               end

[Validate]