The AdWords API is no longer supported. Use the Google Ads API instead.

ReportDefinitionService (v201809)

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

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 ReportDefinition.ReportType The type of report.
Enumerations
KEYWORDS_PERFORMANCE_REPORT
Reports performance data for your keywords.
AD_PERFORMANCE_REPORT
Reports performance data for your ads.
URL_PERFORMANCE_REPORT
Reports performance data for URLs which triggered your ad and received clicks.
ADGROUP_PERFORMANCE_REPORT
Reports ad group performance data for one or more of your campaigns.
CAMPAIGN_PERFORMANCE_REPORT
Reports performance data for your campaigns.
ACCOUNT_PERFORMANCE_REPORT
Reports performance data for your entire account.
GEO_PERFORMANCE_REPORT
Reports performance data by geographic origin.
SEARCH_QUERY_PERFORMANCE_REPORT
Reports performance data for search queries which triggered your ad and received clicks.
AUTOMATIC_PLACEMENTS_PERFORMANCE_REPORT
Reports performance data for automatic placements on the content network.
CAMPAIGN_NEGATIVE_KEYWORDS_PERFORMANCE_REPORT
Reports performance data for negative keywords at the campaign level.
CAMPAIGN_NEGATIVE_PLACEMENTS_PERFORMANCE_REPORT
Reports performance data for the negative placements at the campaign level.
SHARED_SET_REPORT
Reports data for shared sets.
CAMPAIGN_SHARED_SET_REPORT
Reports data for campaign shared sets.
SHARED_SET_CRITERIA_REPORT
Provides a downloadable snapshot of shared set criteria.
CREATIVE_CONVERSION_REPORT
Reports performance data for creative conversions (e.g. free clicks).
CALL_METRICS_CALL_DETAILS_REPORT
Reports per-phone-call details for calls tracked using call metrics.
KEYWORDLESS_QUERY_REPORT
Reports performance data for keywordless ads.
KEYWORDLESS_CATEGORY_REPORT
Reports performance data for keywordless ads.
CRITERIA_PERFORMANCE_REPORT
Reports performance data for all published criteria types including keywords, placements, topics, user-lists in a single report.
CLICK_PERFORMANCE_REPORT
Reports performance data for clicks.
BUDGET_PERFORMANCE_REPORT
Reports performance data for budgets.
BID_GOAL_PERFORMANCE_REPORT
Reports performance data for your (shared) bid strategies.
DISPLAY_KEYWORD_PERFORMANCE_REPORT
Reports performance data for your display keywords.
PLACEHOLDER_FEED_ITEM_REPORT
Reports performance data for your placeholder feed items
PLACEMENT_PERFORMANCE_REPORT
Reports performance data for your placements.
CAMPAIGN_NEGATIVE_LOCATIONS_REPORT
Reports performance data for negative location targets at campaign level.
GENDER_PERFORMANCE_REPORT
Reports performance data for managed and automatic genders in a combined report.
AGE_RANGE_PERFORMANCE_REPORT
Reports performance data for managed and automatic age ranges in a combined report.
CAMPAIGN_LOCATION_TARGET_REPORT
Reports performance data for campaign level location targets.
CAMPAIGN_AD_SCHEDULE_TARGET_REPORT
Reports performance data for campaign level ad schedule targets.
PAID_ORGANIC_QUERY_REPORT
Paid & organic report
AUDIENCE_PERFORMANCE_REPORT
Reports performance data for your audience criteria.
DISPLAY_TOPICS_PERFORMANCE_REPORT
Reports performance data for your topic criteria.
USER_AD_DISTANCE_REPORT
Distance report
SHOPPING_PERFORMANCE_REPORT
Performance data for shopping campaigns.
PRODUCT_PARTITION_REPORT
Performance data for product partitions in shopping campaigns.
PARENTAL_STATUS_PERFORMANCE_REPORT
Reports performance data for managed and automatic parental statuses in a combined report.
PLACEHOLDER_REPORT
Performance data for Extension placeholders
AD_CUSTOMIZERS_FEED_ITEM_REPORT
Reports performance of ad placeholders when instantiated with specific FeedItems.
LABEL_REPORT
Reports stats and settings details for labels.
FINAL_URL_REPORT
Reports performance data for final urls.
VIDEO_PERFORMANCE_REPORT
Video performance report.
TOP_CONTENT_PERFORMANCE_REPORT
Reports performance data for top content bid modifier criteria.
CAMPAIGN_CRITERIA_REPORT
Report to show campaign criteria structure.
CAMPAIGN_GROUP_PERFORMANCE_REPORT
Report performance data for Campaign Groups.
LANDING_PAGE_REPORT
Reports performance data for landing pages on unexpanded and expanded final url levels.
MARKETPLACE_PERFORMANCE_REPORT
Report performance data for Marketplace Ads Clients.
UNKNOWN

Response

Field Type Description
rval ReportDefinitionField[] 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
AUTHENTICATION_FAILED
Authentication of the request failed.
CLIENT_CUSTOMER_ID_IS_REQUIRED
Client Customer Id is required if CustomerIdMode is set to CLIENT_EXTERNAL_CUSTOMER_ID. Starting version V201409 ClientCustomerId will be required for all requests except for CustomerService.get
CLIENT_EMAIL_REQUIRED
Client Email is required if CustomerIdMode is set to CLIENT_EXTERNAL_EMAIL_FIELD.
CLIENT_CUSTOMER_ID_INVALID
Client customer Id is not a number.
CLIENT_EMAIL_INVALID
Client customer Id is not a number.
CLIENT_EMAIL_FAILED_TO_AUTHENTICATE
Client email is not a valid customer email.
CUSTOMER_NOT_FOUND
No customer found for the customer id provided in the header.
GOOGLE_ACCOUNT_DELETED
Client's Google Account is deleted.
GOOGLE_ACCOUNT_COOKIE_INVALID
Google account login token in the cookie is invalid.
FAILED_TO_AUTHENTICATE_GOOGLE_ACCOUNT
problem occurred during Google account authentication.
GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH
The user in the google account login token does not match the UserId in the cookie.
LOGIN_COOKIE_REQUIRED
Login cookie is required for authentication.
NOT_ADS_USER
User in the cookie is not a valid Ads user.
OAUTH_TOKEN_INVALID
Oauth token in the header is not valid.
OAUTH_TOKEN_EXPIRED
Oauth token in the header has expired.
OAUTH_TOKEN_DISABLED
Oauth token in the header has been disabled.
OAUTH_TOKEN_REVOKED
Oauth token in the header has been revoked.
OAUTH_TOKEN_HEADER_INVALID
Oauth token HTTP header is malformed.
LOGIN_COOKIE_INVALID
Login cookie is not valid.
FAILED_TO_RETRIEVE_LOGIN_COOKIE
Failed to decrypt the login cookie.
USER_ID_INVALID
User Id in the header is not a valid id.
AuthorizationError Errors encountered when trying to authorize a user.
Enumerations
UNABLE_TO_AUTHORIZE
Could not complete authorization due to an internal problem.
NO_ADWORDS_ACCOUNT_FOR_CUSTOMER
Customer has no AdWords account.
USER_PERMISSION_DENIED
User doesn't have permission to access customer.
EFFECTIVE_USER_PERMISSION_DENIED
Effective user doesn't have permission to access this customer.
CUSTOMER_NOT_ACTIVE
Access denied since the customer is not active.
USER_HAS_READONLY_PERMISSION
User has read-only permission cannot mutate.
NO_CUSTOMER_FOUND
No customer found.
SERVICE_ACCESS_DENIED
Developer doesn't have permission to access service.
TWO_STEP_VERIFICATION_NOT_ENROLLED
The customer has a policy to enforce 2-Step Verification, but the user is not enrolled.
ADVANCED_PROTECTION_NOT_ENROLLED
The customer has a policy to enforce enrollment in the Advanced Protection Program, but the user is not enrolled.
ClientTermsError Error due to user not accepting the AdWords terms of service.
Enumerations
INCOMPLETE_SIGNUP_CURRENT_ADWORDS_TNC_NOT_AGREED
Customer has not agreed to the latest AdWords Terms & Conditions
CollectionSizeError Errors associated with the size of the given collection being out of bounds.
Enumerations
TOO_FEW
TOO_MANY
DatabaseError Errors that are thrown due to a database access problem.
Enumerations
CONCURRENT_MODIFICATION
A concurrency problem occurred as two threads were attempting to modify same object.
PERMISSION_DENIED
The permission was denied to access an object.
ACCESS_PROHIBITED
The user's access to an object has been prohibited.
CAMPAIGN_PRODUCT_NOT_SUPPORTED
Requested campaign belongs to a product that is not supported by the api.
DUPLICATE_KEY
a duplicate key was detected upon insertion
DATABASE_ERROR
a database error has occurred
UNKNOWN
an unknown error has occurred
DateError Errors associated with invalid dates and date ranges.
Enumerations
INVALID_FIELD_VALUES_IN_DATE
Given field values do not correspond to a valid date.
INVALID_FIELD_VALUES_IN_DATE_TIME
Given field values do not correspond to a valid date time.
INVALID_STRING_DATE
The string date's format should be yyyymmdd.
INVALID_STRING_DATE_RANGE
The string date range's format should be yyyymmdd yyyymmdd.
INVALID_STRING_DATE_TIME
The string date time's format should be yyyymmdd hhmmss [tz].
EARLIER_THAN_MINIMUM_DATE
Date is before allowed minimum.
LATER_THAN_MAXIMUM_DATE
Date is after allowed maximum.
DATE_RANGE_MINIMUM_DATE_LATER_THAN_MAXIMUM_DATE
Date range bounds are not in order.
DATE_RANGE_MINIMUM_AND_MAXIMUM_DATES_BOTH_NULL
Both dates in range are null.
DistinctError Errors related to distinct ids or content.
Enumerations
DUPLICATE_ELEMENT
DUPLICATE_TYPE
IdError Errors associated with the ids.
Enumerations
NOT_FOUND
Id not found
InternalApiError Indicates that a server-side error has occured. InternalApiErrors are generally not the result of an invalid request or message sent by the client.
Enumerations
UNEXPECTED_INTERNAL_API_ERROR
API encountered an unexpected internal error.
TRANSIENT_ERROR
A temporary error occurred during the request. Please retry.
UNKNOWN
The cause of the error is not known or only defined in newer versions.
DOWNTIME
The API is currently unavailable for a planned downtime.
ERROR_GENERATING_RESPONSE
Mutate succeeded but server was unable to build response. Client should not retry mutate.
NotEmptyError Errors corresponding with violation of a NOT EMPTY check.
Enumerations
EMPTY_LIST
NotWhitelistedError Indicates that the customer is not whitelisted for accessing the API.
Enumerations
CUSTOMER_NOT_WHITELISTED_FOR_API
Customer is not whitelisted for accessing the API.
NullError Errors associated with violation of a NOT NULL check.
Enumerations
NULL_CONTENT
Specified list/container must not contain any null elements
OperationAccessDenied Operation not permitted due to the invoked service's access policy.
Enumerations
ACTION_NOT_PERMITTED
Unauthorized invocation of a service's method (get, mutate, etc.)
ADD_OPERATION_NOT_PERMITTED
Unauthorized ADD operation in invoking a service's mutate method.
REMOVE_OPERATION_NOT_PERMITTED
Unauthorized REMOVE operation in invoking a service's mutate method.
SET_OPERATION_NOT_PERMITTED
Unauthorized SET operation in invoking a service's mutate method.
MUTATE_ACTION_NOT_PERMITTED_FOR_CLIENT
A mutate action is not allowed on this campaign, from this client.
OPERATION_NOT_PERMITTED_FOR_CAMPAIGN_TYPE
This operation is not permitted on this campaign type
ADD_AS_REMOVED_NOT_PERMITTED
An ADD operation may not set status to REMOVED.
OPERATION_NOT_PERMITTED_FOR_REMOVED_ENTITY
This operation is not allowed because the campaign or adgroup is removed.
OPERATION_NOT_PERMITTED_FOR_AD_GROUP_TYPE
This operation is not permitted on this ad group type.
UNKNOWN
The reason the invoked method or operation is prohibited is not known (the client may be of an older version than the server).
OperatorError Errors due to the use of unsupported operations.
Enumerations
OPERATOR_NOT_SUPPORTED
QuotaCheckError Encapsulates the errors thrown during developer quota checks.
Enumerations
INVALID_TOKEN_HEADER
Customer passed in an invalid token in the header.
ACCOUNT_DELINQUENT
Customer is marked delinquent.
ACCOUNT_INACCESSIBLE
Customer is a fraudulent.
ACCOUNT_INACTIVE
Inactive Account.
INCOMPLETE_SIGNUP
Signup not complete
DEVELOPER_TOKEN_NOT_APPROVED
Developer token is not approved for production access, and the customer is attempting to access a production account.
TERMS_AND_CONDITIONS_NOT_SIGNED
Terms and conditions are not signed.
MONTHLY_BUDGET_REACHED
Monthly budget quota reached.
QUOTA_EXCEEDED
Monthly budget quota exceeded.
RangeError A list of all errors associated with the Range constraint.
Enumerations
TOO_LOW
TOO_HIGH
RateExceededError Signals that a call failed because a measured rate exceeded.
Enumerations
RATE_EXCEEDED
Rate exceeded.
ReadOnlyError Errors from attempting to write to read-only fields.
Enumerations
READ_ONLY
RejectedError Indicates that a field was rejected due to compatibility issues.
Enumerations
UNKNOWN_VALUE
Unknown value encountered
ReportDefinitionError Encapsulates the errors that can be thrown during ReportDefinition mutate operation.
Enumerations
INVALID_DATE_RANGE_FOR_REPORT
Customer passed in invalid date range for a report type.
INVALID_FIELD_NAME_FOR_REPORT
Customer passed in invalid field name for a report type
UNABLE_TO_FIND_MAPPING_FOR_THIS_REPORT
Unable to locate a field mapping for this report type.
INVALID_COLUMN_NAME_FOR_REPORT
Customer passed in invalid column name for a report type
INVALID_REPORT_DEFINITION_ID
Customer passed in invalid report definition id.
REPORT_SELECTOR_CANNOT_BE_NULL
Report selector cannot be null.
NO_ENUMS_FOR_THIS_COLUMN_NAME
No Enums exist for this column name.
INVALID_VIEW
Invalid view name.
SORTING_NOT_SUPPORTED
Sorting is not supported for reports.
PAGING_NOT_SUPPORTED
Paging is not supported for reports.
CUSTOMER_SERVING_TYPE_REPORT_MISMATCH
Customer can not create report of a selected type.
CLIENT_SELECTOR_NO_CUSTOMER_IDENTIFIER
Cross-client report has a client selector without any valid identifier for a customer.
CLIENT_SELECTOR_INVALID_CUSTOMER_ID
Cross-client report has an invalid external customer ID in the client selector.
REPORT_DEFINITION_ERROR
RequestError Encapsulates the generic errors thrown when there's an error with user request.
Enumerations
UNKNOWN
Error reason is unknown.
INVALID_INPUT
Invalid input.
UNSUPPORTED_VERSION
The api version in the request has been discontinued. Please update to the new AdWords API version.
RequiredError Errors due to missing required field.
Enumerations
REQUIRED
Missing required field.
SizeLimitError Indicates that the number of entries in the request or response exceeds the system limit.
Enumerations
REQUEST_SIZE_LIMIT_EXCEEDED
The number of entries in the request exceeds the system limit.
RESPONSE_SIZE_LIMIT_EXCEEDED
The number of entries in the response exceeds the system limit.
INTERNAL_STORAGE_ERROR
The account is too large to load.
UNKNOWN
StringFormatError A list of error code for reporting invalid content of input strings.
Enumerations
UNKNOWN
ILLEGAL_CHARS
The input string value contains disallowed characters.
INVALID_FORMAT
The input string value is invalid for the associated field.
StringLengthError Errors associated with the length of the given string being out of bounds.
Enumerations
TOO_SHORT
TOO_LONG