type AudienceSegmentError (v202411)

AI-generated Key Takeaways

• AudienceSegmentError is used to indicate errors related to audience segment requests within various services like AudienceSegmentService, ForecastService, and LineItemService.

• This error inherits properties from ApiError such as fieldPath, fieldPathElements, trigger, and errorString.

• AudienceSegmentError includes a specific reason field with various enumeration values explaining different causes for the error, such as invalid names, rules, values, or segment IDs.

• The possible reasons cover a wide range of issues including unsupported segment types, invalid rule complexity, and policy violations.

Service

AudienceSegmentService ForecastService LineItemService LineItemTemplateService OrderService ProposalLineItemService ProposalService PublisherQueryLanguageService

Inheritance

ApiError

▼

ApiVersionError AssetError AudienceExtensionError AudienceSegmentError AuthenticationError ClickTrackingLineItemError CollectionSizeError CommonError CompanyCreditStatusError CreativeError CrossSellError CurrencyCodeError CustomFieldValueError CustomTargetingError DateTimeRangeTargetingError DayPartTargetingError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError ForecastError FrequencyCapError GenericTargetingError GeoTargetingError GrpSettingsError ImageError InternalApiError InvalidUrlError InventoryTargetingError LabelEntityAssociationError LineItemActivityAssociation... LineItemCreativeAssociation... LineItemError LineItemFlightDateError LineItemOperationError MobileApplicationTargetingE... NotNullError NullError OrderActionError OrderError ParseError PermissionError PrecisionError ProgrammaticError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequestPlatformTargetingError RequiredCollectionError RequiredError RequiredNumberError RequiredSizeError ReservationDetailsError ServerError SetTopBoxLineItemError StatementError StringFormatError StringLengthError TeamError TechnologyTargetingError TimeZoneError TranscodingError TypeError UniqueError UserDomainTargetingError VideoPositionTargetingError

Errors that could occur on audience segment related requests.

---

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.
AudienceSegmentError
reason	AudienceSegmentError.Reason Enumerations FIRST_PARTY_AUDIENCE_SEGMENT_NOT_SUPPORTED First party audience segment is not supported. ONLY_RULE_BASED_FIRST_PARTY_AUDIENCE_SEGMENTS_CAN_BE_CREATED Only rule-based first-party audience segments can be created. AUDIENCE_SEGMENT_ID_NOT_FOUND Audience segment for the given id is not found. INVALID_AUDIENCE_SEGMENT_RULE Audience segment rule is invalid. AUDIENCE_SEGMENT_RULE_TOO_LONG Audience segment rule contains too many ad units and/or custom criteria. INVALID_AUDIENCE_SEGMENT_NAME Audience segment name is invalid. DUPLICATE_AUDIENCE_SEGMENT_NAME Audience segment with this name already exists. INVALID_AUDIENCE_SEGMENT_DESCRIPTION Audience segment description is invalid. INVALID_AUDIENCE_SEGMENT_PAGEVIEWS Audience segment pageviews value is invalid. It must be between 1 and 12. INVALID_AUDIENCE_SEGMENT_RECENCY Audience segment recency value is invalid. It must be between 1 and 90 if pageviews > 1. INVALID_AUDIENCE_SEGMENT_MEMBERSHIP_EXPIRATION Audience segment membership expiration value is invalid. It must be between 1 and 180. INVALID_AUDIENCE_SEGMENT_CUSTOM_KEY_NAME The given custom key cannot be part of audience segment rule due to unsupported characters. INVALID_AUDIENCE_SEGMENT_CUSTOM_VALUE_NAME The given custom value cannot be part of audience segment rule due to unsupported characters. INVALID_AUDIENCE_SEGMENT_CUSTOM_VALUE_MATCH_TYPE Broad-match custom value cannot be part of audience segment rule. INVALID_NESTED_FIRST_PARTY_AUDIENCE_SEGMENT Audience segment rule cannot contain itself. SHARED_SELLING_PARTNER_ROOT_CANNOT_BE_INCLUDED Audience segment rule cannot contain shared selling inventory unit. INVALID_NESTED_THIRD_PARTY_AUDIENCE_SEGMENT Audience segment rule cannot contain a nested third-party segment. INACTIVE_NESTED_AUDIENCE_SEGMENT Audience segment rule cannot contain a nested inactive segment. AUDIENCE_SEGMENT_GLOBAL_LICENSE_ERROR An error occurred when purchasing global licenses. SEGMENT_VIOLATED_POLICY Segment cannot be activated as it violates Google's Platform Policy. UNKNOWN The value returned if the actual value is not exposed by the requested API version.