=========================================================================
Tariffs Models & Data Types Documentation
=========================================================================
.. _REF_MODEL_OnlineAdFormat:
:index:`OnlineAdFormat`
----------------------------------------------------------------------------------
.. graphviz::
digraph foo {
node [shape=none, margin=0];
OnlineAdFormat [label=<
OnlineAdFormat |
cpm : number |
description : string |
id : string |
name : string |
potential : number |
size : string |
|
>];
edge [dir=back, arrowtail=dot]
}
Properties
""""""""""
.. index::
pair: OnlineAdFormat; description
pair: OnlineAdFormat; name
pair: OnlineAdFormat; potential
pair: OnlineAdFormat; cpm
pair: OnlineAdFormat; id
pair: OnlineAdFormat; size
.. list-table::
:widths: 10 10 60
:header-rows: 1
* - Field
- Type
- Description
* - description
- string
- A somewhat detailed description of the ad format. Usually omitted for standard ad formats.
* - name
- string
- A name for the ad format. Usually omitted for standard ad formats.
* - potential
- number
- The inventory potential. The ratio of page impressions which can be actually booked with the related advert format.
* - cpm
- number
- Costs per mill. The price for thousand contacts. German abbr.: 'TKP'.
* - id
- string
- The ID of the advert format to be applied e.g. to reference it by a placement of a media plan.
* - size
- string
- A textual description of the size of the ad format. Usually omitted for standard ad formats.
.. _REF_MODEL_PrintAdFormat:
:index:`PrintAdFormat`
----------------------------------------------------------------------------------
.. graphviz::
digraph foo {
node [shape=none, margin=0];
PrintAdFormat [label=<
PrintAdFormat |
id : string |
title : string |
|
>];
edge [dir=back, arrowtail=dot]
}
Properties
""""""""""
.. index::
pair: PrintAdFormat; id
pair: PrintAdFormat; title
.. list-table::
:widths: 10 10 60
:header-rows: 1
* - Field
- Type
- Description
* - id
- string
- The ID of the print advertisement format.
* - title
- string
- The title of the print advertisement format.
.. _REF_MODEL_RateCard:
:index:`RateCard`
----------------------------------------------------------------------------------
.. graphviz::
digraph foo {
node [shape=none, margin=0];
RateCard [label=<
RateCard |
adFormats : OnlineAdFormat [] |
currency : string |
frequency : number |
frequencyCapping : string |
info : string |
priceOnRequest : boolean |
targeting : string |
validFrom : Date |
validThru : Date |
|
>];
OnlineAdFormat [label=<
OnlineAdFormat |
cpm : number |
description : string |
id : string |
name : string |
potential : number |
size : string |
|
>];
edge [dir=back, arrowtail=dot]
RateCard -> OnlineAdFormat [label=<>];
}
Properties
""""""""""
.. index::
pair: RateCard; info
pair: RateCard; targeting
pair: RateCard; priceOnRequest
pair: RateCard; currency
pair: RateCard; frequency
pair: RateCard; validThru
pair: RateCard; frequencyCapping
pair: RateCard; validFrom
pair: RateCard; adFormats
.. list-table::
:widths: 10 10 60
:header-rows: 1
* - Field
- Type
- Description
* - info
- string
- The ID of the info kit.
* - targeting
- string
- The ID of the targeting kit.
* - priceOnRequest
- boolean
- Are prices on request available for this booking unit.
* - currency
- string
- The currency of the pricings.
* - frequency
- number
- The frequency.
* - validThru
- Date
- The end time of the period of validity as string according RFC 3339 and ISO 8601.
* - frequencyCapping
- string
- The ID of the frequency capping kit.
* - validFrom
- Date
- The start time of the period of validity as string according RFC 3339 and ISO 8601.
* - adFormats
- :ref:`REF_MODEL_OnlineAdFormat` []
- Array of advert formats.