type DaiEncodingProfileVariantSettingsError (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
Service
DaiEncodingProfileService
Lists all errors associated with encoding profile variant settings.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
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.
|
DaiEncodingProfileVariantSettingsError
|
reason
|
DaiEncodingProfileVariantSe...
Enumerations
-
CONTAINER_TYPE_REQUIRED
- Container type is required for a
MEDIA or IFRAME variant.
-
VIDEO_SETTINGS_NOT_ALLOWED
- Video settings are only allowed for
MEDIA or IFRAME variant types.
-
AUDIO_SETTINGS_NOT_ALLOWED
- Audio settings are only allowed for
MEDIA or IFRAME variant types.
-
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\u003eThe \u003ccode\u003eDaiEncodingProfileService\u003c/code\u003e handles errors related to Dynamic Ad Insertion (DAI) encoding profile variant settings.\u003c/p\u003e\n"],["\u003cp\u003eErrors are categorized and accessible via the \u003ccode\u003eDaiEncodingProfileVariantSettingsError\u003c/code\u003e and its \u003ccode\u003ereason\u003c/code\u003e field.\u003c/p\u003e\n"],["\u003cp\u003eCommon reasons for errors include missing container types for media variants, and applying video/audio settings to incorrect variant types.\u003c/p\u003e\n"],["\u003cp\u003eThe provided table outlines error fields, their data types, and descriptions for easier debugging.\u003c/p\u003e\n"],["\u003cp\u003eEach error provides a detailed \u003ccode\u003efieldPath\u003c/code\u003e to pinpoint the exact location of the issue within the encoding profile.\u003c/p\u003e\n"]]],["The `DaiEncodingProfileService` manages encoding profile settings, with `ApiError` as a base class for a hierarchy of specific error types. These errors include authentication, size, common, encoding profile-specific, entity limit, and internal API issues. `DaiEncodingProfileVariantSettingsError` is detailed, specifically referencing issues like `CONTAINER_TYPE_REQUIRED`, `VIDEO_SETTINGS_NOT_ALLOWED`, and `AUDIO_SETTINGS_NOT_ALLOWED`. These represent the error reasons related to variant settings within encoding profiles. The namespace is provided.\n"],null,["# type DaiEncodingProfileVariantSettingsError (v202408)\n\n**Service** \n**DaiEncodingProfileService** **Inheritance** \n[ApiError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.CommonError) [DaiEncodingProfileAdMatchin...](/ad-manager/api/reference/v202408/DaiEncodingProfileService.DaiEncodingProfileAdMatchingError \"DaiEncodingProfileAdMatchingError\") [DaiEncodingProfileContainer...](/ad-manager/api/reference/v202408/DaiEncodingProfileService.DaiEncodingProfileContainerSettingsError \"DaiEncodingProfileContainerSettingsError\") [DaiEncodingProfileNameError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.DaiEncodingProfileNameError) [DaiEncodingProfileUpdateError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.DaiEncodingProfileUpdateError) **DaiEncodingProfileVariantSe...** [EntityLimitReachedError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.InternalApiError) [NotNullError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.NotNullError) [NullError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.NullError) [ParseError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/DaiEncodingProfileService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/DaiEncodingProfileService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.QuotaError) [RangeError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.RangeError) [RequiredCollectionError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.RequiredError) [ServerError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.ServerError) [StatementError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.StringLengthError) [UniqueError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.UniqueError)\n\nLists all errors associated with encoding profile variant settings.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202408`\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/v202408/DaiEncodingProfileService.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| **`DaiEncodingProfileVariantSettingsError`** ||\n| ### `reason` | ` `[DaiEncodingProfileVariantSe...](/ad-manager/api/reference/v202408/DaiEncodingProfileService.DaiEncodingProfileVariantSettingsError.Reason \"DaiEncodingProfileVariantSettingsError.Reason\")` ` *** ** * ** *** **Enumerations** `CONTAINER_TYPE_REQUIRED` : Container type is required for a `MEDIA` or `IFRAME` variant. `VIDEO_SETTINGS_NOT_ALLOWED` : Video settings are only allowed for `MEDIA` or `IFRAME` variant types. `AUDIO_SETTINGS_NOT_ALLOWED` : Audio settings are only allowed for `MEDIA` or `IFRAME` variant types. `UNKNOWN` : The value returned if the actual value is not exposed by the requested API version. \u003cbr /\u003e |"]]
