com.google.api.ads.admanager.axis.v201808

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.
ReportJobStatus	getReportJobStatus(Long reportJobId) Returns the ReportJobStatus of the report job with the specified ID.
SavedQueryPage	getSavedQueriesByStatement(Statement filterStatement) Retrieves a page of the saved queries either created by or shared with the current user.
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

getReportJobStatus

ReportJobStatus getReportJobStatus(Long reportJobId)
                            throws RemoteException,
                                   ApiException

Returns the ReportJobStatus of the report job with the specified ID.

Throws:

RemoteException

ApiException

getSavedQueriesByStatement

SavedQueryPage getSavedQueriesByStatement(Statement filterStatement)
                                   throws RemoteException,
                                          ApiException

Retrieves a page of the saved queries either created by or shared with the current user. Each SavedQuery in the page, if it is compatible with the current API version, will contain a ReportQuery object which can be optionally modified and used to create a ReportJob. This can then be passed to ReportService#runReportJob. The following fields are supported for filtering:

PQL Property	Object Property
id	SavedQuery.id
name	SavedQuery.name

Parameters:

filterStatement - a Publisher Query Language statement used to filter which saved queries should be returned.

Returns:

a SavedQueryPage that contains all SavedQuery instances which satisfy the given statement.

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