com.google.api.ads.admanager.axis.v202108

Class ReportServiceSoapBindingStub

java.lang.Object

org.apache.axis.client.Stub

com.google.api.ads.admanager.axis.v202108.ReportServiceSoapBindingStub

All Implemented Interfaces:

ReportServiceInterface, Remote, javax.xml.rpc.Stub

public class ReportServiceSoapBindingStub
extends org.apache.axis.client.Stub
implements ReportServiceInterface

Field Summary

Fields inherited from class org.apache.axis.client.Stub

_call, cachedEndpoint, cachedPassword, cachedPortName, cachedProperties, cachedTimeout, cachedUsername, maintainSession, maintainSessionSet, service

Fields inherited from interface javax.xml.rpc.Stub

ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
ReportServiceSoapBindingStub()
ReportServiceSoapBindingStub(javax.xml.rpc.Service service)
ReportServiceSoapBindingStub(URL endpointURL, javax.xml.rpc.Service service)

Method Summary

Modifier and Type	Method and Description
protected org.apache.axis.client.Call	createCall()
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.

Methods inherited from class org.apache.axis.client.Stub

_createCall, _getCall, _getProperty, _getPropertyNames, _getService, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, firstCall, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeader, getResponseHeaders, getResponseHeaders, getTimeout, getUsername, removeProperty, setAttachments, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setRequestHeaders, setTimeout, setUsername

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportServiceSoapBindingStub

public ReportServiceSoapBindingStub()
                             throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

ReportServiceSoapBindingStub

public ReportServiceSoapBindingStub(URL endpointURL,
                                    javax.xml.rpc.Service service)
                             throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

ReportServiceSoapBindingStub

public ReportServiceSoapBindingStub(javax.xml.rpc.Service service)
                             throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

Method Detail

createCall

protected org.apache.axis.client.Call createCall()
                                          throws RemoteException

Throws:

RemoteException

getReportDownloadURL

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

Description copied from interface: ReportServiceInterface

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.

Specified by:

getReportDownloadURL in interface ReportServiceInterface

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

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

Description copied from interface: ReportServiceInterface

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.

Specified by:

getReportDownloadUrlWithOptions in interface ReportServiceInterface

Parameters:

reportJobId - the ID of the ReportJob

reportDownloadOptions - the ReportDownloadOptions for the request

Returns:

the URL for report file download

Throws:

RemoteException

ApiException

getReportJobStatus

public ReportJobStatus getReportJobStatus(Long reportJobId)
                                   throws RemoteException,
                                          ApiException

Description copied from interface: ReportServiceInterface

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

Specified by:

getReportJobStatus in interface ReportServiceInterface

Throws:

RemoteException

ApiException

getSavedQueriesByStatement

public SavedQueryPage getSavedQueriesByStatement(Statement filterStatement)
                                          throws RemoteException,
                                                 ApiException

Description copied from interface: ReportServiceInterface

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

Specified by:

getSavedQueriesByStatement in interface ReportServiceInterface

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

public ReportJob runReportJob(ReportJob reportJob)
                       throws RemoteException,
                              ApiException

Description copied from interface: ReportServiceInterface

Initiates the execution of a ReportQuery on the server.

The following fields are required:

• ReportJob.reportQuery

Specified by:

runReportJob in interface ReportServiceInterface

Parameters:

reportJob - the report job to run

Returns:

the report job with its ID filled in

Throws:

RemoteException

ApiException