Skip to content

YieldOptimizationConfiguration

Source code in docs_src/capo_mediatailor/types/yield_optimization_configuration.py
class YieldOptimizationConfiguration(TypedDict, closed=True):
    minimum_unfilled_duration: "capo_mediatailor.types.minimum_unfilled_duration_seconds.MinimumUnfilledDurationSeconds"
    """<p>The minimum unfilled duration, in seconds, that must remain in an ad break before MediaTailor requests additional ads from Amazon Publisher Services (APS). For example, if set to 6 seconds, yield optimization triggers only when at least 6 seconds of unfilled time remains after the primary ad server response.</p>"""
    publisher_id: "capo_mediatailor.types.aps_publisher_id.ApsPublisherId"
    """<p>Publisher ID for an existing Amazon Publisher Services configuration. This ID must be obtained by registering with APS prior to using the Yield Optimization feature. The Publisher ID identifies your account in the APS system and is required for all bid requests.</p>"""
    region: "capo_mediatailor.types.aps_region.ApsRegion"
    """<p>The Amazon Publisher Services (APS) region that MediaTailor sends bid requests to. Choose the region closest to your primary audience, because the selection affects both latency and the ad inventory available to you. This setting applies to the entire playback configuration, not to individual viewers. If you serve traffic across multiple regions, create a separate playback configuration for each APS region.</p>"""
    open_rtb_template: (
        "capo_mediatailor.types.open_rtb_template_string.OpenRtbTemplateString"
    )
    """<p>The OpenRTB bid request template, in JSON, that MediaTailor sends to Amazon Publisher Services (APS). The template must include an <code>imp</code> array with one impression specifying <code>bidfloor</code>, an <code>app</code> object specifying <code>bundle</code> and <code>storeurl</code>, and a <code>device</code> object specifying <code>ua</code> and <code>ip</code>. Use double curly braces (for example, <code>{{player_params.user_agent}}</code>) to insert session variables and player parameters.</p>"""

minimum_unfilled_duration instance-attribute

minimum_unfilled_duration: MinimumUnfilledDurationSeconds

The minimum unfilled duration, in seconds, that must remain in an ad break before MediaTailor requests additional ads from Amazon Publisher Services (APS). For example, if set to 6 seconds, yield optimization triggers only when at least 6 seconds of unfilled time remains after the primary ad server response.

open_rtb_template instance-attribute

open_rtb_template: OpenRtbTemplateString

The OpenRTB bid request template, in JSON, that MediaTailor sends to Amazon Publisher Services (APS). The template must include an imp array with one impression specifying bidfloor, an app object specifying bundle and storeurl, and a device object specifying ua and ip. Use double curly braces (for example, {{player_params.user_agent}}) to insert session variables and player parameters.

publisher_id instance-attribute

publisher_id: ApsPublisherId

Publisher ID for an existing Amazon Publisher Services configuration. This ID must be obtained by registering with APS prior to using the Yield Optimization feature. The Publisher ID identifies your account in the APS system and is required for all bid requests.

region instance-attribute

region: ApsRegion

The Amazon Publisher Services (APS) region that MediaTailor sends bid requests to. Choose the region closest to your primary audience, because the selection affects both latency and the ad inventory available to you. This setting applies to the entire playback configuration, not to individual viewers. If you serve traffic across multiple regions, create a separate playback configuration for each APS region.