Documentation for the requested version is not available.Documentation for the requested diff is not available.
Data representing a report job. DefinedReportJob is used by
ReportService.
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.
| Field name | Field type | Field description |
|---|---|---|
| adGroups | long[] |
IDs of ad groups to include in the report. By default, all ad groups in
the specified campaigns are included.
You can set adGroups or adGroupStatuses, but not
both. |
| adGroupStatuses | AdGroupStatus[] |
Only ad groups that currently (at report generation time) have one of
these statuses will be included in the report. By default, ad groups in
any status are included.
You can set adGroups or adGroupStatuses, but not
both.
Values are:
|
| adWordsType | AdWordsType |
The type of AdWords account.
Values are:
|
| aggregationTypes | string[] |
List of aggregation types to use for this report. This field is
constrained by selectedReportType. For more information, see
the report rules. |
| campaigns | int[] |
IDs of campaigns to include in the report. By default, all campaigns are
included.
You can set campaigns or campaignStatuses, but
not both. |
| campaignStatuses | CampaignStatus[] |
Only campaigns that currently (at report generation time) have one of
these statuses will be included in the report. By default, campaigns in
any status are included.
You can set campaigns or campaignStatuses, but
not both.
The allowed statuses are:
|
| 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 | 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.
Set this field to |
| endDay | date |
End date for the report (inclusive), relative to your account's local
time zone. This field is required.
See Start and End Dates for Reports for more details. |
| id | long |
Report ID. This is set and returned by
ReportService.scheduleReportJob. |
| 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[] |
Keywords to include in the report. By default, all keywords in the
specified ad groups and campaigns are included.
You can set keywords or keywordStatuses, but not
both. |
| keywordStatuses | KeywordStatus[] |
Only keywords that currently (at report generation time) have one of these
statuses will be included in the report. By default, keywords in any status
are included.
You can set keywords or keywordStatuses, but not
both.
Values are:
|
| keywordType | KeywordType |
Only keywords of this type will be included in the report. By
default, all keyword types are included in the report.
Values are:
|
| name | string |
Name of the report (no longer than 80 characters). |
| selectedColumns | string[] |
List of columns to include in this report. This field is constrained by
selectedReportType and aggregationTypes. For more
information, see the report rules. |
| selectedReportType | string |
Type of report to schedule.
See the report rules
for valid aggregation selections and columns for each report type.
Values are:
|
| startDay | date |
Start date for the report (inclusive), relative to your account's local
time zone. This field is required.
For Campaign and Account reports using hourly aggregation,
startDay must be 2006-02-01 or later. For Ad Group
reports using hourly aggregation, startDay must be
2007-02-01 or later.
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:
|
|
