DefinedReportJob (AdWords API Developer's Guide)

DefinedReportJob

Data representing a report. To create a report, you first choose one of the available report types. You then select aggregation types, start and end dates, and a list of columns. The other fields are optional.

Each report type has its own set of valid aggregation types and columns -- for a list of these choices, see the report rules page.

Before scheduling a report, you should validate it by sending a request to validateReportJob. See ReportService for how to validate, schedule and download a report.

Note: For statically typed languages, such as Java, create an instance of DefinedReportJob. For dynamically typed languages such as Perl and Python, create a ReportJob data object and specify its xsi:type attribute as DefinedReportJob.

Fields

adGroups new in v11
adGroupStatuses new in v11
adWordsType new in v11
aggregationTypes new in v11
campaigns new in v11
campaignStatuses new in v11
keywords new in v11
keywordStatuses new in v11
keywordType new in v11
selectedColumns new in v11
selectedReportType new in v11

Inherited Fields

aggregationType new in v11
clientEmails new in v11
crossClient new in v11
endDay new in v11
id new in v11
includeZeroImpression new in v11
name new in v11
startDay new in v11
status new in v11

Field name	Field type	Field description
`adGroups` new in v11	`int[]`	Specifies the ids of the adgroups to include in the report. You should specify either the ad group ids or the ad group statuses, but not both.
`adGroupStatuses` new in v11	`AdGroupStatus[]`	Only adgroups that have one of the specified statuses will be included in the report. You should specify either the ad group statuses or the ad group ids, but not both. Values are: Enabled Paused Deleted
`adWordsType` new in v11	`AdWordsType`	The type of AdWords account. Values are: SearchOnly -- ads are displayed on search results pages only ContentOnly -- ads are displayed on content pages only
`aggregationType`	`AggregationType`	The aggregation type for the report. The default is Summary. Values are: Summary Daily Monthly Quarterly Yearly HourlyRegardlessDate - Works only in CampaignReportJob and AccountReportJob HourlyByDate - Works only in CampaignReportJob and AccountReportJob Weekly DayOfWeek new in v11
`aggregationTypes` new in v11	`string[]`	A list of aggregation types to use for this report. The value of `selectedReportType` determines which aggregation types you can use. For more information, see the report rules.
`campaigns` new in v11	`int[]`	Specifies the ids of the campaigns to include in the report. You should specify either the campaign ids or the campaign statuses, but not both.
`campaignStatuses` new in v11	`CampaignStatus[]`	Only campaigns that have one of the specified statuses will be included in the report. You should specify either the campaign statuses or the campaign ids, but not both. The allowed statuses are: Active Paused Deleted
`clientEmails`	`string[]`	This field is only applicable to My Client Center (MCC) managers. Supply this field when you want to generate a report that includes multiple client accounts. The value is an array of the logins for the accounts to include in the report. To generate a report that includes multiple accounts, you must also set the `crossClient` field to `true`. If the `crossClient` field is `false` or is not supplied, the `clientEmails` list is ignored. If `crossClient` is `true` and the `clientEmails` list is empty, a cross-client report is run across all of a manager's client accounts.
`crossClient`	`boolean`	This field is only applicable to My Client Center (MCC) managers; it indicates whether to include a single account or multiple client accounts in the report. The default is `false`, meaning that the report is for a single account. Specify this field as `true` if you are an MCC manager and you want to generate a report that includes multiple client accounts. Indicate the accounts to include in the report by specifying a list of account Ids in the `clientEmails` field. To include all your client accounts in the report, leave the `clientEmails` field blank.
`endDay`	`date`	End date for the report. End dates are required. The value is an xsd:date, which can have date and timezone values. See Start and End Dates for Reports for more details.
`id`	`long`	The report id. This is returned by the `ReportService.scheduleReportJob` request.
`includeZeroImpression` new in v11	`boolean`	Include entities that have zero impressions in the report. With `DefinedReportJob` objects, this field's value only has an effect if you set `selectedReportType` to Keyword.
`keywords` new in v11	`string[]`	The keywords to include in the report. By default, all keywords in all relevant ad groups and campaigns are included. You should specify either the keyword values or the keyword statuses, but not both.
`keywordStatuses` new in v11	`KeywordStatus[]`	Only keywords that have one of these statuses will be included in the report. You should specify either the keyword statuses or the keyword values, but not both. Values are: Disapproved Deleted Paused Active InActive
`keywordType` new in v11	`KeywordType`	Only keywords of this matching type will be included in the report. Values are: Broad Phrase Exact
`name`	`string`	The name of the report. This can be anything you like. The name is optional.
`selectedColumns` new in v11	`string[]`	A list of columns to include in this report. The values you choose for `selectedReportType` and `aggregationTypes` determine which columns you can include. For more information, see the report rules.
`selectedReportType` new in v11	`string`	The report type to use. See the report rules for valid aggregation selections and columns for each report type. Values are: Account - Account Performance AdGroup - Ad Group Performance Campaign - Campaign Performance ContentPlacement - Placement Performance Creative - Ad Performance Keyword - Placement / Keyword Performance ReachAndFrequency - Reach and Frequency Performance Structure - Account Structure Url - URL Performance
`startDay`	`date`	Start date for the report. Start dates are required. The value is an xsd:date, which can have date and timezone values. In hourly reports, only start dates of Feb 1, 2006 or later are valid; dates before that produce an error. See Start and End Dates for Reports for more details.
`status`	`ReportJobStatus`	The status is only set for jobs returned by the `getAllJobs` request. To check the status of a submitted job, send a `getReportJobStatus` request to the ReportService instead of directly checking the status on the report job. Values are: Pending InProgress Completed Failed