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

type InternalApiError (v202505)

AI-generated Key Takeaways

The content describes InternalApiError, which indicates a server-side error not typically caused by an invalid client request.
InternalApiError inherits properties from ApiError including fieldPath, fieldPathElements, trigger, and errorString.
Specific reasons for an InternalApiError include UNEXPECTED_INTERNAL_API_ERROR, TRANSIENT_ERROR, UNKNOWN, DOWNTIME, and ERROR_GENERATING_RESPONSE.
The content also lists numerous services such as AdRuleService, AdjustmentService, and AdsTxtService.
Inheritance relationships are shown, with various specific errors listed under ApiError.

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

▼

ApiVersionError AuthenticationError CollectionSizeError CommonError EntityLimitReachedError FeatureError InternalApiError InventoryUnitSizesError LabelEntityAssociationError NotNullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError 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.

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.