com.google.api.ads.adwords.lib.utils.v201710

Class ReportDownloader

java.lang.Object

com.google.api.ads.adwords.lib.utils.v201710.ReportDownloader

All Implemented Interfaces:

ReportDownloaderInterface

public class ReportDownloader
extends Object
implements ReportDownloaderInterface

Reports are fetched synchronously like in the following code:

new ReportDownloader(adWordsSession).downloadReport(reportDefinition);

The adWordsSession is used to authenticate the request against the reportDownloadUrl.

Implementation is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
ReportDownloader(AdWordsSession session) Constructs a ReportDownloader.

Method Summary

Modifier and Type	Method and Description
ReportDownloadResponse	downloadReport(ReportDefinition reportDefinition) Downloads a report and returns a ReportDownloadResponse with the results.
ReportDownloadResponse	downloadReport(String reportQuery, DownloadFormat format) Downloads a report query (AWQL) and returns a ReportDownloadResponse with the results.
int	getReportDownloadTimeout() Returns the reportDownloadTimeout in milliseconds.
void	setReportDownloadTimeout(int reportDownloadTimeout) Sets the timeout for both CONNECT and READ to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportDownloader

public ReportDownloader(AdWordsSession session)

Constructs a ReportDownloader.

Parameters:

session - AdWordsSession to use to make report download requests.

Method Detail

downloadReport

public ReportDownloadResponse downloadReport(ReportDefinition reportDefinition)
                                      throws ReportException,
                                             ReportDownloadResponseException

Description copied from interface: ReportDownloaderInterface

Downloads a report and returns a ReportDownloadResponse with the results.

Specified by:

downloadReport in interface ReportDownloaderInterface

Parameters:

reportDefinition - to download a report for.

Returns:

ReportDownloadResponse If the HTTP request completes successfully.

Throws:

ReportException - If we don't receive a response from the server.

ReportDownloadResponseException - If the server indicates a problem with the request.

downloadReport

public ReportDownloadResponse downloadReport(String reportQuery,
                                             DownloadFormat format)
                                      throws ReportException,
                                             ReportDownloadResponseException

Description copied from interface: ReportDownloaderInterface

Downloads a report query (AWQL) and returns a ReportDownloadResponse with the results.

Specified by:

downloadReport in interface ReportDownloaderInterface

Parameters:

reportQuery - to download a report for.

format - Format to download the report as. CSV,

Returns:

ReportDownloadResponse If the HTTP request completes successfully.

Throws:

ReportException - If there is any issue making HTTP request with server.

ReportDownloadResponseException - If the server indicates a problem with the request.

getReportDownloadTimeout

public int getReportDownloadTimeout()

Description copied from interface: ReportDownloaderInterface

Returns the reportDownloadTimeout in milliseconds.

Specified by:

getReportDownloadTimeout in interface ReportDownloaderInterface

setReportDownloadTimeout

public void setReportDownloadTimeout(int reportDownloadTimeout)

Description copied from interface: ReportDownloaderInterface

Sets the timeout for both CONNECT and READ to the specified value. Defaults to 3 minutes. Set property api.adwords.reportDownloadTimeout in ads.properties or as a system property to set a default for all ReportDownloaders.

Specified by:

setReportDownloadTimeout in interface ReportDownloaderInterface

Parameters:

reportDownloadTimeout - the reportDownloadTimeout to set in milliseconds