/AWS1/CL_MDTPREFETCHRETRIEVAL¶
A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_endtime TYPE /AWS1/MDT__TIMESTAMPUNIX /AWS1/MDT__TIMESTAMPUNIX¶
The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.
Optional arguments:¶
it_dynamicvariables TYPE /AWS1/CL_MDT__MAPOF__STRING_W=>TT___MAPOF__STRING TT___MAPOF__STRING¶
The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify
DynamicVariablesfor prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.
iv_starttime TYPE /AWS1/MDT__TIMESTAMPUNIX /AWS1/MDT__TIMESTAMPUNIX¶
The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.
iv_trafficshapingtype TYPE /AWS1/MDTTRAFFICSHAPINGTYPE /AWS1/MDTTRAFFICSHAPINGTYPE¶
Indicates the type of traffic shaping used for prefetch traffic shaping and limiting the number of requests to the ADS at one time.
io_trafshapingretrievalwin00 TYPE REF TO /AWS1/CL_MDTTRFSHAPINGRETRIE00 /AWS1/CL_MDTTRFSHAPINGRETRIE00¶
Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.
io_trafficshapingtpsconf TYPE REF TO /AWS1/CL_MDTTRAFSHAPINGTPSCONF /AWS1/CL_MDTTRAFSHAPINGTPSCONF¶
The configuration for TPS-based traffic shaping that limits the number of requests to the ad decision server (ADS) based on transactions per second instead of time windows.
Queryable Attributes¶
DynamicVariables¶
The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify
DynamicVariablesfor prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DYNAMICVARIABLES() |
Getter for DYNAMICVARIABLES, with configurable default |
ASK_DYNAMICVARIABLES() |
Getter for DYNAMICVARIABLES w/ exceptions if field has no va |
HAS_DYNAMICVARIABLES() |
Determine if DYNAMICVARIABLES has a value |
EndTime¶
The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENDTIME() |
Getter for ENDTIME, with configurable default |
ASK_ENDTIME() |
Getter for ENDTIME w/ exceptions if field has no value |
HAS_ENDTIME() |
Determine if ENDTIME has a value |
StartTime¶
The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STARTTIME() |
Getter for STARTTIME, with configurable default |
ASK_STARTTIME() |
Getter for STARTTIME w/ exceptions if field has no value |
HAS_STARTTIME() |
Determine if STARTTIME has a value |
TrafficShapingType¶
Indicates the type of traffic shaping used for prefetch traffic shaping and limiting the number of requests to the ADS at one time.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TRAFFICSHAPINGTYPE() |
Getter for TRAFFICSHAPINGTYPE, with configurable default |
ASK_TRAFFICSHAPINGTYPE() |
Getter for TRAFFICSHAPINGTYPE w/ exceptions if field has no |
HAS_TRAFFICSHAPINGTYPE() |
Determine if TRAFFICSHAPINGTYPE has a value |
TrafficShapingRetrievalWindow¶
Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TRAFSHAPINGRETRIEVALWI00() |
Getter for TRAFSHAPINGRETRIEVALWINDOW |
TrafficShapingTpsConfiguration¶
The configuration for TPS-based traffic shaping that limits the number of requests to the ad decision server (ADS) based on transactions per second instead of time windows.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TRAFFICSHAPINGTPSCONF() |
Getter for TRAFFICSHAPINGTPSCONF |