type ForecastError (v202405)
Errors that can result from a forecast request.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202405
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-05-15 UTC.
[null,null,["Last updated 2024-05-15 UTC."],[[["ForecastError objects represent errors encountered during forecast requests in the Ad Manager API."],["These errors can arise from various reasons, including server issues, insufficient data, inventory limitations, and exceeding request quotas."],["ForecastError includes details such as the error reason, field path, and trigger to help diagnose and address the issue."],["ForecastError.Reason enumeration provides specific error codes like SERVER_NOT_AVAILABLE, NO_FORECAST_YET, NOT_ENOUGH_INVENTORY, and others, offering insights into the nature of the error."],["Developers should handle these errors gracefully by implementing appropriate retry mechanisms and error-handling logic within their Ad Manager API integrations."]]],["The content details the `ForecastError` and related services within the ad manager API. Key services include `AdjustmentService`, `LineItemService`, `OrderService`, `ProposalLineItemService`, and `ProposalService`. It defines `ApiError` and lists numerous specific error types such as `AuthenticationError`, `CollectionSizeError`, `ForecastError` and `InventoryTargetingError`. `ForecastError` reasons include `SERVER_NOT_AVAILABLE`, `NOT_ENOUGH_INVENTORY`, and `EXCEEDED_QUOTA`. The data includes a table outlining fields such as `fieldPath`, `trigger`, and `errorString` for the `ApiError`.\n"]]
