org.mule.modules.google.dfp.premium.services

Class ReportService

java.lang.Object

org.mule.modules.google.dfp.premium.services.ReportService

public class ReportService
extends Object

Service containing Report helper methods.

Constructor Summary

Constructors

Constructor and Description
ReportService()

Method Summary

Modifier and Type	Method and Description
com.google.api.ads.admanager.axis.v201902.ReportJob	createReport(com.google.api.ads.admanager.lib.client.AdManagerSession session, com.google.api.ads.admanager.axis.v201902.Date startDateWithTimezone, com.google.api.ads.admanager.axis.v201902.Date endDateWithTimezone, String dimensions, String columns, String dimensionAttributes) Create a Report.
protected com.google.api.ads.admanager.axis.v201902.ReportServiceInterface	createReportService(com.google.api.ads.admanager.lib.client.AdManagerSession session)
com.google.api.ads.admanager.axis.v201902.ReportJob	createReportSync(com.google.api.ads.admanager.lib.client.AdManagerSession session, com.google.api.ads.admanager.axis.v201902.Date startDateWithTimezone, com.google.api.ads.admanager.axis.v201902.Date endDateWithTimezone, String dimensions, String columns, String dimensionAttributes) Creates a Report Asynchronously.
InputStream	downloadReport(com.google.api.ads.admanager.lib.client.AdManagerSession session, com.google.api.ads.admanager.axis.v201902.ReportJob reportJob, String exportFormat) Download the specified report.
String	getReportDownloadUrlWithOptions(com.google.api.ads.admanager.lib.client.AdManagerSession session, Long reportJobId, com.google.api.ads.admanager.axis.v201902.ReportDownloadOptions reportDownloadOptions) Retrieved the report download URL using the specified options.
com.google.api.ads.admanager.axis.v201902.ReportJobStatus	getReportStatus(com.google.api.ads.admanager.lib.client.AdManagerSession session, Long reportId) Retrieves the Report Status.
List<com.google.api.ads.admanager.axis.v201902.SavedQuery>	getSavedQueriesByStatements(com.google.api.ads.admanager.lib.client.AdManagerSession session, String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieve the Saved Queries by Statements.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportService

public ReportService()

Method Detail

createReportService

protected com.google.api.ads.admanager.axis.v201902.ReportServiceInterface createReportService(com.google.api.ads.admanager.lib.client.AdManagerSession session)

getReportStatus

public com.google.api.ads.admanager.axis.v201902.ReportJobStatus getReportStatus(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                                                                 Long reportId)
                                                                          throws AdManagerApiException

Retrieves the Report Status.

Parameters:

session - the API session

reportId - the session ID

Returns:

ReportJobStatus the ReportJobStatus

Throws:

AdManagerApiException - if there is a problem with the request made to the API.

createReportSync

public com.google.api.ads.admanager.axis.v201902.ReportJob createReportSync(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                                                            com.google.api.ads.admanager.axis.v201902.Date startDateWithTimezone,
                                                                            com.google.api.ads.admanager.axis.v201902.Date endDateWithTimezone,
                                                                            String dimensions,
                                                                            String columns,
                                                                            String dimensionAttributes)
                                                                     throws AdManagerException

Creates a Report Asynchronously.

Parameters:

session - the API session

startDateWithTimezone - the start date including timezone

endDateWithTimezone - the end date including timezone

dimensions - the dimensions

columns - the columns

dimensionAttributes - the dimension attributes

Returns:

ReportJob the report job

Throws:

AdManagerException - AdManagerApiException if there is a problem with the request made to the API. AdManagerCommunicationException if there is a communication problem with the API (such as timeouts etc.)

createReport

public com.google.api.ads.admanager.axis.v201902.ReportJob createReport(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                                                        com.google.api.ads.admanager.axis.v201902.Date startDateWithTimezone,
                                                                        com.google.api.ads.admanager.axis.v201902.Date endDateWithTimezone,
                                                                        String dimensions,
                                                                        String columns,
                                                                        String dimensionAttributes)
                                                                 throws AdManagerException

Create a Report.

Parameters:

session - the API session

startDateWithTimezone - the start date with timezone

endDateWithTimezone - the end date with timezone

dimensions - the dimensions

columns - the columns

dimensionAttributes - the dimension attributes

Returns:

ReportJob the report job

Throws:

AdManagerException - AdManagerApiException if there is a problem with the request made to the API. AdManagerCommunicationException if there is a communication problem with the API (such as timeouts etc.)

downloadReport

public InputStream downloadReport(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                  com.google.api.ads.admanager.axis.v201902.ReportJob reportJob,
                                  String exportFormat)
                           throws AdManagerApiException,
                                  AdManagerCommunicationException

Download the specified report.

Parameters:

session - an API session

reportJob - the API report job

exportFormat - the export format

Returns:

InputStream the download URL

Throws:

AdManagerApiException - if there is a problem with the request made to the API.

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)

getReportDownloadUrlWithOptions

public String getReportDownloadUrlWithOptions(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                              Long reportJobId,
                                              com.google.api.ads.admanager.axis.v201902.ReportDownloadOptions reportDownloadOptions)
                                       throws AdManagerCommunicationException

Retrieved the report download URL using the specified options.

Parameters:

session - the API session

reportJobId - the report job ID

reportDownloadOptions - the report download options

Returns:

String the report download URL

Throws:

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)

getSavedQueriesByStatements

public List<com.google.api.ads.admanager.axis.v201902.SavedQuery> getSavedQueriesByStatements(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                                                                              String queryString,
                                                                                              Map<String,Object> queryParams,
                                                                                              String queryOrder,
                                                                                              Integer queryOffset)
                                                                                       throws AdManagerApiException,
                                                                                              AdManagerCommunicationException

Retrieve the Saved Queries by Statements.

Parameters:

session - the API session

queryString - the query

queryParams - the query parameters

queryOrder - the order

queryOffset - the offset

Returns:

List<SavedQuery> list of SaveQueries

Throws:

AdManagerApiException - if there is a problem with the request made to the API.

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)