type CommonError (v202411)

  • This webpage outlines a comprehensive list of services available in the Ad Manager API, including AdRuleService, AdjustmentService, AdsTxtService, and many others, providing links to detailed information about each service.

  • The content also covers a variety of common errors that can occur across these services, such as ApiVersionError, AuthenticationError, CollectionSizeError, EntityLimitReachedError, and more, and provides links to learn more about the specific errors.

  • The webpage defines the CommonError enumeration, which lists specific error types like NOT_FOUND, ALREADY_EXISTS, NOT_APPLICABLE, DUPLICATE_OBJECT, CANNOT_UPDATE, UNSUPPORTED_OPERATION, CONCURRENT_MODIFICATION, and UNKNOWN, detailing their meaning.

  • The ApiError type, which is inherited, includes fields such as fieldPath, fieldPathElements, trigger, and errorString, each described in detail.

  • The document uses the namespace https://www.google.com/apis/ads/publisher/v202411 for all content defined within it.
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 NotNullError NullError OrderError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TeamError TypeError UniqueError

A place for common errors that can be used across services.

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.

CommonError

reason

CommonError.Reason

Enumerations
NOT_FOUND
Indicates that an attempt was made to retrieve an entity that does not exist.
ALREADY_EXISTS
Indicates that an attempt was made to create an entity that already exists.
NOT_APPLICABLE
Indicates that a value is not applicable for given use case.
DUPLICATE_OBJECT
Indicates that two elements in the collection were identical.
CANNOT_UPDATE
Indicates that an attempt was made to change an immutable field.
UNSUPPORTED_OPERATION
Indicates that the requested operation is not supported.
CONCURRENT_MODIFICATION
Indicates that another request attempted to update the same data in the same network at about the same time. Please wait and try the request again.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.