CustomReportJob (AdWords API Developer's Guide)

CustomReportJob removed in v11

Use a CustomReportJob to get a custom report about your ads. Specify the statistics and level of detail to include in the report by setting the customOptions field. The report contains only the statistics and level of detail that you specify; if you don't provide any values for the customOptions field, you will get an error.

Use a CustomReportJob in conjunction with the ReportService.

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

Custom reports are only available through the ReportService in the AdWords API; you cannot create custom reports through the Report Center in the AdWords web interface.

Fields

adGroups removed in v11
adGroupStatuses removed in v11
adWordsType removed in v11
campaigns removed in v11
campaignStatuses removed in v11
customOptions removed in v11
keywords removed in v11
keywordStatuses removed in v11
keywordType removed in v11

Inherited Fields

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

Field name	Field type	Field description
`adGroups`	`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`	`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`	`AdWordsType`	Only adgroups that have the specified syndication type will be included in in the report. 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
`campaigns`	`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`	`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 For descriptions of these statuses, see `status`.
`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.
`customOptions`	`CustomReportOption[]`	The custom report options specify the information to include in the report. You must specify at least one custom option or you will get an error. See Custom Options.
`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`	`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`	`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`	`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`	`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.
`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