Note: As of v201109 this service is read-only. New report definitions are no longer allowed.
A report definition describes the report type, date range, and fields to include in the report. Additionally, you can specify predicates to filter which rows are returned in a generated report. Please note that sorting and paging are not supported for report downloads.
To find out which report fields are available based on report type, see the Report Types appendix or call getReportFields.
For more information about retrieving reports, see Reporting Basics.
- Production WSDL
-
https://adwords.google.com/api/adwords/cm/v201809/ReportDefinitionService?wsdl
- Namespace
-
https://adwords.google.com/api/adwords/cm/v201809
- Operations
- Errors
-
- AuthenticationError
- AuthorizationError
- ClientTermsError
- CollectionSizeError
- DatabaseError
- DateError
- DistinctError
- IdError
- InternalApiError
- NotEmptyError
- NotWhitelistedError
- NullError
- OperationAccessDenied
- OperatorError
- QuotaCheckError
- RangeError
- RateExceededError
- ReadOnlyError
- RejectedError
- ReportDefinitionError
- RequestError
- RequiredError
- SizeLimitError
- StringFormatError
- StringLengthError
getReportFields
Returns the available report fields for a given report type.
When using this method the clientCustomerId
header field is
optional. Callers are discouraged from setting the clientCustomerId
header field in calls to this method as its presence will trigger an
authorization error if the caller does not have access to the customer
with the included ID.
Parameters
Field | Type | Description |
---|---|---|
reportType
|
|
The type of report. Enumerations
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
The list of available report fields. Each
ReportDefinitionField encapsulates the field name, the
field data type, and the enum values (if the field's type is
enum ). |
Errors
Error | Reasons |
---|---|
AuthenticationError
|
Errors returned when Authentication failed.
Enumerations
|
AuthorizationError
|
Errors encountered when trying to authorize a user.
Enumerations
|
ClientTermsError
|
Error due to user not accepting the AdWords terms of service.
Enumerations
|
CollectionSizeError
|
Errors associated with the size of the given collection being
out of bounds.
Enumerations
|
DatabaseError
|
Errors that are thrown due to a database access problem.
Enumerations
|
DateError
|
Errors associated with invalid dates and date ranges.
Enumerations
|
DistinctError
|
Errors related to distinct ids or content.
Enumerations
|
IdError
|
Errors associated with the ids.
Enumerations
|
InternalApiError
|
Indicates that a server-side error has occured. InternalApiError s
are generally not the result of an invalid request or message sent by the
client.
Enumerations
|
NotEmptyError
|
Errors corresponding with violation of a NOT EMPTY check.
Enumerations
|
NotWhitelistedError
|
Indicates that the customer is not whitelisted for accessing the API.
Enumerations
|
NullError
|
Errors associated with violation of a NOT NULL check.
Enumerations
|
OperationAccessDenied
|
Operation not permitted due to the invoked service's access policy.
Enumerations
|
OperatorError
|
Errors due to the use of unsupported operations.
Enumerations
|
QuotaCheckError
|
Encapsulates the errors thrown during developer quota checks.
Enumerations
|
RangeError
|
A list of all errors associated with the Range constraint.
Enumerations
|
RateExceededError
|
Signals that a call failed because a measured rate exceeded.
Enumerations
|
ReadOnlyError
|
Errors from attempting to write to read-only fields.
Enumerations
|
RejectedError
|
Indicates that a field was rejected due to compatibility issues.
Enumerations
|
ReportDefinitionError
|
Encapsulates the errors that can be thrown during ReportDefinition
mutate operation.
Enumerations
|
RequestError
|
Encapsulates the generic errors thrown when there's an error with user
request.
Enumerations
|
RequiredError
|
Errors due to missing required field.
Enumerations
|
SizeLimitError
|
Indicates that the number of entries in the request or response exceeds the system limit.
Enumerations
|
StringFormatError
|
A list of error code for reporting invalid content of input strings.
Enumerations
|
StringLengthError
|
Errors associated with the length of the given string being
out of bounds.
Enumerations
|