type InternalApiError (v202502)

AI-generated Key Takeaways

• InternalApiError indicates a server-side error, not typically caused by an invalid client request.

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

• Specific reasons for an InternalApiError are provided as enumerations, including unexpected errors, transient issues, unknown causes, downtime, and errors generating a response.

Service

AdRuleService AdjustmentService AdsTxtService AudienceSegmentService CdnConfigurationService CmsMetadataService CompanyService ContactService ContentBundleService ContentService CreativeService CreativeSetService CreativeTemplateService CreativeWrapperService CustomFieldService CustomTargetingService DaiAuthenticationKeyService DaiEncodingProfileService ForecastService InventoryService LabelService LineItemCreativeAssociationService LineItemService LineItemTemplateService LiveStreamEventService MobileApplicationService NativeStyleService NetworkService OrderService PlacementService ProposalLineItemService ProposalService PublisherQueryLanguageService ReportService SegmentPopulationService SiteService StreamActivityMonitorService SuggestedAdUnitService TargetingPresetService TeamService UserService UserTeamAssociationService YieldGroupService

Inheritance

ApiError

▼

AdSenseAccountError AdUnitCodeError AdUnitHierarchyError ApiVersionError AuthenticationError CollectionSizeError CommonError CompanyError CreativeWrapperError CrossSellError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError FrequencyCapError InternalApiError InvalidColorError InvalidUrlError InventoryUnitError InventoryUnitRefreshRateError InventoryUnitSizesError LabelEntityAssociationError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequiredCollectionError RequiredError RequiredNumberError ServerError StatementError StringFormatError StringLengthError TeamError TypeError UniqueError

Indicates that a server-side error has occured. InternalApiErrors are generally not the result of an invalid request or message sent by the client.

---

Namespace

https://www.google.com/apis/ads/publisher/v202502

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.
InternalApiError
reason	InternalApiError.Reason The error reason represented by an enum. Enumerations UNEXPECTED_INTERNAL_API_ERROR API encountered an unexpected internal error. TRANSIENT_ERROR A temporary error occurred during the request. Please retry. UNKNOWN The cause of the error is not known or only defined in newer versions. DOWNTIME The API is currently unavailable for a planned downtime. ERROR_GENERATING_RESPONSE Mutate succeeded but server was unable to build response. Client should not retry mutate.