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

Interface ReportDownloaderInterface

All Known Implementing Classes:

ReportDownloader

public interface ReportDownloaderInterface

Utility for downloading AdWords API reports.

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.

Method Detail

downloadReport

ReportDownloadResponse downloadReport(ReportDefinition reportDefinition)
                               throws ReportException,
                                      ReportDownloadResponseException

Downloads a report and returns a ReportDownloadResponse with the results.

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

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

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

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

int getReportDownloadTimeout()

Returns the reportDownloadTimeout in milliseconds.

setReportDownloadTimeout

void setReportDownloadTimeout(int reportDownloadTimeout)

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.

Parameters:

reportDownloadTimeout - the reportDownloadTimeout to set in milliseconds