type LiveStreamEventPrerollSettingsError (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
Service
LiveStreamEventService
Lists all errors associated with preroll settings applied to a LiveStreamEvent.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202411
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eLiveStreamEventPrerollSettingsError lists all errors related to preroll settings for LiveStreamEvents.\u003c/p\u003e\n"],["\u003cp\u003eThis error applies specifically to dynamic ad insertion type linear livestream events.\u003c/p\u003e\n"],["\u003cp\u003eThe error reasons are categorized by an enum, primarily indicating invalid preroll settings or unknown issues.\u003c/p\u003e\n"],["\u003cp\u003eDetailed information about the error is provided through fields like \u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e, inherited from \u003ccode\u003eApiError\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field specifies the type of preroll setting error encountered.\u003c/p\u003e\n"]]],["The `LiveStreamEventService` manages errors related to live stream events, categorized under `ApiError`. Specific error types include `AdBreakMarkupError`, `AuthenticationError`, `FeatureError`, `LiveStreamEventActionError`, and others. `LiveStreamEventPrerollSettingsError` addresses issues within preroll settings, with reasons including `INVALID_PREROLL_SETTINGS` and `UNKNOWN`. `ApiError` provides details like `fieldPath`, `trigger`, and `errorString` for error identification. This service uses the namespace `https://www.google.com/apis/ads/publisher/v202411`.\n"],null,["# type LiveStreamEventPrerollSettingsError (v202411)\n\n**Service** \n**LiveStreamEventService** **Inheritance** \n[ApiError](/ad-manager/api/reference/v202411/LiveStreamEventService.ApiError) \n▼\n[AdBreakMarkupError](/ad-manager/api/reference/v202411/LiveStreamEventService.AdBreakMarkupError) [ApiVersionError](/ad-manager/api/reference/v202411/LiveStreamEventService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202411/LiveStreamEventService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/LiveStreamEventService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/LiveStreamEventService.CommonError) [EntityLimitReachedError](/ad-manager/api/reference/v202411/LiveStreamEventService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202411/LiveStreamEventService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202411/LiveStreamEventService.InternalApiError) [InvalidUrlError](/ad-manager/api/reference/v202411/LiveStreamEventService.InvalidUrlError) [LiveStreamEventActionError](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEventActionError) [LiveStreamEventCdnSettingsE...](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEventCdnSettingsError \"LiveStreamEventCdnSettingsError\") [LiveStreamEventConditioning...](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEventConditioningError \"LiveStreamEventConditioningError\") [LiveStreamEventCustomAssetK...](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEventCustomAssetKeyError \"LiveStreamEventCustomAssetKeyError\") [LiveStreamEventDateTimeError](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEventDateTimeError) [LiveStreamEventDvrWindowError](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEventDvrWindowError) **LiveStreamEventPrerollSetti...** [LiveStreamEventSlateError](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEventSlateError) [NotNullError](/ad-manager/api/reference/v202411/LiveStreamEventService.NotNullError) [NullError](/ad-manager/api/reference/v202411/LiveStreamEventService.NullError) [ParseError](/ad-manager/api/reference/v202411/LiveStreamEventService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/LiveStreamEventService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/LiveStreamEventService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/LiveStreamEventService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/LiveStreamEventService.QuotaError) [RangeError](/ad-manager/api/reference/v202411/LiveStreamEventService.RangeError) [RequiredCollectionError](/ad-manager/api/reference/v202411/LiveStreamEventService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/LiveStreamEventService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202411/LiveStreamEventService.RequiredNumberError) [ServerError](/ad-manager/api/reference/v202411/LiveStreamEventService.ServerError) [StatementError](/ad-manager/api/reference/v202411/LiveStreamEventService.StatementError) [StringFormatError](/ad-manager/api/reference/v202411/LiveStreamEventService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202411/LiveStreamEventService.StringLengthError) [UniqueError](/ad-manager/api/reference/v202411/LiveStreamEventService.UniqueError) [VideoAdTagError](/ad-manager/api/reference/v202411/LiveStreamEventService.VideoAdTagError)\n\nLists all errors associated with preroll settings applied to a [LiveStreamEvent](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEvent).\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\n\n| Field ----- ||\n|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **`ApiError` (inherited)** ||\n| ### `fieldPath` | ` `xsd:`string` The OGNL field path to identify cause of error. |\n| ### `fieldPathElements` | ` `[FieldPathElement](/ad-manager/api/reference/v202411/LiveStreamEventService.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)}. |\n| ### `trigger` | ` `xsd:`string` The data that caused the error. |\n| ### `errorString` | ` `xsd:`string` A simple string representation of the error and reason. |\n| **`LiveStreamEventPrerollSettingsError`** ||\n| ### `reason` | ` `[LiveStreamEventPrerollSetti...](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEventPrerollSettingsError.Reason \"LiveStreamEventPrerollSettingsError.Reason\")` ` 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. \u003cbr /\u003e |"]]
