An error for an exception that occurred while running the report.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202508
Field
ApiError
(inherited) fieldPath
xsd:
string
The OGNL field path to identify cause of error.
fieldPathElements
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.
ReportError
reason
Enumerations
-
DEFAULT
- Default
ReportError
when the reason is not among any already defined. -
REPORT_ACCESS_NOT_ALLOWED
- User does not have permission to access the report.
-
DIMENSION_VIEW_NOT_ALLOWED
- User does not have permission to view one or more Dimension .
-
ATTRIBUTE_VIEW_NOT_ALLOWED
- User has no permission to view one or more attributes.
-
COLUMN_VIEW_NOT_ALLOWED
- User does not have permission to view one or more Column .
-
REPORT_QUERY_TOO_LONG
- The report query exceeds the maximum allowed number of characters.
-
INVALID_OPERATION_FOR_REPORT_STATE
- Invalid report job state for the given operation.
-
INVALID_DIMENSIONS
- Invalid Dimension objects specified.
-
INVALID_ATTRIBUTES
- The attribute ID(s) are not valid.
-
INVALID_CMS_METADATA_DIMENSIONS
- The API error when running the report with
CmsMetadataKeyDimension
. There are three reasons for this error.- ReportQuery.dimensions contains Dimension.CONTENT_CMS_METADATA , but ReportQuery.cmsMetadataKeyIds is empty.
- ReportQuery.cmsMetadataKeyIds is non-empty, but ReportQuery.dimensions does not contain Dimension.CONTENT_CMS_METADATA .
- The ReportQuery.cmsMetadataKeyIds specified along with the Dimension.CONTENT_CMS_METADATA are not valid, i.e., these IDs are not reportable cms metadata key defined by the publisher.
-
INVALID_COLUMNS
- Invalid Column objects specified.
-
INVALID_DIMENSION_FILTERS
- Invalid
DimensionFilter
objects specified. -
INVALID_DATE
- Invalid date.
-
END_DATE_TIME_NOT_AFTER_START_TIME
- The start date for running the report should not be later than the end date.
-
START_DATE_MORE_THAN_THREE_YEARS_AGO
- The start date for running the report should not be more than three years before now.
-
NOT_NULL
- The list of Dimension and Column objects cannot be empty.
-
ATTRIBUTES_NOT_SUPPORTED_FOR_REQUEST
- Attribute has to be selected in combination with dimensions.
-
COLUMNS_NOT_SUPPORTED_FOR_REQUESTED_DIMENSIONS
- The provided report violates one or more constraints, which govern
incompatibilities and requirements between different report
properties. Some reasons for constraint violations include:
- Not all Column objects requested are supported for the given set of Dimension objects.
- The report's date range is not compatible with the given set of Column objects.
- The report's TimeZoneType is not compatible with the given set of Column and Dimension objects (version 201802 and later).
- The report's currency is not compatible with the given set of Column objects.
-
DATE_RANGE_NOT_SUPPORTED_FOR_REQUESTED_REPORT
- The report's date range is not compatible with the requested Dimension and Column objects.
-
TIME_ZONE_TYPE_NOT_SUPPORTED_FOR_REQUESTED_REPORT
- The report's TimeZoneType is not compatible with the requested Column and Dimension objects.
-
CURRENCY_CODE_NOT_SUPPORTED_FOR_REQUESTED_REPORT
- The report's currency is not compatible with the requested Column objects.
-
FAILED_TO_STORE_REPORT
- Failed to store/cache a report.
-
REPORT_NOT_FOUND
- The requested report does not exist.
-
SR_CANNOT_RUN_REPORT_IN_ANOTHER_NETWORK
- User has no permission to view in another network.
-
AD_UNIT_VIEW_NOT_SUPPORTED_FOR_REQUESTED_REPORT
- The report's
AdUnitView
is not compatible with the requested Dimension and Column objects. -
REPORT_FIELD_TEMPORARILY_DISABLED
- The report uses a field that has been temporarily disabled. See more details at https://ads.google.com/status/publisher.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.