Skip to content

ClientSideBeaconingConfiguration

Source code in docs_src/capo_mediatailor/types/client_side_beaconing_configuration.py
class ClientSideBeaconingConfiguration(TypedDict, closed=True):
    reporting_mode: (
        "capo_mediatailor.types.client_side_beaconing_mode.ClientSideBeaconingMode"
    )
    """<p>Specifies whether MediaTailor includes its beacons in the ad tracking response. Valid values, which are case-sensitive:</p> <ul> <li> <p> <code>INSIGHTS</code> – MediaTailor includes its beacons in the ad tracking response.</p> </li> <li> <p> <code>DISABLED</code> – MediaTailor doesn't include its beacons in the ad tracking response.</p> </li> </ul> <p>If you send a <code>ClientSide</code> object, this setting is required. If you omit <code>BeaconingConfiguration</code> or <code>ClientSide</code> entirely, MediaTailor uses <code>INSIGHTS</code>.</p> <p> <code>PutPlaybackConfiguration</code> replaces the whole playback configuration. To keep beaconing off, include <code>DISABLED</code> in every subsequent write.</p>"""
    additional_event_types: NotRequired[
        "capo_mediatailor.types.beacon_event_type_list.BeaconEventTypeList"
    ]
    """<p>The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on. The default is an empty list. This parameter is valid only when <code>ReportingMode</code> is <code>INSIGHTS</code>. MediaTailor rejects the request if you specify a value while <code>ReportingMode</code> is <code>DISABLED</code>, or if you specify duplicate values.</p>"""

additional_event_types instance-attribute

additional_event_types: NotRequired[BeaconEventTypeList]

The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on. The default is an empty list. This parameter is valid only when ReportingMode is INSIGHTS. MediaTailor rejects the request if you specify a value while ReportingMode is DISABLED, or if you specify duplicate values.

reporting_mode instance-attribute

reporting_mode: ClientSideBeaconingMode

Specifies whether MediaTailor includes its beacons in the ad tracking response. Valid values, which are case-sensitive:

  • INSIGHTS – MediaTailor includes its beacons in the ad tracking response.

  • DISABLED – MediaTailor doesn't include its beacons in the ad tracking response.

If you send a ClientSide object, this setting is required. If you omit BeaconingConfiguration or ClientSide entirely, MediaTailor uses INSIGHTS.

PutPlaybackConfiguration replaces the whole playback configuration. To keep beaconing off, include DISABLED in every subsequent write.