type ForecastError (v202505)

  • ForecastError represents errors that can occur during a forecast request.

  • It inherits from ApiError and includes specific fields like reason.

  • Reasons for ForecastError include server issues, insufficient data, lack of inventory, quota limits, and date range issues.

  • The reason field, with its associated enumerations, provides specific details about why a forecast request failed.
Service
AdjustmentService ForecastService LineItemService LineItemTemplateService OrderService ProposalLineItemService ProposalService
Inheritance
ApiError
▼
ApiVersionError AuthenticationError CollectionSizeError CommonError CustomTargetingError DateError DateTimeRangeTargetingError DayPartTargetingError EntityLimitReachedError FeatureError ForecastAdjustmentError ForecastError GenericTargetingError GeoTargetingError InternalApiError InvalidUrlError InventoryTargetingError InventoryUnitError InventoryUnitSizesError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TechnologyTargetingError TrafficForecastSegmentError TypeError UniqueError UserDomainTargetingError

Errors that can result from a forecast request.

Namespace
https://www.google.com/apis/ads/publisher/v202505

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.

ForecastError

reason

ForecastError.Reason

The reason for the forecast error.

Enumerations
SERVER_NOT_AVAILABLE
The forecast could not be retrieved due to a server side connection problem. Please try again soon.
INTERNAL_ERROR
There was an unexpected internal error.
NO_FORECAST_YET
The forecast could not be retrieved because there is not enough forecasting data available yet. It may take up to one week before enough data is available.
NOT_ENOUGH_INVENTORY
There's not enough inventory for the requested reservation.
SUCCESS
No error from forecast.
ZERO_LENGTH_RESERVATION
The requested reservation is of zero length. No forecast is returned.
EXCEEDED_QUOTA
The number of requests made per second is too high and has exceeded the allowable limit. The recommended approach to handle this error is to wait about 5 seconds and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time.

Another way to mitigate this error is to limit requests to 2 per second. Once again this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error.

OUTSIDE_AVAILABLE_DATE_RANGE
The request falls outside the date range of the available data.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.