/AWS1/CL_MDTVASTREQUESTCONF¶
The configuration for a VAST_REQUEST function. Specifies the HTTP method, URL, headers, body, timeout, and output expressions for a request to a VAST endpoint. MediaTailor parses the response as VAST and resolves wrapper redirects, then makes the parsed ads available to the function's output expressions. For more information, see Function types and composition in the MediaTailor User Guide.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_runtime TYPE /AWS1/MDTRUNTIMETYPE /AWS1/MDTRUNTIMETYPE¶
The expression language used to evaluate expressions in the function configuration. Set this to
JSONata.
iv_methodtype TYPE /AWS1/MDTMETHODTYPE /AWS1/MDTMETHODTYPE¶
The HTTP method for the request to the VAST endpoint. Valid values:
GETandPOST. UsePOSTto send a bid request body, such as an OpenRTB payload.
iv_reqtimeoutmilliseconds TYPE /AWS1/MDT__INTEGER /AWS1/MDT__INTEGER¶
The maximum time, in milliseconds, that MediaTailor waits for a response from the VAST endpoint. The timeout covers the entire response, including any wrapper redirects that MediaTailor follows. If the call exceeds this timeout, MediaTailor proceeds with an empty ad list and continues output expression evaluation. Valid values:
100to2000.
iv_url TYPE /AWS1/MDT__STRING /AWS1/MDT__STRING¶
An expression that evaluates to the VAST endpoint URL. Use
{%...%}delimiters for dynamic expressions. A literal value must be anhttps://URL. The expression can be up to 25,000 characters, and the URL after evaluation can be up to 2,048 characters.
Optional arguments:¶
it_output TYPE /AWS1/CL_MDT__MAPOF__STRING_W=>TT___MAPOF__STRING TT___MAPOF__STRING¶
A map of output bindings. Each key is a namespaced output path (such as
temp.wrappedAds), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in aVAST_REQUESTfunction can reference theresponseobject, which exposesresponse.parsedAds— the ads parsed from the VAST response after schema validation and wrapper resolution — andresponse.statusCode. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide.
iv_body TYPE /AWS1/MDT__STRING /AWS1/MDT__STRING¶
An expression that evaluates to the request body, for example to send an OpenRTB bid request. The expression can be up to 100,000 characters, and the body after evaluation can be up to 64 KB.
it_headers TYPE /AWS1/CL_MDT__MAPOF__STRING_W=>TT___MAPOF__STRING TT___MAPOF__STRING¶
A map of HTTP header names to expression values. MediaTailor evaluates each header value expression at runtime and includes the result in the outbound request. Headers beginning with
X-Amz-are reserved by the service, and method override headers are not allowed.
io_cache TYPE REF TO /AWS1/CL_MDTHTTPREQCACHECONF /AWS1/CL_MDTHTTPREQCACHECONF¶
The optional response-caching configuration for the function. When present, MediaTailor caches the responses that the function receives from the HTTP endpoint, within the time-to-live (TTL) bounds that you specify. Omit this configuration to disable response caching.
Queryable Attributes¶
Runtime¶
The expression language used to evaluate expressions in the function configuration. Set this to
JSONata.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RUNTIME() |
Getter for RUNTIME, with configurable default |
ASK_RUNTIME() |
Getter for RUNTIME w/ exceptions if field has no value |
HAS_RUNTIME() |
Determine if RUNTIME has a value |
Output¶
A map of output bindings. Each key is a namespaced output path (such as
temp.wrappedAds), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in aVAST_REQUESTfunction can reference theresponseobject, which exposesresponse.parsedAds— the ads parsed from the VAST response after schema validation and wrapper resolution — andresponse.statusCode. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OUTPUT() |
Getter for OUTPUT, with configurable default |
ASK_OUTPUT() |
Getter for OUTPUT w/ exceptions if field has no value |
HAS_OUTPUT() |
Determine if OUTPUT has a value |
MethodType¶
The HTTP method for the request to the VAST endpoint. Valid values:
GETandPOST. UsePOSTto send a bid request body, such as an OpenRTB payload.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_METHODTYPE() |
Getter for METHODTYPE, with configurable default |
ASK_METHODTYPE() |
Getter for METHODTYPE w/ exceptions if field has no value |
HAS_METHODTYPE() |
Determine if METHODTYPE has a value |
RequestTimeoutMilliseconds¶
The maximum time, in milliseconds, that MediaTailor waits for a response from the VAST endpoint. The timeout covers the entire response, including any wrapper redirects that MediaTailor follows. If the call exceeds this timeout, MediaTailor proceeds with an empty ad list and continues output expression evaluation. Valid values:
100to2000.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REQTIMEOUTMILLISECONDS() |
Getter for REQUESTTIMEOUTMILLISECONDS, with configurable def |
ASK_REQTIMEOUTMILLISECONDS() |
Getter for REQUESTTIMEOUTMILLISECONDS w/ exceptions if field |
HAS_REQTIMEOUTMILLISECONDS() |
Determine if REQUESTTIMEOUTMILLISECONDS has a value |
Url¶
An expression that evaluates to the VAST endpoint URL. Use
{%...%}delimiters for dynamic expressions. A literal value must be anhttps://URL. The expression can be up to 25,000 characters, and the URL after evaluation can be up to 2,048 characters.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_URL() |
Getter for URL, with configurable default |
ASK_URL() |
Getter for URL w/ exceptions if field has no value |
HAS_URL() |
Determine if URL has a value |
Body¶
An expression that evaluates to the request body, for example to send an OpenRTB bid request. The expression can be up to 100,000 characters, and the body after evaluation can be up to 64 KB.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BODY() |
Getter for BODY, with configurable default |
ASK_BODY() |
Getter for BODY w/ exceptions if field has no value |
HAS_BODY() |
Determine if BODY has a value |
Headers¶
A map of HTTP header names to expression values. MediaTailor evaluates each header value expression at runtime and includes the result in the outbound request. Headers beginning with
X-Amz-are reserved by the service, and method override headers are not allowed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HEADERS() |
Getter for HEADERS, with configurable default |
ASK_HEADERS() |
Getter for HEADERS w/ exceptions if field has no value |
HAS_HEADERS() |
Determine if HEADERS has a value |
Cache¶
The optional response-caching configuration for the function. When present, MediaTailor caches the responses that the function receives from the HTTP endpoint, within the time-to-live (TTL) bounds that you specify. Omit this configuration to disable response caching.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CACHE() |
Getter for CACHE |