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

Class AdHocReportDownloadHelper

java.lang.Object

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

All Implemented Interfaces:

AdHocReportDownloadHelperInterface

public class AdHocReportDownloadHelper
extends Object
implements AdHocReportDownloadHelperInterface

Helper class that handles AdHoc report downloads. Requests will be logged (header and payload) to INFO. Successful reports will be logged (headers and response code) to INFO. Failed reports will be logged in their entirety to WARN.

Field Summary

Fields inherited from interface com.google.api.ads.adwords.lib.utils.AdHocReportDownloadHelperInterface

REPORT_CHARSET

Method Summary

Modifier and Type	Method and Description
RawReportDownloadResponse	downloadReport(ReportRequest reportRequest) Downloads a report and returns a ReportDownloadResponse with the results.
ReportDownloadResponse	downloadReport(ReportRequest reportRequest, DetailedReportDownloadResponseException.Builder exceptionBuilder) Convenience method that is equivalent to handleResponse(downloadReport(reportRequest), exceptionBuilder)
int	getReportDownloadTimeout() Returns the reportDownloadTimeout in milliseconds
ReportDownloadResponse	handleResponse(RawReportDownloadResponse rawResponse, DetailedReportDownloadResponseException.Builder exceptionBuilder) Handles a raw report response and translates it into a ReportDownloadResponse.
void	setReportDownloadTimeout(int reportDownloadTimeout) Sets the reportDownloadTimeout (milliseconds).

Methods inherited from class java.lang.Object

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

Method Detail

downloadReport

public ReportDownloadResponse downloadReport(ReportRequest reportRequest,
                                             DetailedReportDownloadResponseException.Builder exceptionBuilder)
                                      throws ReportException,
                                             ReportDownloadResponseException

Description copied from interface: AdHocReportDownloadHelperInterface

Convenience method that is equivalent to handleResponse(downloadReport(reportRequest), exceptionBuilder)

Specified by:

downloadReport in interface AdHocReportDownloadHelperInterface

Parameters:

reportRequest - the report request.

exceptionBuilder - the version-specific exception builder a new ReportDownloadResponse.

Throws:

ReportException - if there is an exception while making the HTTP request to the server.

ReportDownloadResponseException - if unable to read the raw response's input stream.

downloadReport

public RawReportDownloadResponse downloadReport(ReportRequest reportRequest)
                                         throws ReportException

Description copied from interface: AdHocReportDownloadHelperInterface

Downloads a report and returns a ReportDownloadResponse with the results.

Specified by:

downloadReport in interface AdHocReportDownloadHelperInterface

Parameters:

reportRequest - the report request.

Returns:

encapsulated http response body and status code.

Throws:

ReportException - if there is an exception while making the HTTP request to the server.

handleResponse

public ReportDownloadResponse handleResponse(RawReportDownloadResponse rawResponse,
                                             DetailedReportDownloadResponseException.Builder exceptionBuilder)
                                      throws ReportDownloadResponseException

Description copied from interface: AdHocReportDownloadHelperInterface

Handles a raw report response and translates it into a ReportDownloadResponse.

Specified by:

handleResponse in interface AdHocReportDownloadHelperInterface

Parameters:

rawResponse - the raw response from an API report download request.

exceptionBuilder - the version-specific exception builder.

Returns:

a new ReportDownloadResponse.

Throws:

ReportDownloadResponseException - if unable to read the raw response's input stream.

getReportDownloadTimeout

public int getReportDownloadTimeout()

Description copied from interface: AdHocReportDownloadHelperInterface

Returns the reportDownloadTimeout in milliseconds

Specified by:

getReportDownloadTimeout in interface AdHocReportDownloadHelperInterface

setReportDownloadTimeout

public void setReportDownloadTimeout(int reportDownloadTimeout)

Description copied from interface: AdHocReportDownloadHelperInterface

Sets the reportDownloadTimeout (milliseconds).

Specified by:

setReportDownloadTimeout in interface AdHocReportDownloadHelperInterface