My favorites | English | Sign in

More personalization in Google Friend Connect New!

Documentation for the requested version is not available.Documentation for the requested diff is not available.

Report Rules

Link to this version

The DefinedReportJob type is generalized to let AdWords API expose new report functionality without requiring a version change. This topic describes how to define a valid DefinedReportJob object. For general information on reports and ReportService, see the ReportService overview.

The following constraints exist between fields in DefinedReportJob

  • selectedReportType defines the report type.
  • aggregationTypes, which defines the report aggregations, is constrained by selectedReportType.
  • selectedColumns, which defines the columns to include, is constrained by selectedReportType and aggregationTypes.

Because of these constraints, selectedReportType, aggregationTypes, and selectedColumns use strings instead of enumerations. Therefore, it's possible to accidentally include columns or aggregation types that conflict with the report type.

Here are some tips to help you schedule a valid report:

  • Consult the type-specific rules for each report. Make sure you choose appropriate columns and aggregation types.
  • Use the AdWords Report Center, located on the AdWords website, to create a report with the same aggregation types and columns as the one you want to schedule using the API. If you can create the report using the user interface, the corresponding DefinedReportJob object should be valid.
  • Validate your report job using validateReportJob before scheduling the report. Validating a report job costs only 1 API unit, whereas a failed call to scheduleReportJob will cost 500 API units.

Type-specific Report Constraints

The following pages describe which columns and aggregations can be used with each report type (parentheses indicate the corresponding selectedReportType value):