UrlReportJob
Use a UrlReportJob to get a report that contains statistics
related to ads' destination URLs.
See the
Report Center section of the
AdWords Help Center for information about different kinds of reports.
Use a UrlReportJob in conjunction with the ReportService.
Note:
For statically typed languages, such as Java, create an instance of UrlReportJob.
For dynamically typed languages such as Perl and Python,
create a ReportJob data object and specify its xsi:type attribute as UrlReportJob.
Fields
Inherited Fields
| Field name | Field type | Field description |
|---|
adWordsType |
AdWordsType |
The type indicates where an ad is shown.
You can specify which types to include in the report.
This value is optional. The default is to include ads of all types 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[] |
The campaigns whose ads are to be included in the report. |
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 |
|
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
|
API Reference
