com.google.api.ads.dfp.axis.v201411

Interface ReportServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

ReportServiceSoapBindingStub

public interface ReportServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
String	getReportDownloadURL(Long reportJobId, ExportFormat exportFormat) Returns the URL at which the report file can be downloaded.
String	getReportDownloadUrlWithOptions(Long reportJobId, ReportDownloadOptions reportDownloadOptions) Returns the URL at which the report file can be downloaded, and allows for customization of the downloaded report.
ReportJob	getReportJob(Long reportJobId) Returns the ReportJob uniquely identified by the given ID with only the ReportJob.reportJobStatus and ReportJob.id fields filled in.
ReportJob	runReportJob(ReportJob reportJob) Initiates the execution of a ReportQuery on the server.

Method Detail

getReportDownloadURL

String getReportDownloadURL(Long reportJobId,
                            ExportFormat exportFormat)
                     throws RemoteException,
                            ApiException

Returns the URL at which the report file can be downloaded.

The report will be generated as a gzip archive, containing the report file itself.

Parameters:

reportJobId - the ID of the ReportJob

exportFormat - the ExportFormat for the report file

Returns:

the URL for report file download

Throws:

RemoteException

ApiException

getReportDownloadUrlWithOptions

String getReportDownloadUrlWithOptions(Long reportJobId,
                                       ReportDownloadOptions reportDownloadOptions)
                                throws RemoteException,
                                       ApiException

Returns the URL at which the report file can be downloaded, and allows for customization of the downloaded report.

By default, the report will be generated as a gzip archive, containing the report file itself. This can be changed by setting ReportDownloadOptions.useGzipCompression to false.

Parameters:

reportJobId - the ID of the ReportJob

reportDownloadOptions - the ReportDownloadOptions for the request

Returns:

the URL for report file download

Throws:

RemoteException

ApiException

getReportJob

ReportJob getReportJob(Long reportJobId)
                throws RemoteException,
                       ApiException

Returns the ReportJob uniquely identified by the given ID with only the ReportJob.reportJobStatus and ReportJob.id fields filled in.

Replaced with ReportService.getReportJobStatus beginning in V201505.

Parameters:

reportJobId - the Id of the report job which must already exist

Returns:

the ReportJob uniquely identified by the given ID with the ID and status fields filled in.

Throws:

RemoteException

ApiException

runReportJob

ReportJob runReportJob(ReportJob reportJob)
                throws RemoteException,
                       ApiException

Initiates the execution of a ReportQuery on the server.

The following fields are required:

• ReportJob.reportQuery

Parameters:

reportJob - the report job to run

Returns:

the report job with its ID filled in

Throws:

RemoteException

ApiException