Interface YieldOptimizationConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<YieldOptimizationConfiguration.Builder,YieldOptimizationConfiguration>, SdkBuilder<YieldOptimizationConfiguration.Builder,YieldOptimizationConfiguration>, SdkPojo
Enclosing class:
YieldOptimizationConfiguration
@Mutable @NotThreadSafe public static interface YieldOptimizationConfiguration.Builder extends SdkPojo, CopyableBuilder<YieldOptimizationConfiguration.Builder,YieldOptimizationConfiguration>

  • Method Details

    • minimumUnfilledDuration

      YieldOptimizationConfiguration.Builder minimumUnfilledDuration(Integer minimumUnfilledDuration)

      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.

      Parameters:
      minimumUnfilledDuration - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • publisherId

      YieldOptimizationConfiguration.Builder publisherId(String publisherId)

      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.

      Parameters:
      publisherId - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • region

      YieldOptimizationConfiguration.Builder region(String region)

      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.

      Parameters:
      region - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • region

      YieldOptimizationConfiguration.Builder region(ApsRegion region)

      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.

      Parameters:
      region - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • openRtbTemplate

      YieldOptimizationConfiguration.Builder openRtbTemplate(String openRtbTemplate)

      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.

      Parameters:
      openRtbTemplate - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.