========================================================================= Analyses Models & Data Types Documentation ========================================================================= .. _REF_MODEL_Analysis: :index:`Analysis` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; AnalysisTimeFrame [label=<
AnalysisTimeFrame
from : IssueDate
to : IssueDate
>]; InfoAttribute [label=<
InfoAttribute
key : string
value : string
>]; Analysis [label=<
Analysis
defaultProjection : number
id : string
infoAttributes : InfoAttribute []
languages : string []
n : integer
next : string
periods : Period []
previous : string
projectionFactor : number
revision : string
tariffConditions : string []
timeFrame : AnalysisTimeFrame
title : string
titleBrowser : string
titleFull : string
titleRoot : string
>]; IssueDate [label=<
IssueDate
number : integer
unit : string
year : integer
>]; Period [label=<
Period
description : string
key : string
>]; edge [dir=back, arrowtail=dot] Analysis -> Period [label=<
periods
>]; Analysis -> AnalysisTimeFrame [label=<
timeFrame
>]; AnalysisTimeFrame -> IssueDate [label=<
to
>]; AnalysisTimeFrame -> IssueDate [label=<
from
>]; Analysis -> InfoAttribute [label=<
infoAttributes
>]; } Properties """""""""" .. index:: pair: Analysis; title pair: Analysis; tariffConditions pair: Analysis; projectionFactor pair: Analysis; n pair: Analysis; languages pair: Analysis; next pair: Analysis; titleBrowser pair: Analysis; periods pair: Analysis; timeFrame pair: Analysis; previous pair: Analysis; defaultProjection pair: Analysis; infoAttributes pair: Analysis; revision pair: Analysis; titleFull pair: Analysis; id pair: Analysis; titleRoot .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - title - string - The general title of the analysis * - tariffConditions - string [] - Array of tariff condition IDs. * - projectionFactor - number - The projection factor of the analysis * - n - integer - The record count of the analysis * - languages - string [] - ISO 639-1 language codes (Array of strings) * - next - string - ID of the succeeding analysis, if available else null. * - titleBrowser - string - A title string intended to represent the analysis in browser views * - periods - :ref:`REF_MODEL_Period` [] - Array of the periods supported by the analysis. * - timeFrame - :ref:`REF_MODEL_AnalysisTimeFrame` - The time frame of the analysis. * - previous - string - ID of the preceding analysis, if available else null. * - defaultProjection - number - Default magnitude of extrapolation * - infoAttributes - :ref:`REF_MODEL_InfoAttribute` [] - Array of generic info attributes (key-value pairs). * - revision - string - Revision stamp of analysis file. * - titleFull - string - The complete notation of the analysis title * - id - string - The ID of the analysis * - titleRoot - string - Base part of the analysis title e.g. without designation of its population .. _REF_MODEL_AnalysisTimeFrame: :index:`AnalysisTimeFrame` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; AnalysisTimeFrame [label=<
AnalysisTimeFrame
from : IssueDate
to : IssueDate
>]; IssueDate [label=<
IssueDate
number : integer
unit : string
year : integer
>]; edge [dir=back, arrowtail=dot] AnalysisTimeFrame -> IssueDate [label=<
to
>]; AnalysisTimeFrame -> IssueDate [label=<
from
>]; } Properties """""""""" .. index:: pair: AnalysisTimeFrame; to pair: AnalysisTimeFrame; from .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - to - :ref:`REF_MODEL_IssueDate` - The end of the analysis time frame. * - from - :ref:`REF_MODEL_IssueDate` - The begin of the analysis time frame. .. _REF_MODEL_AndCombinedItem: :index:`AndCombinedItem` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; AndCombinedItem [label=<
AndCombinedItem
>]; edge [dir=back, arrowtail=dot] } .. _REF_MODEL_Audience: :index:`Audience` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; Audience [label=<
Audience
key : string
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: Audience; key .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - key - string - The key of the audience in the analysis. .. _REF_MODEL_AverageCombinedItem: :index:`AverageCombinedItem` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; AverageCombinedItem [label=<
AverageCombinedItem
>]; edge [dir=back, arrowtail=dot] } .. _REF_MODEL_BroadcastConditions: :index:`BroadcastConditions` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; BroadcastConditions [label=<
BroadcastConditions
internalFrequency : integer
length_sec : number
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: BroadcastConditions; length_sec pair: BroadcastConditions; internalFrequency .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - length_sec - number - Advertisement spot length in number of seconds. * - internalFrequency - integer - Number of placements of the advertisement within the same issue. .. _REF_MODEL_BroadcastMedium: :index:`BroadcastMedium` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; BroadcastMedium [label=<
BroadcastMedium
key : string
time : string
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: BroadcastMedium; key pair: BroadcastMedium; time .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - key - string - The key of the medium in the analysis. * - time - string - Time code. Corresponding code field from the BrowserAirtime model. .. _REF_MODEL_BrowserAirtime: :index:`BrowserAirtime` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; BrowserAirtime [label=<
BrowserAirtime
code : string
display : string
longTitle : string
shortTitle : string
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: BrowserAirtime; longTitle pair: BrowserAirtime; code pair: BrowserAirtime; display pair: BrowserAirtime; shortTitle .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - longTitle - string - A more detailed label for the time item * - code - string - The reference code of the time to be used by BroadcastMedium count items * - display - string - The abbreviated label to be applied while browsing items * - shortTitle - string - The short label of the time item .. _REF_MODEL_BrowserAudience: :index:`BrowserAudience` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; BrowserAudience [label=<
BrowserAudience
key : string
notUsable : boolean
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: BrowserAudience; notUsable pair: BrowserAudience; key .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - notUsable - boolean - Flag indicating if the target audience is not usable in the analysis * - key - string - The key of the target audience .. _REF_MODEL_BrowserBroadcastMedium: :index:`BrowserBroadcastMedium` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; BrowserBroadcastMedium [label=<
BrowserBroadcastMedium
>]; edge [dir=back, arrowtail=dot] } .. _REF_MODEL_BrowserBroadcastNode: :index:`BrowserBroadcastNode` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; BrowserAirtime [label=<
BrowserAirtime
code : string
display : string
longTitle : string
shortTitle : string
>]; BrowserBroadcastNode [label=<
BrowserBroadcastNode
times : BrowserAirtime []
>]; edge [dir=back, arrowtail=dot] BrowserBroadcastNode -> BrowserAirtime [label=<
times
>]; } Properties """""""""" .. index:: pair: BrowserBroadcastNode; times .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - times - :ref:`REF_MODEL_BrowserAirtime` [] - Array of air times .. _REF_MODEL_BrowserItem: :index:`BrowserItem` ---------------------------------------------------------------------------------- Base type of all items of the browser tree .. graphviz:: digraph foo { node [shape=none, margin=0]; BrowserItem [label=<
BrowserItem
description : string
display : string
hints : string
longTitle : string
shortTitle : string
type : string
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: BrowserItem; description pair: BrowserItem; shortTitle pair: BrowserItem; longTitle pair: BrowserItem; type pair: BrowserItem; display pair: BrowserItem; hints .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - description - string - A somewhat detailed description of the browser item * - shortTitle - string - The short label of the browser item * - longTitle - string - A more detailed label for the browser item * - type - string - The subtype of the browser item * - display - string - The abbreviated label to be applied while browsing items * - hints - string - Phrase containing hints for the application of the browser item. Typical comma separated user defined keywords. .. _REF_MODEL_BrowserMedium: :index:`BrowserMedium` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; BrowserMedium [label=<
BrowserMedium
description : string
infos : map
key : string
notUsable : boolean
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: BrowserMedium; notUsable pair: BrowserMedium; infos pair: BrowserMedium; description pair: BrowserMedium; key .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - notUsable - boolean - Flag indicating if the medium is not usable in the analysis * - infos - :ref:`REF_MODEL_map` - Generic map of info attributes * - description - string - A somewhat more detailed description of the medium * - key - string - The object key/id of the medium .. _REF_MODEL_BrowserNode: :index:`BrowserNode` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; BrowserNode [label=<
BrowserNode
children : BrowserItem []
id : string
notUsable : boolean
>]; BrowserItem [label=<
BrowserItem
description : string
display : string
hints : string
longTitle : string
shortTitle : string
type : string
>]; edge [dir=back, arrowtail=dot] BrowserNode -> BrowserItem [label=<
children
>]; } Properties """""""""" .. index:: pair: BrowserNode; id pair: BrowserNode; notUsable pair: BrowserNode; children .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - id - string - The ID of the browser node * - notUsable - boolean - Flag indicating that the node is not usable in the analysis, i.e. all of its descendants are not usable * - children - :ref:`REF_MODEL_BrowserItem` [] - Children of that node - optional, if requested .. _REF_MODEL_BrowserOnlineMedium: :index:`BrowserOnlineMedium` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; BrowserOnlineMedium [label=<
BrowserOnlineMedium
>]; edge [dir=back, arrowtail=dot] } .. _REF_MODEL_BrowserQuantitativeAudience: :index:`BrowserQuantitativeAudience` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; BrowserQuantitativeAudience [label=<
BrowserQuantitativeAudience
key : string
max : number
min : number
notUsable : boolean
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: BrowserQuantitativeAudience; max pair: BrowserQuantitativeAudience; notUsable pair: BrowserQuantitativeAudience; key pair: BrowserQuantitativeAudience; min .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - max - number - Upper limit of the range for the quantity * - notUsable - boolean - Flag indicating if the target audience is not usable in the analysis * - key - string - The key of the target audience * - min - number - Lower limit of the range for the quantity .. _REF_MODEL_BrowserScale: :index:`BrowserScale` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; BrowserScale [label=<
BrowserScale
groups : ScaleGroup []
id : string
>]; ScaleGroup [label=<
ScaleGroup
elements : ScaleElement []
>]; ScaleElement [label=<
ScaleElement
display : string
>]; edge [dir=back, arrowtail=dot] BrowserScale -> ScaleGroup [label=<
groups
>]; ScaleGroup -> ScaleElement [label=<
elements
>]; } Properties """""""""" .. index:: pair: BrowserScale; id pair: BrowserScale; groups .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - id - string - The ID of the browser node * - groups - :ref:`REF_MODEL_ScaleGroup` [] - Array of scale groups .. _REF_MODEL_BrowserSearchHit: :index:`BrowserSearchHit` ---------------------------------------------------------------------------------- Hit of the browser search .. graphviz:: digraph foo { node [shape=none, margin=0]; BrowserSearchHit [label=<
BrowserSearchHit
item : BrowserItem
parent : string
path : string []
>]; BrowserItem [label=<
BrowserItem
description : string
display : string
hints : string
longTitle : string
shortTitle : string
type : string
>]; edge [dir=back, arrowtail=dot] BrowserSearchHit -> BrowserItem [label=<
item
>]; } Properties """""""""" .. index:: pair: BrowserSearchHit; item pair: BrowserSearchHit; parent pair: BrowserSearchHit; path .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - item - :ref:`REF_MODEL_BrowserItem` - Browser item found by the search * - parent - string - The ID of the parent browser node * - path - string [] - Segments of the item path in the browser tree .. _REF_MODEL_CombinedCountItem: :index:`CombinedCountItem` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; CombinedCountItem [label=<
CombinedCountItem
items : CountItem []
>]; CountItem [label=<
CountItem
type : string
>]; edge [dir=back, arrowtail=dot] CombinedCountItem -> CountItem [label=<
items
>]; } Properties """""""""" .. index:: pair: CombinedCountItem; items .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - items - :ref:`REF_MODEL_CountItem` [] - The count items to be combined. The combination operation is defined by the type tag. .. _REF_MODEL_ContactClass: :index:`ContactClass` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; ContactClass [label=<
ContactClass
max : number
min : number
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: ContactClass; max pair: ContactClass; min .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - max - number - Upper limit of contact class interval. * - min - number - Lower limit of contact class interval. .. _REF_MODEL_ContactClassesTransformer: :index:`ContactClassesTransformer` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; ContactClassesTransformer [label=<
ContactClassesTransformer
contactClasses : ContactClass []
>]; ContactClass [label=<
ContactClass
max : number
min : number
>]; edge [dir=back, arrowtail=dot] ContactClassesTransformer -> ContactClass [label=<
contactClasses
>]; } Properties """""""""" .. index:: pair: ContactClassesTransformer; contactClasses .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - contactClasses - :ref:`REF_MODEL_ContactClass` [] - Array of contact class range expressions .. _REF_MODEL_CountCombinedItem: :index:`CountCombinedItem` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; CountCombinedItem [label=<
CountCombinedItem
max : number
min : number
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: CountCombinedItem; max pair: CountCombinedItem; min .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - max - number - Upper limit of the count of the present features. * - min - number - Lower limit of the count of the present features. .. _REF_MODEL_CountInput: :index:`CountInput` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; RateCardSelector [label=<
RateCardSelector
allowIgnoreDate : boolean
date : Date
dateRule : string
daysOfWeek : string []
seasonal : boolean
>]; ContactClassesTransformer [label=<
ContactClassesTransformer
contactClasses : ContactClass []
>]; CountInput [label=<
CountInput
conditions : TariffConditions
contactLevel : string
dataMultiplier : string
dates : DateInterval []
fields : [u'amount', u'contacts', u'contacts_k', u'contacts_M', u'cpm', u'currency', u'extrapolation_k', u'extrapolation_M', u'grossAmount', u'grp', u'index', u'netAmount', u'ots', u'percent', u'rawSample', u'sample', u'share', u'tariffStatus', u'totalAudience', u'unweightedCases'] []
filters : CountItem []
items : CountItem []
period : string
prefilter : CountItem
transformers : ContactClassesTransformer []
>]; DateInterval [label=<
DateInterval
from : string
to : string
>]; ContactClass [label=<
ContactClass
max : number
min : number
>]; GenericConditions [label=<
GenericConditions
entries : GenericConditionsEntry []
id : string
internalFrequency : integer
>]; MagazineConditions [label=<
MagazineConditions
altFormat : string
bleed : string
colorReduction : string
fallback : string
format : string
gutterBleed : string
internalFrequency : integer
style : string
>]; CountItem [label=<
CountItem
type : string
>]; OnlineConditions [label=<
OnlineConditions
adFormat : string
altAdFormat : string
fixedPriceWithShare : boolean
pricing : string
specialCpm : number
specialFixedPrice : number
specialFixedPriceIgnoresFrequency : boolean
>]; BroadcastConditions [label=<
BroadcastConditions
internalFrequency : integer
length_sec : number
>]; TariffConditions [label=<
TariffConditions
agencyCommission : number
cashDiscount : number
cinema : BroadcastConditions
generic : GenericConditions
gross : boolean
magazine : MagazineConditions
newspaper : NewspaperConditions
online : OnlineConditions
radio : BroadcastConditions
rateCard : RateCardSelector
tv : BroadcastConditions
vat : number
>]; NewspaperConditions [label=<
NewspaperConditions
colorReduction : string
format : string
internalFrequency : integer
size_mm : number
style : string
>]; GenericConditionsEntry [label=<
GenericConditionsEntry
alternateKey : string
factor : number
key : string
>]; edge [dir=back, arrowtail=dot] CountInput -> DateInterval [label=<
dates
>]; CountInput -> ContactClassesTransformer [label=<
transformers
>]; ContactClassesTransformer -> ContactClass [label=<
contactClasses
>]; CountInput -> CountItem [label=<
items
>]; CountInput -> CountItem [label=<
prefilter
>]; CountInput -> CountItem [label=<
filters
>]; CountInput -> TariffConditions [label=<
conditions
>]; TariffConditions -> GenericConditions [label=<
generic
>]; GenericConditions -> GenericConditionsEntry [label=<
entries
>]; TariffConditions -> BroadcastConditions [label=<
cinema
>]; TariffConditions -> BroadcastConditions [label=<
tv
>]; TariffConditions -> RateCardSelector [label=<
rateCard
>]; TariffConditions -> NewspaperConditions [label=<
newspaper
>]; TariffConditions -> MagazineConditions [label=<
magazine
>]; TariffConditions -> BroadcastConditions [label=<
radio
>]; TariffConditions -> OnlineConditions [label=<
online
>]; } Properties """""""""" .. index:: pair: CountInput; dates pair: CountInput; transformers pair: CountInput; items pair: CountInput; dataMultiplier pair: CountInput; period pair: CountInput; prefilter pair: CountInput; filters pair: CountInput; fields pair: CountInput; contactLevel pair: CountInput; conditions .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - dates - :ref:`REF_MODEL_DateInterval` [] - List of date intervals. * - transformers - :ref:`REF_MODEL_ContactClassesTransformer` [] - Array of transformer objects to be applied to count request. * - items - :ref:`REF_MODEL_CountItem` [] - Items to be counted. Items can be audiences, media or combinations of them. * - dataMultiplier - string - Data multiplier expression to modify performance data evaluation * - period - string - Default period for sampling. It is applied to all online media which are short-defined just by their key attribute. * - prefilter - :ref:`REF_MODEL_CountItem` - A CountItem narrowing down the population of the count request * - filters - :ref:`REF_MODEL_CountItem` [] - Array of count items to be applied as evaluation filters. * - fields - :ref:`REF_MODEL_[u'amount', u'contacts', u'contacts_k', u'contacts_M', u'cpm', u'currency', u'extrapolation_k', u'extrapolation_M', u'grossAmount', u'grp', u'index', u'netAmount', u'ots', u'percent', u'rawSample', u'sample', u'share', u'tariffStatus', u'totalAudience', u'unweightedCases']` [] - Fields to be returned (Array of field names). Defaults to contacts, rawSample, sample. * - contactLevel - string - Level of contact with advertising. Defaults to media exposure. * - conditions - :ref:`REF_MODEL_TariffConditions` - Tariff conditions to be applied to cost calculations. .. _REF_MODEL_CountItem: :index:`CountItem` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; CountItem [label=<
CountItem
type : string
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: CountItem; type .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - type - string - The subtype tag to suggest the concrete type of the count item. .. _REF_MODEL_CountResult: :index:`CountResult` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; CountResult [label=<
CountResult
contacts : number
cpm : number
rawSample : number
sample : number
status : integer
tariff : TariffResult
>]; PlanDetailsMoney [label=<
PlanDetailsMoney
amount : float
currency : string
>]; TariffResult [label=<
TariffResult
adFormat : string
afterAgencyCommission : PlanDetailsMoney
afterCashDiscount : PlanDetailsMoney
afterSpecialDiscount1 : PlanDetailsMoney
afterSpecialDiscount2 : PlanDetailsMoney
afterSpecialDiscount3 : PlanDetailsMoney
afterSpecialDiscount4 : PlanDetailsMoney
afterSpecialDiscount5 : PlanDetailsMoney
afterTariffDiscount : PlanDetailsMoney
gross : PlanDetailsMoney
net : PlanDetailsMoney
pricing : string
status : string
>]; edge [dir=back, arrowtail=dot] CountResult -> TariffResult [label=<
tariff
>]; TariffResult -> PlanDetailsMoney [label=<
gross
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount5
>]; TariffResult -> PlanDetailsMoney [label=<
afterCashDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount3
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount2
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount1
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount4
>]; TariffResult -> PlanDetailsMoney [label=<
afterTariffDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
net
>]; TariffResult -> PlanDetailsMoney [label=<
afterAgencyCommission
>]; } Properties """""""""" .. index:: pair: CountResult; status pair: CountResult; cpm pair: CountResult; contacts pair: CountResult; sample pair: CountResult; tariff pair: CountResult; rawSample .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - status - integer - A status code indicating a possible error for this result item - 0 if there is no error * - cpm - number - Cost per mill (CPM). Included if requested by fields collection of request. * - contacts - number - The number of contacts. Included by default or if requested by fields collection of request. * - sample - number - The weighted number of cases. Included by default or if requested by fields collection of request. * - tariff - :ref:`REF_MODEL_TariffResult` - Tariff specific calculation results * - rawSample - number - The raw i.e. not weighted number of cases. Included or if requested by fields collection of request. .. _REF_MODEL_DateInterval: :index:`DateInterval` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; DateInterval [label=<
DateInterval
from : string
to : string
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: DateInterval; to pair: DateInterval; from .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - to - string - Date string representation according ISO 8601. * - from - string - Date string representation according ISO 8601. .. _REF_MODEL_ExceptCombinedItem: :index:`ExceptCombinedItem` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; ExceptCombinedItem [label=<
ExceptCombinedItem
>]; edge [dir=back, arrowtail=dot] } .. _REF_MODEL_FrequencyCapping: :index:`FrequencyCapping` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; FrequencyCapping [label=<
FrequencyCapping
forTotal : boolean
impressions : integer
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: FrequencyCapping; impressions pair: FrequencyCapping; forTotal .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - impressions - integer - Number of times a specific visitor is presented the advertisement. * - forTotal - boolean - TBD. If omitted assumed to be true. .. _REF_MODEL_GenericConditions: :index:`GenericConditions` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; GenericConditions [label=<
GenericConditions
entries : GenericConditionsEntry []
id : string
internalFrequency : integer
>]; GenericConditionsEntry [label=<
GenericConditionsEntry
alternateKey : string
factor : number
key : string
>]; edge [dir=back, arrowtail=dot] GenericConditions -> GenericConditionsEntry [label=<
entries
>]; } Properties """""""""" .. index:: pair: GenericConditions; id pair: GenericConditions; internalFrequency pair: GenericConditions; entries .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - id - string - ID of this tariff conditions. * - internalFrequency - integer - Number of placements of the advertisement within the same issue. * - entries - :ref:`REF_MODEL_GenericConditionsEntry` [] - Array of generic tariff conditions entries .. _REF_MODEL_GenericConditionsEntry: :index:`GenericConditionsEntry` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; GenericConditionsEntry [label=<
GenericConditionsEntry
alternateKey : string
factor : number
key : string
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: GenericConditionsEntry; alternateKey pair: GenericConditionsEntry; key pair: GenericConditionsEntry; factor .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - alternateKey - string - Alternate key to be applied if original key is not applicable. * - key - string - Key to be applied. * - factor - number - Multiplication factor. .. _REF_MODEL_InfoAttribute: :index:`InfoAttribute` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; InfoAttribute [label=<
InfoAttribute
key : string
value : string
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: InfoAttribute; value pair: InfoAttribute; key .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - value - string - The value of the info attribute. * - key - string - The key of the info attribute. .. _REF_MODEL_IntersectionsIndividualReach: :index:`IntersectionsIndividualReach` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; IntersectionsIndividualReach [label=<
IntersectionsIndividualReach
index : number
projection : number
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: IntersectionsIndividualReach; index pair: IntersectionsIndividualReach; projection .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - index - number - Index of the related count item * - projection - number - The projection of the case number onto the population of the study .. _REF_MODEL_IntersectionsParameters: :index:`IntersectionsParameters` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; IntersectionsParameters [label=<
IntersectionsParameters
audience : CountItem
items : CountItem []
prefilter : CountItem
>]; CountItem [label=<
CountItem
type : string
>]; edge [dir=back, arrowtail=dot] IntersectionsParameters -> CountItem [label=<
prefilter
>]; IntersectionsParameters -> CountItem [label=<
items
>]; IntersectionsParameters -> CountItem [label=<
audience
>]; } Properties """""""""" .. index:: pair: IntersectionsParameters; prefilter pair: IntersectionsParameters; items pair: IntersectionsParameters; audience .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - prefilter - :ref:`REF_MODEL_CountItem` - A CountItem narrowing down the population of the intersections calculation * - items - :ref:`REF_MODEL_CountItem` [] - Count items to be included. Items can be audiences, media or combinations of them. * - audience - :ref:`REF_MODEL_CountItem` - A CountItem narrowing down the audience of the intersections calculation .. _REF_MODEL_IntersectionsPartialReach: :index:`IntersectionsPartialReach` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; IntersectionsPartialReach [label=<
IntersectionsPartialReach
index : number
projection : number
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: IntersectionsPartialReach; index pair: IntersectionsPartialReach; projection .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - index - number - Bitwise combination of the powers of two of the indexes of the involved count items * - projection - number - The projection of the case number onto the population of the study .. _REF_MODEL_IntersectionsReach: :index:`IntersectionsReach` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; IntersectionsReach [label=<
IntersectionsReach
projection : number
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: IntersectionsReach; projection .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - projection - number - The projection of the case number onto the population of the study .. _REF_MODEL_IntersectionsResults: :index:`IntersectionsResults` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; IntersectionsIndividualReach [label=<
IntersectionsIndividualReach
index : number
projection : number
>]; IntersectionsResults [label=<
IntersectionsResults
monos : IntersectionsPartialReach []
overall : IntersectionsReach
singles : IntersectionsIndividualReach []
>]; IntersectionsReach [label=<
IntersectionsReach
projection : number
>]; IntersectionsPartialReach [label=<
IntersectionsPartialReach
index : number
projection : number
>]; edge [dir=back, arrowtail=dot] IntersectionsResults -> IntersectionsIndividualReach [label=<
singles
>]; IntersectionsResults -> IntersectionsPartialReach [label=<
monos
>]; IntersectionsResults -> IntersectionsReach [label=<
overall
>]; } Properties """""""""" .. index:: pair: IntersectionsResults; singles pair: IntersectionsResults; monos pair: IntersectionsResults; overall .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - singles - :ref:`REF_MODEL_IntersectionsIndividualReach` [] - Performance data of the individual count items * - monos - :ref:`REF_MODEL_IntersectionsPartialReach` [] - Performance data of all exclusive AND-combinations of the individual count items * - overall - :ref:`REF_MODEL_IntersectionsReach` - Performance of the OR-combination of all individual count items .. _REF_MODEL_IssueDate: :index:`IssueDate` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; IssueDate [label=<
IssueDate
number : integer
unit : string
year : integer
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: IssueDate; number pair: IssueDate; unit pair: IssueDate; year .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - number - integer - The number part of the issue date. It forms an 1-based index within the year. Its unit is defined by the unit field. * - unit - string - The unit of the number component of the issue date. * - year - integer - The year part of the issue date. .. _REF_MODEL_LegacyPlan: :index:`LegacyPlan` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; RateCardSelector [label=<
RateCardSelector
allowIgnoreDate : boolean
date : Date
dateRule : string
daysOfWeek : string []
seasonal : boolean
>]; Targeting [label=<
Targeting
keys : string []
wastage : number
>]; FrequencyCapping [label=<
FrequencyCapping
forTotal : boolean
impressions : integer
>]; DateInterval [label=<
DateInterval
from : string
to : string
>]; GenericConditions [label=<
GenericConditions
entries : GenericConditionsEntry []
id : string
internalFrequency : integer
>]; MagazineConditions [label=<
MagazineConditions
altFormat : string
bleed : string
colorReduction : string
fallback : string
format : string
gutterBleed : string
internalFrequency : integer
style : string
>]; LegacyPlan [label=<
LegacyPlan
conditions : TariffConditions
dates : DateInterval []
fields : string []
filters : CountItem []
period : string
placements : Placement []
prefilter : CountItem
>]; Placement [label=<
Placement
conditions : TariffConditions
dataMultiplier : string
dates : DateInterval []
frequency : integer
frequencyCapping : FrequencyCapping
medium : Medium
pi : integer
share : number
specialDiscounts : SpecialDiscounts
tag : string
targeting : Targeting
>]; CountItem [label=<
CountItem
type : string
>]; OnlineConditions [label=<
OnlineConditions
adFormat : string
altAdFormat : string
fixedPriceWithShare : boolean
pricing : string
specialCpm : number
specialFixedPrice : number
specialFixedPriceIgnoresFrequency : boolean
>]; SpecialDiscounts [label=<
SpecialDiscounts
amount1 : number
amount2 : number
amount3 : number
amount4 : number
amount5 : number
type : string
>]; Medium [label=<
Medium
key : string
>]; BroadcastConditions [label=<
BroadcastConditions
internalFrequency : integer
length_sec : number
>]; TariffConditions [label=<
TariffConditions
agencyCommission : number
cashDiscount : number
cinema : BroadcastConditions
generic : GenericConditions
gross : boolean
magazine : MagazineConditions
newspaper : NewspaperConditions
online : OnlineConditions
radio : BroadcastConditions
rateCard : RateCardSelector
tv : BroadcastConditions
vat : number
>]; NewspaperConditions [label=<
NewspaperConditions
colorReduction : string
format : string
internalFrequency : integer
size_mm : number
style : string
>]; GenericConditionsEntry [label=<
GenericConditionsEntry
alternateKey : string
factor : number
key : string
>]; edge [dir=back, arrowtail=dot] LegacyPlan -> DateInterval [label=<
dates
>]; LegacyPlan -> CountItem [label=<
prefilter
>]; LegacyPlan -> CountItem [label=<
filters
>]; LegacyPlan -> TariffConditions [label=<
conditions
>]; TariffConditions -> GenericConditions [label=<
generic
>]; GenericConditions -> GenericConditionsEntry [label=<
entries
>]; TariffConditions -> BroadcastConditions [label=<
cinema
>]; TariffConditions -> BroadcastConditions [label=<
tv
>]; TariffConditions -> RateCardSelector [label=<
rateCard
>]; TariffConditions -> NewspaperConditions [label=<
newspaper
>]; TariffConditions -> MagazineConditions [label=<
magazine
>]; TariffConditions -> BroadcastConditions [label=<
radio
>]; TariffConditions -> OnlineConditions [label=<
online
>]; LegacyPlan -> Placement [label=<
placements
>]; Placement -> DateInterval [label=<
dates
>]; Placement -> Medium [label=<
medium
>]; Placement -> Targeting [label=<
targeting
>]; Placement -> SpecialDiscounts [label=<
specialDiscounts
>]; Placement -> FrequencyCapping [label=<
frequencyCapping
>]; Placement -> TariffConditions [label=<
conditions
>]; TariffConditions -> GenericConditions [label=<
generic
>]; GenericConditions -> GenericConditionsEntry [label=<
entries
>]; TariffConditions -> BroadcastConditions [label=<
cinema
>]; TariffConditions -> BroadcastConditions [label=<
tv
>]; TariffConditions -> RateCardSelector [label=<
rateCard
>]; TariffConditions -> NewspaperConditions [label=<
newspaper
>]; TariffConditions -> MagazineConditions [label=<
magazine
>]; TariffConditions -> BroadcastConditions [label=<
radio
>]; TariffConditions -> OnlineConditions [label=<
online
>]; } Properties """""""""" .. index:: pair: LegacyPlan; dates pair: LegacyPlan; fields pair: LegacyPlan; period pair: LegacyPlan; prefilter pair: LegacyPlan; filters pair: LegacyPlan; conditions pair: LegacyPlan; placements .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - dates - :ref:`REF_MODEL_DateInterval` [] - List of date intervals. * - fields - string [] - Fields to be returned (Array of strings) * - period - string - Default period for sampling. It is applied to all online media in placements which are short-defined just by their key attribute. * - prefilter - :ref:`REF_MODEL_CountItem` - A CountItem narrowing down the population of the plan * - filters - :ref:`REF_MODEL_CountItem` [] - Array of count items to be applied as evaluation filters. * - conditions - :ref:`REF_MODEL_TariffConditions` - Tariff conditions to be applied to all placements. * - placements - :ref:`REF_MODEL_Placement` [] - Advertisement placements (Array of Placement objects) .. _REF_MODEL_MagazineConditions: :index:`MagazineConditions` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; MagazineConditions [label=<
MagazineConditions
altFormat : string
bleed : string
colorReduction : string
fallback : string
format : string
gutterBleed : string
internalFrequency : integer
style : string
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: MagazineConditions; style pair: MagazineConditions; format pair: MagazineConditions; internalFrequency pair: MagazineConditions; gutterBleed pair: MagazineConditions; altFormat pair: MagazineConditions; colorReduction pair: MagazineConditions; fallback pair: MagazineConditions; bleed .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - style - string - Print style. * - format - string - Advertisement print format id. * - internalFrequency - integer - Number of placements of the advertisement within the same issue. * - gutterBleed - string - Gutter bleed demand. (Print across gutter.) * - altFormat - string - Alternative advertisement print format id. * - colorReduction - string - Allowed way of color reduction. * - fallback - string - Allowed fallback format selection. * - bleed - string - Bleed demand. .. _REF_MODEL_Marketer: :index:`Marketer` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; Marketer [label=<
Marketer
agofId : string
id : string
name : string
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: Marketer; id pair: Marketer; agofId pair: Marketer; name .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - id - string - The ID of the marketer * - agofId - string - AGOF ID of the marketer. * - name - string - The name of the marketer .. _REF_MODEL_MediaCountResult: :index:`MediaCountResult` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; MediaCountResult [label=<
MediaCountResult
contacts : number
cpm : number
key : string
rawSample : number
sample : number
status : integer
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: MediaCountResult; status pair: MediaCountResult; cpm pair: MediaCountResult; contacts pair: MediaCountResult; sample pair: MediaCountResult; key pair: MediaCountResult; rawSample .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - status - integer - A status code indicating a possible error for this result item - 0 if there is no error * - cpm - number - Cost per mill (CPM). Included if requested by fields collection of request. * - contacts - number - The number of contacts. Included by default or if requested by fields collection of request. * - sample - number - The weighted number of cases. Included by default or if requested by fields collection of request. * - key - string - The key of the medium which corresponds to the result item. Included by default or if requested by fields collection of request. * - rawSample - number - The raw i.e. not weighted number of cases. Included or if requested by fields collection of request. .. _REF_MODEL_MediaSearchInput: :index:`MediaSearchInput` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; DateInterval [label=<
DateInterval
from : string
to : string
>]; MediaSearchInput [label=<
MediaSearchInput
dates : DateInterval []
fields : string []
where : WhereClause
>]; edge [dir=back, arrowtail=dot] MediaSearchInput -> DateInterval [label=<
dates
>]; } Properties """""""""" .. index:: pair: MediaSearchInput; fields pair: MediaSearchInput; dates pair: MediaSearchInput; where .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - fields - string [] - List of fields to return for all matching media objects. * - dates - :ref:`REF_MODEL_DateInterval` [] - List of date intervals. * - where - :ref:`REF_MODEL_WhereClause` - .. _REF_MODEL_Medium: :index:`Medium` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; Medium [label=<
Medium
key : string
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: Medium; key .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - key - string - The key of the medium in the analysis. .. _REF_MODEL_NewspaperConditions: :index:`NewspaperConditions` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; NewspaperConditions [label=<
NewspaperConditions
colorReduction : string
format : string
internalFrequency : integer
size_mm : number
style : string
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: NewspaperConditions; style pair: NewspaperConditions; size_mm pair: NewspaperConditions; internalFrequency pair: NewspaperConditions; colorReduction pair: NewspaperConditions; format .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - style - string - Print style. * - size_mm - number - Arbitrary advertisement size in millimeters. Overrules format property if provided. * - internalFrequency - integer - Number of placements of the advertisement within the same issue. * - colorReduction - string - Allowed way of color reduction. * - format - string - Advertisement print format id. .. _REF_MODEL_NotCombinedItem: :index:`NotCombinedItem` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; NotCombinedItem [label=<
NotCombinedItem
>]; edge [dir=back, arrowtail=dot] } .. _REF_MODEL_OnlineConditions: :index:`OnlineConditions` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; OnlineConditions [label=<
OnlineConditions
adFormat : string
altAdFormat : string
fixedPriceWithShare : boolean
pricing : string
specialCpm : number
specialFixedPrice : number
specialFixedPriceIgnoresFrequency : boolean
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: OnlineConditions; specialFixedPriceIgnoresFrequency pair: OnlineConditions; specialFixedPrice pair: OnlineConditions; altAdFormat pair: OnlineConditions; pricing pair: OnlineConditions; fixedPriceWithShare pair: OnlineConditions; adFormat pair: OnlineConditions; specialCpm .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - specialFixedPriceIgnoresFrequency - boolean - Flag indicating if a present special fixed price ignores the frequency. * - specialFixedPrice - number - Possibly negotiated special fixed price. * - altAdFormat - string - Alternative advertisement format. * - pricing - string - * - fixedPriceWithShare - boolean - Flag indicating if the fixed price is applied with share. * - adFormat - string - Advertisement format. * - specialCpm - number - Possibly negotiated special cpm price. .. _REF_MODEL_OnlineMedium: :index:`OnlineMedium` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; RateCardSelector [label=<
RateCardSelector
allowIgnoreDate : boolean
date : Date
dateRule : string
daysOfWeek : string []
seasonal : boolean
>]; DateInterval [label=<
DateInterval
from : string
to : string
>]; GenericConditions [label=<
GenericConditions
entries : GenericConditionsEntry []
id : string
internalFrequency : integer
>]; MagazineConditions [label=<
MagazineConditions
altFormat : string
bleed : string
colorReduction : string
fallback : string
format : string
gutterBleed : string
internalFrequency : integer
style : string
>]; OnlineConditions [label=<
OnlineConditions
adFormat : string
altAdFormat : string
fixedPriceWithShare : boolean
pricing : string
specialCpm : number
specialFixedPrice : number
specialFixedPriceIgnoresFrequency : boolean
>]; BroadcastConditions [label=<
BroadcastConditions
internalFrequency : integer
length_sec : number
>]; TariffConditions [label=<
TariffConditions
agencyCommission : number
cashDiscount : number
cinema : BroadcastConditions
generic : GenericConditions
gross : boolean
magazine : MagazineConditions
newspaper : NewspaperConditions
online : OnlineConditions
radio : BroadcastConditions
rateCard : RateCardSelector
tv : BroadcastConditions
vat : number
>]; NewspaperConditions [label=<
NewspaperConditions
colorReduction : string
format : string
internalFrequency : integer
size_mm : number
style : string
>]; OnlineMedium [label=<
OnlineMedium
conditions : TariffConditions
dates : DateInterval []
key : string
period : string
>]; GenericConditionsEntry [label=<
GenericConditionsEntry
alternateKey : string
factor : number
key : string
>]; edge [dir=back, arrowtail=dot] OnlineMedium -> DateInterval [label=<
dates
>]; OnlineMedium -> TariffConditions [label=<
conditions
>]; TariffConditions -> GenericConditions [label=<
generic
>]; GenericConditions -> GenericConditionsEntry [label=<
entries
>]; TariffConditions -> BroadcastConditions [label=<
cinema
>]; TariffConditions -> BroadcastConditions [label=<
tv
>]; TariffConditions -> RateCardSelector [label=<
rateCard
>]; TariffConditions -> NewspaperConditions [label=<
newspaper
>]; TariffConditions -> MagazineConditions [label=<
magazine
>]; TariffConditions -> BroadcastConditions [label=<
radio
>]; TariffConditions -> OnlineConditions [label=<
online
>]; } Properties """""""""" .. index:: pair: OnlineMedium; dates pair: OnlineMedium; conditions pair: OnlineMedium; period pair: OnlineMedium; key .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - dates - :ref:`REF_MODEL_DateInterval` [] - List of date intervals. * - conditions - :ref:`REF_MODEL_TariffConditions` - Tariff conditions to be applied to evaluation of that individual medium * - period - string - Reference period for sampling and extrapolation. Can be omitted if a default period is provided with the request. * - key - string - The key of the medium in the analysis. .. _REF_MODEL_OrCombinedItem: :index:`OrCombinedItem` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; OrCombinedItem [label=<
OrCombinedItem
>]; edge [dir=back, arrowtail=dot] } .. _REF_MODEL_Period: :index:`Period` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; Period [label=<
Period
description : string
key : string
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: Period; description pair: Period; key .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - description - string - The description of the period. * - key - string - The key to reference this period. .. _REF_MODEL_PeriodsDictionary: :index:`PeriodsDictionary` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; PeriodsDictionary [label=<
PeriodsDictionary
>]; edge [dir=back, arrowtail=dot] } .. _REF_MODEL_Placement: :index:`Placement` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; RateCardSelector [label=<
RateCardSelector
allowIgnoreDate : boolean
date : Date
dateRule : string
daysOfWeek : string []
seasonal : boolean
>]; Targeting [label=<
Targeting
keys : string []
wastage : number
>]; FrequencyCapping [label=<
FrequencyCapping
forTotal : boolean
impressions : integer
>]; DateInterval [label=<
DateInterval
from : string
to : string
>]; GenericConditions [label=<
GenericConditions
entries : GenericConditionsEntry []
id : string
internalFrequency : integer
>]; MagazineConditions [label=<
MagazineConditions
altFormat : string
bleed : string
colorReduction : string
fallback : string
format : string
gutterBleed : string
internalFrequency : integer
style : string
>]; Placement [label=<
Placement
conditions : TariffConditions
dataMultiplier : string
dates : DateInterval []
frequency : integer
frequencyCapping : FrequencyCapping
medium : Medium
pi : integer
share : number
specialDiscounts : SpecialDiscounts
tag : string
targeting : Targeting
>]; OnlineConditions [label=<
OnlineConditions
adFormat : string
altAdFormat : string
fixedPriceWithShare : boolean
pricing : string
specialCpm : number
specialFixedPrice : number
specialFixedPriceIgnoresFrequency : boolean
>]; SpecialDiscounts [label=<
SpecialDiscounts
amount1 : number
amount2 : number
amount3 : number
amount4 : number
amount5 : number
type : string
>]; Medium [label=<
Medium
key : string
>]; BroadcastConditions [label=<
BroadcastConditions
internalFrequency : integer
length_sec : number
>]; TariffConditions [label=<
TariffConditions
agencyCommission : number
cashDiscount : number
cinema : BroadcastConditions
generic : GenericConditions
gross : boolean
magazine : MagazineConditions
newspaper : NewspaperConditions
online : OnlineConditions
radio : BroadcastConditions
rateCard : RateCardSelector
tv : BroadcastConditions
vat : number
>]; NewspaperConditions [label=<
NewspaperConditions
colorReduction : string
format : string
internalFrequency : integer
size_mm : number
style : string
>]; GenericConditionsEntry [label=<
GenericConditionsEntry
alternateKey : string
factor : number
key : string
>]; edge [dir=back, arrowtail=dot] Placement -> DateInterval [label=<
dates
>]; Placement -> Medium [label=<
medium
>]; Placement -> Targeting [label=<
targeting
>]; Placement -> SpecialDiscounts [label=<
specialDiscounts
>]; Placement -> FrequencyCapping [label=<
frequencyCapping
>]; Placement -> TariffConditions [label=<
conditions
>]; TariffConditions -> GenericConditions [label=<
generic
>]; GenericConditions -> GenericConditionsEntry [label=<
entries
>]; TariffConditions -> BroadcastConditions [label=<
cinema
>]; TariffConditions -> BroadcastConditions [label=<
tv
>]; TariffConditions -> RateCardSelector [label=<
rateCard
>]; TariffConditions -> NewspaperConditions [label=<
newspaper
>]; TariffConditions -> MagazineConditions [label=<
magazine
>]; TariffConditions -> BroadcastConditions [label=<
radio
>]; TariffConditions -> OnlineConditions [label=<
online
>]; } Properties """""""""" .. index:: pair: Placement; dates pair: Placement; medium pair: Placement; targeting pair: Placement; dataMultiplier pair: Placement; share pair: Placement; specialDiscounts pair: Placement; frequency pair: Placement; tag pair: Placement; frequencyCapping pair: Placement; pi pair: Placement; conditions .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - dates - :ref:`REF_MODEL_DateInterval` [] - List of date intervals. * - medium - :ref:`REF_MODEL_Medium` - Medium to be placed. Alternatively an index number into media table of plan my be provided. * - targeting - :ref:`REF_MODEL_Targeting` - Targeting to be applied to the placement. If omitted no targeting is applied. * - dataMultiplier - string - Data multiplier expression to modify performance data evaluation * - share - number - Fraction of delivered pages to be allocated. * - specialDiscounts - :ref:`REF_MODEL_SpecialDiscounts` - Possibly allowed special discounts. * - frequency - integer - The frequency of the placement. * - tag - string - Tag to mark the placement for subsequent identification in plan details result * - frequencyCapping - :ref:`REF_MODEL_FrequencyCapping` - Frequency capping to be applied to the placement. If omitted no frequency capping is applied. * - pi - integer - Page impressions to be delivered. * - conditions - :ref:`REF_MODEL_TariffConditions` - Tariff conditions to be applied to that individual placement. .. _REF_MODEL_Plan: :index:`Plan` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; RateCardSelector [label=<
RateCardSelector
allowIgnoreDate : boolean
date : Date
dateRule : string
daysOfWeek : string []
seasonal : boolean
>]; Targeting [label=<
Targeting
keys : string []
wastage : number
>]; FrequencyCapping [label=<
FrequencyCapping
forTotal : boolean
impressions : integer
>]; DateInterval [label=<
DateInterval
from : string
to : string
>]; GenericConditions [label=<
GenericConditions
entries : GenericConditionsEntry []
id : string
internalFrequency : integer
>]; Plan [label=<
Plan
media : CountItem []
placements : Placement []
>]; MagazineConditions [label=<
MagazineConditions
altFormat : string
bleed : string
colorReduction : string
fallback : string
format : string
gutterBleed : string
internalFrequency : integer
style : string
>]; Placement [label=<
Placement
conditions : TariffConditions
dataMultiplier : string
dates : DateInterval []
frequency : integer
frequencyCapping : FrequencyCapping
medium : Medium
pi : integer
share : number
specialDiscounts : SpecialDiscounts
tag : string
targeting : Targeting
>]; CountItem [label=<
CountItem
type : string
>]; OnlineConditions [label=<
OnlineConditions
adFormat : string
altAdFormat : string
fixedPriceWithShare : boolean
pricing : string
specialCpm : number
specialFixedPrice : number
specialFixedPriceIgnoresFrequency : boolean
>]; SpecialDiscounts [label=<
SpecialDiscounts
amount1 : number
amount2 : number
amount3 : number
amount4 : number
amount5 : number
type : string
>]; Medium [label=<
Medium
key : string
>]; BroadcastConditions [label=<
BroadcastConditions
internalFrequency : integer
length_sec : number
>]; TariffConditions [label=<
TariffConditions
agencyCommission : number
cashDiscount : number
cinema : BroadcastConditions
generic : GenericConditions
gross : boolean
magazine : MagazineConditions
newspaper : NewspaperConditions
online : OnlineConditions
radio : BroadcastConditions
rateCard : RateCardSelector
tv : BroadcastConditions
vat : number
>]; NewspaperConditions [label=<
NewspaperConditions
colorReduction : string
format : string
internalFrequency : integer
size_mm : number
style : string
>]; GenericConditionsEntry [label=<
GenericConditionsEntry
alternateKey : string
factor : number
key : string
>]; edge [dir=back, arrowtail=dot] Plan -> CountItem [label=<
media
>]; Plan -> Placement [label=<
placements
>]; Placement -> DateInterval [label=<
dates
>]; Placement -> Medium [label=<
medium
>]; Placement -> Targeting [label=<
targeting
>]; Placement -> SpecialDiscounts [label=<
specialDiscounts
>]; Placement -> FrequencyCapping [label=<
frequencyCapping
>]; Placement -> TariffConditions [label=<
conditions
>]; TariffConditions -> GenericConditions [label=<
generic
>]; GenericConditions -> GenericConditionsEntry [label=<
entries
>]; TariffConditions -> BroadcastConditions [label=<
cinema
>]; TariffConditions -> BroadcastConditions [label=<
tv
>]; TariffConditions -> RateCardSelector [label=<
rateCard
>]; TariffConditions -> NewspaperConditions [label=<
newspaper
>]; TariffConditions -> MagazineConditions [label=<
magazine
>]; TariffConditions -> BroadcastConditions [label=<
radio
>]; TariffConditions -> OnlineConditions [label=<
online
>]; } Properties """""""""" .. index:: pair: Plan; media pair: Plan; placements .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - media - :ref:`REF_MODEL_CountItem` [] - Array of media objects to be referenced by the placements via an index instead of providing embedded media objects * - placements - :ref:`REF_MODEL_Placement` [] - Advertisement placements (Array of Placement objects) .. _REF_MODEL_PlanCombinedItem: :index:`PlanCombinedItem` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; PlanCombinedItem [label=<
PlanCombinedItem
>]; edge [dir=back, arrowtail=dot] } .. _REF_MODEL_PlanDetails: :index:`PlanDetails` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; PlanDetailsResult [label=<
PlanDetailsResult
audience : PlanDetailsAudienceResult
cases : float
contacts : float
contactsShare : float
cpm : PlanDetailsMoney
cpmGross : PlanDetailsMoney
cpmNet : PlanDetailsMoney
cpmUser : PlanDetailsMoney
grp : float
grpIndex : float
index : float
ots : float
percent : float
prefilter : PlanDetailsAudienceResult
projection : float
rawCases : float
share : float
structure : PlanDetailsMediumResult
tariff : TariffResult
total : float
>]; PlanDetailsOnlineData [label=<
PlanDetailsOnlineData
basisCpm : PlanDetailsMoney
eventualShare : float
fcExtraCpm : PlanDetailsMoney
fcForTotal : boolean
frequencyCapping : integer
pi : float
piMax : float
rateCardCpm : PlanDetailsMoney
targetingExtraCpm : PlanDetailsMoney
targetingId : string
targetingSummaryLong : string
targetingSummaryShort : string
totalCpm : PlanDetailsMoney
>]; PlanDetailsMediumResult [label=<
PlanDetailsMediumResult
cases : float
contacts : float
projection : float
>]; PlanDetails [label=<
PlanDetails
groupDetails : PlanDetailsGroupDetails []
result : PlanDetailsResult
>]; PlanDetailsMedium [label=<
PlanDetailsMedium
placements : PlanDetailsPlacement []
result : PlanDetailsResult
>]; PlanDetailsPlacement [label=<
PlanDetailsPlacement
online : PlanDetailsOnlineData
result : PlanDetailsResult
tag : string
>]; PlanDetailsMoney [label=<
PlanDetailsMoney
amount : float
currency : string
>]; PlanDetailsMediumResult [label=<
PlanDetailsMediumResult
cases : float
projection : float
>]; PlanDetailsGroupDetails [label=<
PlanDetailsGroupDetails
groupType : string
media : PlanDetailsMedium []
result : PlanDetailsResult
>]; TariffResult [label=<
TariffResult
adFormat : string
afterAgencyCommission : PlanDetailsMoney
afterCashDiscount : PlanDetailsMoney
afterSpecialDiscount1 : PlanDetailsMoney
afterSpecialDiscount2 : PlanDetailsMoney
afterSpecialDiscount3 : PlanDetailsMoney
afterSpecialDiscount4 : PlanDetailsMoney
afterSpecialDiscount5 : PlanDetailsMoney
afterTariffDiscount : PlanDetailsMoney
gross : PlanDetailsMoney
net : PlanDetailsMoney
pricing : string
status : string
>]; edge [dir=back, arrowtail=dot] PlanDetails -> PlanDetailsResult [label=<
result
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmNet
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpm
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmUser
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
audience
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
prefilter
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmGross
>]; PlanDetailsResult -> TariffResult [label=<
tariff
>]; TariffResult -> PlanDetailsMoney [label=<
gross
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount5
>]; TariffResult -> PlanDetailsMoney [label=<
afterCashDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount3
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount2
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount1
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount4
>]; TariffResult -> PlanDetailsMoney [label=<
afterTariffDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
net
>]; TariffResult -> PlanDetailsMoney [label=<
afterAgencyCommission
>]; PlanDetailsResult -> PlanDetailsMediumResult [label=<
structure
>]; PlanDetails -> PlanDetailsGroupDetails [label=<
groupDetails
>]; PlanDetailsGroupDetails -> PlanDetailsMedium [label=<
media
>]; PlanDetailsMedium -> PlanDetailsResult [label=<
result
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmNet
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpm
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmUser
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
audience
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
prefilter
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmGross
>]; PlanDetailsResult -> TariffResult [label=<
tariff
>]; TariffResult -> PlanDetailsMoney [label=<
gross
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount5
>]; TariffResult -> PlanDetailsMoney [label=<
afterCashDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount3
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount2
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount1
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount4
>]; TariffResult -> PlanDetailsMoney [label=<
afterTariffDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
net
>]; TariffResult -> PlanDetailsMoney [label=<
afterAgencyCommission
>]; PlanDetailsResult -> PlanDetailsMediumResult [label=<
structure
>]; PlanDetailsMedium -> PlanDetailsPlacement [label=<
placements
>]; PlanDetailsPlacement -> PlanDetailsResult [label=<
result
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmNet
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpm
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmUser
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
audience
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
prefilter
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmGross
>]; PlanDetailsResult -> TariffResult [label=<
tariff
>]; TariffResult -> PlanDetailsMoney [label=<
gross
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount5
>]; TariffResult -> PlanDetailsMoney [label=<
afterCashDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount3
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount2
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount1
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount4
>]; TariffResult -> PlanDetailsMoney [label=<
afterTariffDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
net
>]; TariffResult -> PlanDetailsMoney [label=<
afterAgencyCommission
>]; PlanDetailsResult -> PlanDetailsMediumResult [label=<
structure
>]; PlanDetailsPlacement -> PlanDetailsOnlineData [label=<
online
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
fcExtraCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
targetingExtraCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
rateCardCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
basisCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
totalCpm
>]; PlanDetailsGroupDetails -> PlanDetailsResult [label=<
result
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmNet
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpm
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmUser
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
audience
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
prefilter
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmGross
>]; PlanDetailsResult -> TariffResult [label=<
tariff
>]; TariffResult -> PlanDetailsMoney [label=<
gross
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount5
>]; TariffResult -> PlanDetailsMoney [label=<
afterCashDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount3
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount2
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount1
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount4
>]; TariffResult -> PlanDetailsMoney [label=<
afterTariffDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
net
>]; TariffResult -> PlanDetailsMoney [label=<
afterAgencyCommission
>]; PlanDetailsResult -> PlanDetailsMediumResult [label=<
structure
>]; } Properties """""""""" .. index:: pair: PlanDetails; result pair: PlanDetails; groupDetails .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - result - :ref:`REF_MODEL_PlanDetailsResult` - * - groupDetails - :ref:`REF_MODEL_PlanDetailsGroupDetails` [] - Group of media and placements .. _REF_MODEL_PlanDetailsAudienceResult: :index:`PlanDetailsAudienceResult` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; PlanDetailsMediumResult [label=<
PlanDetailsMediumResult
cases : float
projection : float
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: PlanDetailsAudienceResult; cases pair: PlanDetailsAudienceResult; projection .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - cases - :ref:`REF_MODEL_float` - Cases * - projection - :ref:`REF_MODEL_float` - Projection of the cases at the overall audience of the underlying study .. _REF_MODEL_PlanDetailsGroupDetails: :index:`PlanDetailsGroupDetails` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; PlanDetailsResult [label=<
PlanDetailsResult
audience : PlanDetailsAudienceResult
cases : float
contacts : float
contactsShare : float
cpm : PlanDetailsMoney
cpmGross : PlanDetailsMoney
cpmNet : PlanDetailsMoney
cpmUser : PlanDetailsMoney
grp : float
grpIndex : float
index : float
ots : float
percent : float
prefilter : PlanDetailsAudienceResult
projection : float
rawCases : float
share : float
structure : PlanDetailsMediumResult
tariff : TariffResult
total : float
>]; PlanDetailsOnlineData [label=<
PlanDetailsOnlineData
basisCpm : PlanDetailsMoney
eventualShare : float
fcExtraCpm : PlanDetailsMoney
fcForTotal : boolean
frequencyCapping : integer
pi : float
piMax : float
rateCardCpm : PlanDetailsMoney
targetingExtraCpm : PlanDetailsMoney
targetingId : string
targetingSummaryLong : string
targetingSummaryShort : string
totalCpm : PlanDetailsMoney
>]; PlanDetailsMediumResult [label=<
PlanDetailsMediumResult
cases : float
contacts : float
projection : float
>]; PlanDetailsMedium [label=<
PlanDetailsMedium
placements : PlanDetailsPlacement []
result : PlanDetailsResult
>]; PlanDetailsPlacement [label=<
PlanDetailsPlacement
online : PlanDetailsOnlineData
result : PlanDetailsResult
tag : string
>]; PlanDetailsMoney [label=<
PlanDetailsMoney
amount : float
currency : string
>]; PlanDetailsMediumResult [label=<
PlanDetailsMediumResult
cases : float
projection : float
>]; PlanDetailsGroupDetails [label=<
PlanDetailsGroupDetails
groupType : string
media : PlanDetailsMedium []
result : PlanDetailsResult
>]; TariffResult [label=<
TariffResult
adFormat : string
afterAgencyCommission : PlanDetailsMoney
afterCashDiscount : PlanDetailsMoney
afterSpecialDiscount1 : PlanDetailsMoney
afterSpecialDiscount2 : PlanDetailsMoney
afterSpecialDiscount3 : PlanDetailsMoney
afterSpecialDiscount4 : PlanDetailsMoney
afterSpecialDiscount5 : PlanDetailsMoney
afterTariffDiscount : PlanDetailsMoney
gross : PlanDetailsMoney
net : PlanDetailsMoney
pricing : string
status : string
>]; edge [dir=back, arrowtail=dot] PlanDetailsGroupDetails -> PlanDetailsMedium [label=<
media
>]; PlanDetailsMedium -> PlanDetailsResult [label=<
result
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmNet
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpm
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmUser
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
audience
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
prefilter
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmGross
>]; PlanDetailsResult -> TariffResult [label=<
tariff
>]; TariffResult -> PlanDetailsMoney [label=<
gross
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount5
>]; TariffResult -> PlanDetailsMoney [label=<
afterCashDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount3
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount2
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount1
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount4
>]; TariffResult -> PlanDetailsMoney [label=<
afterTariffDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
net
>]; TariffResult -> PlanDetailsMoney [label=<
afterAgencyCommission
>]; PlanDetailsResult -> PlanDetailsMediumResult [label=<
structure
>]; PlanDetailsMedium -> PlanDetailsPlacement [label=<
placements
>]; PlanDetailsPlacement -> PlanDetailsResult [label=<
result
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmNet
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpm
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmUser
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
audience
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
prefilter
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmGross
>]; PlanDetailsResult -> TariffResult [label=<
tariff
>]; TariffResult -> PlanDetailsMoney [label=<
gross
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount5
>]; TariffResult -> PlanDetailsMoney [label=<
afterCashDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount3
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount2
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount1
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount4
>]; TariffResult -> PlanDetailsMoney [label=<
afterTariffDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
net
>]; TariffResult -> PlanDetailsMoney [label=<
afterAgencyCommission
>]; PlanDetailsResult -> PlanDetailsMediumResult [label=<
structure
>]; PlanDetailsPlacement -> PlanDetailsOnlineData [label=<
online
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
fcExtraCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
targetingExtraCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
rateCardCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
basisCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
totalCpm
>]; PlanDetailsGroupDetails -> PlanDetailsResult [label=<
result
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmNet
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpm
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmUser
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
audience
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
prefilter
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmGross
>]; PlanDetailsResult -> TariffResult [label=<
tariff
>]; TariffResult -> PlanDetailsMoney [label=<
gross
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount5
>]; TariffResult -> PlanDetailsMoney [label=<
afterCashDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount3
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount2
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount1
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount4
>]; TariffResult -> PlanDetailsMoney [label=<
afterTariffDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
net
>]; TariffResult -> PlanDetailsMoney [label=<
afterAgencyCommission
>]; PlanDetailsResult -> PlanDetailsMediumResult [label=<
structure
>]; } Properties """""""""" .. index:: pair: PlanDetailsGroupDetails; groupType pair: PlanDetailsGroupDetails; media pair: PlanDetailsGroupDetails; result .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - groupType - string - * - media - :ref:`REF_MODEL_PlanDetailsMedium` [] - List of media in this group * - result - :ref:`REF_MODEL_PlanDetailsResult` - .. _REF_MODEL_PlanDetailsMedium: :index:`PlanDetailsMedium` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; PlanDetailsResult [label=<
PlanDetailsResult
audience : PlanDetailsAudienceResult
cases : float
contacts : float
contactsShare : float
cpm : PlanDetailsMoney
cpmGross : PlanDetailsMoney
cpmNet : PlanDetailsMoney
cpmUser : PlanDetailsMoney
grp : float
grpIndex : float
index : float
ots : float
percent : float
prefilter : PlanDetailsAudienceResult
projection : float
rawCases : float
share : float
structure : PlanDetailsMediumResult
tariff : TariffResult
total : float
>]; PlanDetailsOnlineData [label=<
PlanDetailsOnlineData
basisCpm : PlanDetailsMoney
eventualShare : float
fcExtraCpm : PlanDetailsMoney
fcForTotal : boolean
frequencyCapping : integer
pi : float
piMax : float
rateCardCpm : PlanDetailsMoney
targetingExtraCpm : PlanDetailsMoney
targetingId : string
targetingSummaryLong : string
targetingSummaryShort : string
totalCpm : PlanDetailsMoney
>]; PlanDetailsMediumResult [label=<
PlanDetailsMediumResult
cases : float
contacts : float
projection : float
>]; PlanDetailsMedium [label=<
PlanDetailsMedium
placements : PlanDetailsPlacement []
result : PlanDetailsResult
>]; PlanDetailsPlacement [label=<
PlanDetailsPlacement
online : PlanDetailsOnlineData
result : PlanDetailsResult
tag : string
>]; PlanDetailsMoney [label=<
PlanDetailsMoney
amount : float
currency : string
>]; PlanDetailsMediumResult [label=<
PlanDetailsMediumResult
cases : float
projection : float
>]; TariffResult [label=<
TariffResult
adFormat : string
afterAgencyCommission : PlanDetailsMoney
afterCashDiscount : PlanDetailsMoney
afterSpecialDiscount1 : PlanDetailsMoney
afterSpecialDiscount2 : PlanDetailsMoney
afterSpecialDiscount3 : PlanDetailsMoney
afterSpecialDiscount4 : PlanDetailsMoney
afterSpecialDiscount5 : PlanDetailsMoney
afterTariffDiscount : PlanDetailsMoney
gross : PlanDetailsMoney
net : PlanDetailsMoney
pricing : string
status : string
>]; edge [dir=back, arrowtail=dot] PlanDetailsMedium -> PlanDetailsResult [label=<
result
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmNet
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpm
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmUser
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
audience
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
prefilter
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmGross
>]; PlanDetailsResult -> TariffResult [label=<
tariff
>]; TariffResult -> PlanDetailsMoney [label=<
gross
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount5
>]; TariffResult -> PlanDetailsMoney [label=<
afterCashDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount3
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount2
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount1
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount4
>]; TariffResult -> PlanDetailsMoney [label=<
afterTariffDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
net
>]; TariffResult -> PlanDetailsMoney [label=<
afterAgencyCommission
>]; PlanDetailsResult -> PlanDetailsMediumResult [label=<
structure
>]; PlanDetailsMedium -> PlanDetailsPlacement [label=<
placements
>]; PlanDetailsPlacement -> PlanDetailsResult [label=<
result
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmNet
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpm
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmUser
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
audience
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
prefilter
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmGross
>]; PlanDetailsResult -> TariffResult [label=<
tariff
>]; TariffResult -> PlanDetailsMoney [label=<
gross
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount5
>]; TariffResult -> PlanDetailsMoney [label=<
afterCashDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount3
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount2
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount1
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount4
>]; TariffResult -> PlanDetailsMoney [label=<
afterTariffDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
net
>]; TariffResult -> PlanDetailsMoney [label=<
afterAgencyCommission
>]; PlanDetailsResult -> PlanDetailsMediumResult [label=<
structure
>]; PlanDetailsPlacement -> PlanDetailsOnlineData [label=<
online
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
fcExtraCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
targetingExtraCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
rateCardCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
basisCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
totalCpm
>]; } Properties """""""""" .. index:: pair: PlanDetailsMedium; result pair: PlanDetailsMedium; placements .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - result - :ref:`REF_MODEL_PlanDetailsResult` - * - placements - :ref:`REF_MODEL_PlanDetailsPlacement` [] - List of media in this group .. _REF_MODEL_PlanDetailsMediumResult: :index:`PlanDetailsMediumResult` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; PlanDetailsMediumResult [label=<
PlanDetailsMediumResult
cases : float
contacts : float
projection : float
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: PlanDetailsMediumResult; cases pair: PlanDetailsMediumResult; projection pair: PlanDetailsMediumResult; contacts .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - cases - :ref:`REF_MODEL_float` - Cases * - projection - :ref:`REF_MODEL_float` - Projection of the cases at the overall audience of the underlying study * - contacts - :ref:`REF_MODEL_float` - Contacts .. _REF_MODEL_PlanDetailsMoney: :index:`PlanDetailsMoney` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; PlanDetailsMoney [label=<
PlanDetailsMoney
amount : float
currency : string
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: PlanDetailsMoney; currency pair: PlanDetailsMoney; amount .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - currency - string - Currency of money * - amount - :ref:`REF_MODEL_float` - Amount of money .. _REF_MODEL_PlanDetailsOnlineData: :index:`PlanDetailsOnlineData` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; PlanDetailsOnlineData [label=<
PlanDetailsOnlineData
basisCpm : PlanDetailsMoney
eventualShare : float
fcExtraCpm : PlanDetailsMoney
fcForTotal : boolean
frequencyCapping : integer
pi : float
piMax : float
rateCardCpm : PlanDetailsMoney
targetingExtraCpm : PlanDetailsMoney
targetingId : string
targetingSummaryLong : string
targetingSummaryShort : string
totalCpm : PlanDetailsMoney
>]; PlanDetailsMoney [label=<
PlanDetailsMoney
amount : float
currency : string
>]; edge [dir=back, arrowtail=dot] PlanDetailsOnlineData -> PlanDetailsMoney [label=<
fcExtraCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
targetingExtraCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
rateCardCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
basisCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
totalCpm
>]; } Properties """""""""" .. index:: pair: PlanDetailsOnlineData; targetingSummaryLong pair: PlanDetailsOnlineData; piMax pair: PlanDetailsOnlineData; targetingId pair: PlanDetailsOnlineData; fcExtraCpm pair: PlanDetailsOnlineData; eventualShare pair: PlanDetailsOnlineData; fcForTotal pair: PlanDetailsOnlineData; targetingExtraCpm pair: PlanDetailsOnlineData; rateCardCpm pair: PlanDetailsOnlineData; targetingSummaryShort pair: PlanDetailsOnlineData; basisCpm pair: PlanDetailsOnlineData; totalCpm pair: PlanDetailsOnlineData; frequencyCapping pair: PlanDetailsOnlineData; pi .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - targetingSummaryLong - string - Long summary of the applied targeting features and their combination * - piMax - :ref:`REF_MODEL_float` - Maximum page impressions * - targetingId - string - Actually applied targeting ID * - fcExtraCpm - :ref:`REF_MODEL_PlanDetailsMoney` - Extra CPM caused by frequency capping * - eventualShare - :ref:`REF_MODEL_float` - Eventual share considering frequency capping and targeting * - fcForTotal - boolean - Frequency capping for total flag * - targetingExtraCpm - :ref:`REF_MODEL_PlanDetailsMoney` - Extra CPM caused by targeting * - rateCardCpm - :ref:`REF_MODEL_PlanDetailsMoney` - The CPM from the rate card * - targetingSummaryShort - string - Short summary of the applied targeting features and their combination * - basisCpm - :ref:`REF_MODEL_PlanDetailsMoney` - Applied basis CPM * - totalCpm - :ref:`REF_MODEL_PlanDetailsMoney` - Resulting total CPM of the placement * - frequencyCapping - integer - Actually applied frequency capping * - pi - :ref:`REF_MODEL_float` - Page impressions .. _REF_MODEL_PlanDetailsPlacement: :index:`PlanDetailsPlacement` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; PlanDetailsResult [label=<
PlanDetailsResult
audience : PlanDetailsAudienceResult
cases : float
contacts : float
contactsShare : float
cpm : PlanDetailsMoney
cpmGross : PlanDetailsMoney
cpmNet : PlanDetailsMoney
cpmUser : PlanDetailsMoney
grp : float
grpIndex : float
index : float
ots : float
percent : float
prefilter : PlanDetailsAudienceResult
projection : float
rawCases : float
share : float
structure : PlanDetailsMediumResult
tariff : TariffResult
total : float
>]; PlanDetailsOnlineData [label=<
PlanDetailsOnlineData
basisCpm : PlanDetailsMoney
eventualShare : float
fcExtraCpm : PlanDetailsMoney
fcForTotal : boolean
frequencyCapping : integer
pi : float
piMax : float
rateCardCpm : PlanDetailsMoney
targetingExtraCpm : PlanDetailsMoney
targetingId : string
targetingSummaryLong : string
targetingSummaryShort : string
totalCpm : PlanDetailsMoney
>]; PlanDetailsMediumResult [label=<
PlanDetailsMediumResult
cases : float
contacts : float
projection : float
>]; PlanDetailsPlacement [label=<
PlanDetailsPlacement
online : PlanDetailsOnlineData
result : PlanDetailsResult
tag : string
>]; PlanDetailsMoney [label=<
PlanDetailsMoney
amount : float
currency : string
>]; PlanDetailsMediumResult [label=<
PlanDetailsMediumResult
cases : float
projection : float
>]; TariffResult [label=<
TariffResult
adFormat : string
afterAgencyCommission : PlanDetailsMoney
afterCashDiscount : PlanDetailsMoney
afterSpecialDiscount1 : PlanDetailsMoney
afterSpecialDiscount2 : PlanDetailsMoney
afterSpecialDiscount3 : PlanDetailsMoney
afterSpecialDiscount4 : PlanDetailsMoney
afterSpecialDiscount5 : PlanDetailsMoney
afterTariffDiscount : PlanDetailsMoney
gross : PlanDetailsMoney
net : PlanDetailsMoney
pricing : string
status : string
>]; edge [dir=back, arrowtail=dot] PlanDetailsPlacement -> PlanDetailsResult [label=<
result
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmNet
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpm
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmUser
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
audience
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
prefilter
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmGross
>]; PlanDetailsResult -> TariffResult [label=<
tariff
>]; TariffResult -> PlanDetailsMoney [label=<
gross
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount5
>]; TariffResult -> PlanDetailsMoney [label=<
afterCashDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount3
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount2
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount1
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount4
>]; TariffResult -> PlanDetailsMoney [label=<
afterTariffDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
net
>]; TariffResult -> PlanDetailsMoney [label=<
afterAgencyCommission
>]; PlanDetailsResult -> PlanDetailsMediumResult [label=<
structure
>]; PlanDetailsPlacement -> PlanDetailsOnlineData [label=<
online
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
fcExtraCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
targetingExtraCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
rateCardCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
basisCpm
>]; PlanDetailsOnlineData -> PlanDetailsMoney [label=<
totalCpm
>]; } Properties """""""""" .. index:: pair: PlanDetailsPlacement; tag pair: PlanDetailsPlacement; result pair: PlanDetailsPlacement; online .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - tag - string - Reflected tag value from the corresponding placement of the request * - result - :ref:`REF_MODEL_PlanDetailsResult` - * - online - :ref:`REF_MODEL_PlanDetailsOnlineData` - .. _REF_MODEL_PlanDetailsResult: :index:`PlanDetailsResult` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; PlanDetailsResult [label=<
PlanDetailsResult
audience : PlanDetailsAudienceResult
cases : float
contacts : float
contactsShare : float
cpm : PlanDetailsMoney
cpmGross : PlanDetailsMoney
cpmNet : PlanDetailsMoney
cpmUser : PlanDetailsMoney
grp : float
grpIndex : float
index : float
ots : float
percent : float
prefilter : PlanDetailsAudienceResult
projection : float
rawCases : float
share : float
structure : PlanDetailsMediumResult
tariff : TariffResult
total : float
>]; PlanDetailsMediumResult [label=<
PlanDetailsMediumResult
cases : float
contacts : float
projection : float
>]; PlanDetailsMoney [label=<
PlanDetailsMoney
amount : float
currency : string
>]; PlanDetailsMediumResult [label=<
PlanDetailsMediumResult
cases : float
projection : float
>]; TariffResult [label=<
TariffResult
adFormat : string
afterAgencyCommission : PlanDetailsMoney
afterCashDiscount : PlanDetailsMoney
afterSpecialDiscount1 : PlanDetailsMoney
afterSpecialDiscount2 : PlanDetailsMoney
afterSpecialDiscount3 : PlanDetailsMoney
afterSpecialDiscount4 : PlanDetailsMoney
afterSpecialDiscount5 : PlanDetailsMoney
afterTariffDiscount : PlanDetailsMoney
gross : PlanDetailsMoney
net : PlanDetailsMoney
pricing : string
status : string
>]; edge [dir=back, arrowtail=dot] PlanDetailsResult -> PlanDetailsMoney [label=<
cpmNet
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpm
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmUser
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
audience
>]; PlanDetailsResult -> PlanDetailsAudienceResult [label=<
prefilter
>]; PlanDetailsResult -> PlanDetailsMoney [label=<
cpmGross
>]; PlanDetailsResult -> TariffResult [label=<
tariff
>]; TariffResult -> PlanDetailsMoney [label=<
gross
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount5
>]; TariffResult -> PlanDetailsMoney [label=<
afterCashDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount3
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount2
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount1
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount4
>]; TariffResult -> PlanDetailsMoney [label=<
afterTariffDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
net
>]; TariffResult -> PlanDetailsMoney [label=<
afterAgencyCommission
>]; PlanDetailsResult -> PlanDetailsMediumResult [label=<
structure
>]; } Properties """""""""" .. index:: pair: PlanDetailsResult; cpmNet pair: PlanDetailsResult; ots pair: PlanDetailsResult; cpm pair: PlanDetailsResult; grp pair: PlanDetailsResult; rawCases pair: PlanDetailsResult; share pair: PlanDetailsResult; contacts pair: PlanDetailsResult; percent pair: PlanDetailsResult; contactsShare pair: PlanDetailsResult; grpIndex pair: PlanDetailsResult; cpmUser pair: PlanDetailsResult; audience pair: PlanDetailsResult; index pair: PlanDetailsResult; prefilter pair: PlanDetailsResult; cpmGross pair: PlanDetailsResult; total pair: PlanDetailsResult; tariff pair: PlanDetailsResult; cases pair: PlanDetailsResult; structure pair: PlanDetailsResult; projection .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - cpmNet - :ref:`REF_MODEL_PlanDetailsMoney` - Net cost per mill contacts * - ots - :ref:`REF_MODEL_float` - Opportunity to see * - cpm - :ref:`REF_MODEL_PlanDetailsMoney` - Cost per mill contacts * - grp - :ref:`REF_MODEL_float` - Gross rate point * - rawCases - :ref:`REF_MODEL_float` - Raw/unweighted Cases * - share - :ref:`REF_MODEL_float` - Ratio of the cases with respect to the medium at the overall audience * - contacts - :ref:`REF_MODEL_float` - Contacts * - percent - :ref:`REF_MODEL_float` - Ration of cases with respect to the target audience * - contactsShare - :ref:`REF_MODEL_float` - Ratio of the contacts with respect to the medium at the overall audience * - grpIndex - :ref:`REF_MODEL_float` - GRP index * - cpmUser - :ref:`REF_MODEL_PlanDetailsMoney` - Cost per mill user * - audience - :ref:`REF_MODEL_PlanDetailsAudienceResult` - Result details with respect to the applied audience (and prefilter) * - index - :ref:`REF_MODEL_float` - Affinity index * - prefilter - :ref:`REF_MODEL_PlanDetailsAudienceResult` - Result details with respect to the applied prefilter * - cpmGross - :ref:`REF_MODEL_PlanDetailsMoney` - Gross cost per mill contacts * - total - :ref:`REF_MODEL_float` - Total audience (german: WNK) * - tariff - :ref:`REF_MODEL_TariffResult` - Tariff specific calculation results * - cases - :ref:`REF_MODEL_float` - Cases * - structure - :ref:`REF_MODEL_PlanDetailsMediumResult` - Result details with respect to the applied booking unit (and prefilter) * - projection - :ref:`REF_MODEL_float` - Projection of the cases at the overall audience of the underlying study .. _REF_MODEL_QuantitativeAudience: :index:`QuantitativeAudience` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; QuantitativeAudience [label=<
QuantitativeAudience
max : number
min : number
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: QuantitativeAudience; max pair: QuantitativeAudience; min .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - max - number - The maximum value of the quantitative property to match. * - min - number - The minimum value of the quantitative property to match. .. _REF_MODEL_RateCardSelector: :index:`RateCardSelector` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; RateCardSelector [label=<
RateCardSelector
allowIgnoreDate : boolean
date : Date
dateRule : string
daysOfWeek : string []
seasonal : boolean
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: RateCardSelector; date pair: RateCardSelector; seasonal pair: RateCardSelector; daysOfWeek pair: RateCardSelector; allowIgnoreDate pair: RateCardSelector; dateRule .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - date - Date - Reference date for the selection of the effective rate card. * - seasonal - boolean - Apply seasonal prices. * - daysOfWeek - string [] - Days of Week. (Array of strings) * - allowIgnoreDate - boolean - Allow to ignore the provided date. * - dateRule - string - The rule to be applied while selecting the rate card by date. .. _REF_MODEL_ScaleElement: :index:`ScaleElement` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; ScaleElement [label=<
ScaleElement
display : string
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: ScaleElement; display .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - display - string - The display text of the scale element .. _REF_MODEL_ScaleGroup: :index:`ScaleGroup` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; ScaleGroup [label=<
ScaleGroup
elements : ScaleElement []
>]; ScaleElement [label=<
ScaleElement
display : string
>]; edge [dir=back, arrowtail=dot] ScaleGroup -> ScaleElement [label=<
elements
>]; } Properties """""""""" .. index:: pair: ScaleGroup; elements .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - elements - :ref:`REF_MODEL_ScaleElement` [] - Array of scale elements .. _REF_MODEL_SpecialDiscounts: :index:`SpecialDiscounts` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; SpecialDiscounts [label=<
SpecialDiscounts
amount1 : number
amount2 : number
amount3 : number
amount4 : number
amount5 : number
type : string
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: SpecialDiscounts; amount3 pair: SpecialDiscounts; amount2 pair: SpecialDiscounts; amount1 pair: SpecialDiscounts; amount5 pair: SpecialDiscounts; amount4 pair: SpecialDiscounts; type .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - amount3 - number - Special discount amount #3. * - amount2 - number - Special discount amount #2. * - amount1 - number - Special discount amount #1. * - amount5 - number - Special discount amount 5. * - amount4 - number - Special discount amount #.4 * - type - string - Way of application of the discount amounts. .. _REF_MODEL_Targeting: :index:`Targeting` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; Targeting [label=<
Targeting
keys : string []
wastage : number
>]; edge [dir=back, arrowtail=dot] } Properties """""""""" .. index:: pair: Targeting; keys pair: Targeting; wastage .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - keys - string [] - The keys of the targetings to be applied. * - wastage - number - Percentage of page impressions consumed by other than the requested target audiences. If omitted assumed to be zero. .. _REF_MODEL_TariffConditions: :index:`TariffConditions` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; RateCardSelector [label=<
RateCardSelector
allowIgnoreDate : boolean
date : Date
dateRule : string
daysOfWeek : string []
seasonal : boolean
>]; GenericConditions [label=<
GenericConditions
entries : GenericConditionsEntry []
id : string
internalFrequency : integer
>]; MagazineConditions [label=<
MagazineConditions
altFormat : string
bleed : string
colorReduction : string
fallback : string
format : string
gutterBleed : string
internalFrequency : integer
style : string
>]; OnlineConditions [label=<
OnlineConditions
adFormat : string
altAdFormat : string
fixedPriceWithShare : boolean
pricing : string
specialCpm : number
specialFixedPrice : number
specialFixedPriceIgnoresFrequency : boolean
>]; BroadcastConditions [label=<
BroadcastConditions
internalFrequency : integer
length_sec : number
>]; TariffConditions [label=<
TariffConditions
agencyCommission : number
cashDiscount : number
cinema : BroadcastConditions
generic : GenericConditions
gross : boolean
magazine : MagazineConditions
newspaper : NewspaperConditions
online : OnlineConditions
radio : BroadcastConditions
rateCard : RateCardSelector
tv : BroadcastConditions
vat : number
>]; NewspaperConditions [label=<
NewspaperConditions
colorReduction : string
format : string
internalFrequency : integer
size_mm : number
style : string
>]; GenericConditionsEntry [label=<
GenericConditionsEntry
alternateKey : string
factor : number
key : string
>]; edge [dir=back, arrowtail=dot] TariffConditions -> GenericConditions [label=<
generic
>]; GenericConditions -> GenericConditionsEntry [label=<
entries
>]; TariffConditions -> BroadcastConditions [label=<
cinema
>]; TariffConditions -> BroadcastConditions [label=<
tv
>]; TariffConditions -> RateCardSelector [label=<
rateCard
>]; TariffConditions -> NewspaperConditions [label=<
newspaper
>]; TariffConditions -> MagazineConditions [label=<
magazine
>]; TariffConditions -> BroadcastConditions [label=<
radio
>]; TariffConditions -> OnlineConditions [label=<
online
>]; } Properties """""""""" .. index:: pair: TariffConditions; gross pair: TariffConditions; generic pair: TariffConditions; cinema pair: TariffConditions; tv pair: TariffConditions; agencyCommission pair: TariffConditions; rateCard pair: TariffConditions; newspaper pair: TariffConditions; magazine pair: TariffConditions; radio pair: TariffConditions; online pair: TariffConditions; cashDiscount pair: TariffConditions; vat .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - gross - boolean - Flag to define if the gross amounts are to be calculated. Not gross means net. * - generic - :ref:`REF_MODEL_GenericConditions` - Generic tariff conditions * - cinema - :ref:`REF_MODEL_BroadcastConditions` - Cinema specific tariff conditions * - tv - :ref:`REF_MODEL_BroadcastConditions` - TV specific tariff conditions * - agencyCommission - number - An agency commission to be discounted possibly. * - rateCard - :ref:`REF_MODEL_RateCardSelector` - Specification of rate card selection criteria. * - newspaper - :ref:`REF_MODEL_NewspaperConditions` - Newspaper specific tariff conditions * - magazine - :ref:`REF_MODEL_MagazineConditions` - Magazine specific tariff conditions * - radio - :ref:`REF_MODEL_BroadcastConditions` - Radio specific tariff conditions * - online - :ref:`REF_MODEL_OnlineConditions` - Online specific tariff conditions * - cashDiscount - number - A cash discount to be taken into account possibly. * - vat - number - Value added tax to be taken into account. .. _REF_MODEL_TariffResult: :index:`TariffResult` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; PlanDetailsMoney [label=<
PlanDetailsMoney
amount : float
currency : string
>]; TariffResult [label=<
TariffResult
adFormat : string
afterAgencyCommission : PlanDetailsMoney
afterCashDiscount : PlanDetailsMoney
afterSpecialDiscount1 : PlanDetailsMoney
afterSpecialDiscount2 : PlanDetailsMoney
afterSpecialDiscount3 : PlanDetailsMoney
afterSpecialDiscount4 : PlanDetailsMoney
afterSpecialDiscount5 : PlanDetailsMoney
afterTariffDiscount : PlanDetailsMoney
gross : PlanDetailsMoney
net : PlanDetailsMoney
pricing : string
status : string
>]; edge [dir=back, arrowtail=dot] TariffResult -> PlanDetailsMoney [label=<
gross
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount5
>]; TariffResult -> PlanDetailsMoney [label=<
afterCashDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount3
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount2
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount1
>]; TariffResult -> PlanDetailsMoney [label=<
afterSpecialDiscount4
>]; TariffResult -> PlanDetailsMoney [label=<
afterTariffDiscount
>]; TariffResult -> PlanDetailsMoney [label=<
net
>]; TariffResult -> PlanDetailsMoney [label=<
afterAgencyCommission
>]; } Properties """""""""" .. index:: pair: TariffResult; status pair: TariffResult; gross pair: TariffResult; afterSpecialDiscount5 pair: TariffResult; afterCashDiscount pair: TariffResult; afterSpecialDiscount3 pair: TariffResult; afterSpecialDiscount2 pair: TariffResult; afterSpecialDiscount1 pair: TariffResult; afterSpecialDiscount4 pair: TariffResult; pricing pair: TariffResult; afterTariffDiscount pair: TariffResult; net pair: TariffResult; afterAgencyCommission pair: TariffResult; adFormat .. list-table:: :widths: 10 10 60 :header-rows: 1 * - Field - Type - Description * - status - string - A string token representing the status of the tariff calculation * - gross - :ref:`REF_MODEL_PlanDetailsMoney` - Gross costs of the related media plan item * - afterSpecialDiscount5 - :ref:`REF_MODEL_PlanDetailsMoney` - Cost considering special discount #5 * - afterCashDiscount - :ref:`REF_MODEL_PlanDetailsMoney` - Cost considering cash discount * - afterSpecialDiscount3 - :ref:`REF_MODEL_PlanDetailsMoney` - Cost considering special discount #3 * - afterSpecialDiscount2 - :ref:`REF_MODEL_PlanDetailsMoney` - Cost considering special discount #2 * - afterSpecialDiscount1 - :ref:`REF_MODEL_PlanDetailsMoney` - Cost considering special discount #1 * - afterSpecialDiscount4 - :ref:`REF_MODEL_PlanDetailsMoney` - Cost considering special discount #4 * - pricing - string - * - afterTariffDiscount - :ref:`REF_MODEL_PlanDetailsMoney` - Cost considering tariff discount * - net - :ref:`REF_MODEL_PlanDetailsMoney` - Net costs of the related media plan item * - afterAgencyCommission - :ref:`REF_MODEL_PlanDetailsMoney` - Cost considering agency commission * - adFormat - string - Actually applied advertisement format. .. _REF_MODEL_VariablesDictionary: :index:`VariablesDictionary` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; VariablesDictionary [label=<
VariablesDictionary
>]; edge [dir=back, arrowtail=dot] } .. _REF_MODEL_XorCombinedItem: :index:`XorCombinedItem` ---------------------------------------------------------------------------------- .. graphviz:: digraph foo { node [shape=none, margin=0]; XorCombinedItem [label=<
XorCombinedItem
>]; edge [dir=back, arrowtail=dot] }