type ForecastError (v202411)
Errors that can result from a forecast request.
- 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.
|
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-19 UTC.
[null,null,["Last updated 2024-11-19 UTC."],[[["This document outlines the `ForecastError` object in Google Ad Manager's API."],["`ForecastError` details errors encountered when requesting forecasts for line items, proposals, or orders."],["It provides a `reason` field with specific error codes like `SERVER_NOT_AVAILABLE`, `NO_FORECAST_YET`, and others to explain the issue."],["These error reasons help to diagnose and resolve problems that prevent successful forecasting in Ad Manager."],["Developers can use this information to handle these errors gracefully within their applications."]]],["The document details various services, including AdjustmentService, ForecastService, LineItemService, LineItemTemplateService, OrderService, ProposalLineItemService, and ProposalService, and their associated errors. The core content focuses on `ApiError` and `ForecastError`, which are inherited errors. `ApiError` includes details like field paths, error strings and triggers. `ForecastError` specifies error reasons, like server issues, insufficient data, inventory shortages, exceeding request quotas, and unavailable dates, with specific actions like retrying requests.\n"]]
