Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MediaTailor.Types.AvailMatchingCriteria

Description

Synopsis

data AvailMatchingCriteria = AvailMatchingCriteria' {
- dynamicVariable :: Text
- operator :: Operator
}
newAvailMatchingCriteria :: Text -> Operator -> AvailMatchingCriteria
availMatchingCriteria_dynamicVariable :: Lens' AvailMatchingCriteria Text
availMatchingCriteria_operator :: Lens' AvailMatchingCriteria Operator

Documentation

data AvailMatchingCriteria Source #

MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.

As an example, let's say that you set DynamicVariable to scte.event_id and Operator to EQUALS, and your playback configuration has an ADS URL of https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]. And the prefetch request to the ADS contains these values https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id of my-awesome-event, since it must match the event id that MediaTailor uses to query the ADS.

You can specify up to five AvailMatchingCriteria. If you specify multiple AvailMatchingCriteria, MediaTailor combines them to match using a logical AND. You can model logical OR combinations by creating multiple prefetch schedules.

See: newAvailMatchingCriteria smart constructor.

Constructors

AvailMatchingCriteria'

Fields

dynamicVariable :: Text
The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.
You can include up to 100 dynamic variables.
operator :: Operator
For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

Instances

Instances details

FromJSON AvailMatchingCriteria Source #
Instance details Defined in Amazonka.MediaTailor.Types.AvailMatchingCriteria Methods parseJSON :: Value -> Parser AvailMatchingCriteria # parseJSONList :: Value -> Parser [AvailMatchingCriteria] #
ToJSON AvailMatchingCriteria Source #
Instance details Defined in Amazonka.MediaTailor.Types.AvailMatchingCriteria Methods toJSON :: AvailMatchingCriteria -> Value # toEncoding :: AvailMatchingCriteria -> Encoding # toJSONList :: [AvailMatchingCriteria] -> Value # toEncodingList :: [AvailMatchingCriteria] -> Encoding #
Generic AvailMatchingCriteria Source #
Instance details Defined in Amazonka.MediaTailor.Types.AvailMatchingCriteria Associated Types type Rep AvailMatchingCriteria :: Type -> Type # Methods from :: AvailMatchingCriteria -> Rep AvailMatchingCriteria x # to :: Rep AvailMatchingCriteria x -> AvailMatchingCriteria #
Read AvailMatchingCriteria Source #
Instance details Defined in Amazonka.MediaTailor.Types.AvailMatchingCriteria Methods readsPrec :: Int -> ReadS AvailMatchingCriteria # readList :: ReadS [AvailMatchingCriteria] # readPrec :: ReadPrec AvailMatchingCriteria # readListPrec :: ReadPrec [AvailMatchingCriteria] #
Show AvailMatchingCriteria Source #
Instance details Defined in Amazonka.MediaTailor.Types.AvailMatchingCriteria Methods showsPrec :: Int -> AvailMatchingCriteria -> ShowS # show :: AvailMatchingCriteria -> String # showList :: [AvailMatchingCriteria] -> ShowS #
NFData AvailMatchingCriteria Source #
Instance details Defined in Amazonka.MediaTailor.Types.AvailMatchingCriteria Methods rnf :: AvailMatchingCriteria -> () #
Eq AvailMatchingCriteria Source #
Instance details Defined in Amazonka.MediaTailor.Types.AvailMatchingCriteria Methods (==) :: AvailMatchingCriteria -> AvailMatchingCriteria -> Bool # (/=) :: AvailMatchingCriteria -> AvailMatchingCriteria -> Bool #
Hashable AvailMatchingCriteria Source #
Instance details Defined in Amazonka.MediaTailor.Types.AvailMatchingCriteria Methods hashWithSalt :: Int -> AvailMatchingCriteria -> Int # hash :: AvailMatchingCriteria -> Int #
type Rep AvailMatchingCriteria Source #
Instance details Defined in Amazonka.MediaTailor.Types.AvailMatchingCriteria type Rep AvailMatchingCriteria = D1 ('MetaData "AvailMatchingCriteria" "Amazonka.MediaTailor.Types.AvailMatchingCriteria" "amazonka-mediatailor-2.0-6mxt6n51Pv3JbuBr2GKiO4" 'False) (C1 ('MetaCons "AvailMatchingCriteria'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dynamicVariable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "operator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Operator)))

newAvailMatchingCriteria Source #

Arguments

:: Text	`$sel:dynamicVariable:AvailMatchingCriteria'`
-> Operator	`$sel:operator:AvailMatchingCriteria'`
-> AvailMatchingCriteria

Create a value of AvailMatchingCriteria with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dynamicVariable:AvailMatchingCriteria', availMatchingCriteria_dynamicVariable - The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.

You can include up to 100 dynamic variables.

$sel:operator:AvailMatchingCriteria', availMatchingCriteria_operator - For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

availMatchingCriteria_dynamicVariable :: Lens' AvailMatchingCriteria Text Source #

The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.

You can include up to 100 dynamic variables.

availMatchingCriteria_operator :: Lens' AvailMatchingCriteria Operator Source #

For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.