Looking for a REST API? The Ad Manager API (Beta) is now available.

type LiveStreamEventPrerollSettingsError (v202411)

AI-generated Key Takeaways

LiveStreamEventPrerollSettingsError lists all errors related to preroll settings for LiveStreamEvents.
This error applies specifically to dynamic ad insertion type linear livestream events.
The error reasons are categorized by an enum, primarily indicating invalid preroll settings or unknown issues.
Detailed information about the error is provided through fields like fieldPath, trigger, and errorString, inherited from ApiError.
The reason field specifies the type of preroll setting error encountered.

Service

LiveStreamEventService

Inheritance

ApiError

▼

AdBreakMarkupError ApiVersionError AuthenticationError CollectionSizeError CommonError EntityLimitReachedError FeatureError InternalApiError InvalidUrlError LiveStreamEventActionError LiveStreamEventCdnSettingsE... LiveStreamEventConditioning... LiveStreamEventCustomAssetK... LiveStreamEventDateTimeError LiveStreamEventDvrWindowError LiveStreamEventPrerollSetti... LiveStreamEventSlateError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequiredCollectionError RequiredError RequiredNumberError ServerError StatementError StringFormatError StringLengthError UniqueError VideoAdTagError

Lists all errors associated with preroll settings applied to a LiveStreamEvent.

Field
`ApiError` (inherited)
`fieldPath`	`xsd:string` The OGNL field path to identify cause of error.
`fieldPathElements`	`FieldPathElement[]` A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
`trigger`	`xsd:string` The data that caused the error.
`errorString`	`xsd:string` A simple string representation of the error and reason.
`LiveStreamEventPrerollSettingsError`
`reason`	`LiveStreamEventPrerollSetti...` The error reason represented by an enum. Enumerations `INVALID_PREROLL_SETTINGS` Preroll settings are only supported for livestream events of dynamic ad insertion type linear. `UNKNOWN` The value returned if the actual value is not exposed by the requested API version.