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

Interface AdHocReportDownloadHelperInterface

All Known Implementing Classes:

AdHocReportDownloadHelper

public interface AdHocReportDownloadHelperInterface

Helper object that handles AdWords API report requests.

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	REPORT_CHARSET The default Charset for report request and response contents.

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).

Field Detail

REPORT_CHARSET

static final Charset REPORT_CHARSET

The default Charset for report request and response contents.

Method Detail

downloadReport

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

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

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.

NullPointerException - if any argument is null.

downloadReport

RawReportDownloadResponse downloadReport(ReportRequest reportRequest)
                                  throws ReportException

Downloads a report and returns a ReportDownloadResponse with the results.

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

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

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

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.

NullPointerException - if any argument is null.

getReportDownloadTimeout

int getReportDownloadTimeout()

Returns the reportDownloadTimeout in milliseconds

setReportDownloadTimeout

void setReportDownloadTimeout(int reportDownloadTimeout)

Sets the reportDownloadTimeout (milliseconds).