Class: Evernote::EDAM::NoteStore::AdParameters

Inherits:

Object

• Object
• Evernote::EDAM::NoteStore::AdParameters

Includes:

Thrift::Struct, Thrift::Struct_Union

Defined in:

lib/Evernote/EDAM/note_store_types.rb

Overview

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>

Constant Summary

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}
}

Constants included from Thrift::Struct_Union

Thrift::Struct_Union::CONTAINER_TYPES

Instance Method Summary

• #struct_fields ⇒ Object
• #validate ⇒ Object

Methods included from Thrift::Struct

#<=>, #==, #differences, #eql?, field_accessor, #fields_with_default_values, generate_accessors, #hash, #initialize, #inspect, qmark_isset_method, #read, #write

Methods included from Thrift::Struct_Union

#each_field, #field_info, #inspect_collection, #inspect_field, #is_container?, #name_to_id, #read_field, #sorted_field_ids, #write_container, #write_data

Instance Method Details

#struct_fields ⇒ Object

# File 'lib/Evernote/EDAM/note_store_types.rb', line 837

def struct_fields; FIELDS; end

#validate ⇒ Object

# File 'lib/Evernote/EDAM/note_store_types.rb', line 839

def validate
end