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

Class AdHocReportDownloadHelper

java.lang.Object

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

public class AdHocReportDownloadHelper
extends Object

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.

Author:

Kevin Winter

Constructor Summary

Constructors

Constructor and Description
AdHocReportDownloadHelper(AdWordsSession session, String version) Constructor that stores the session for authentication and uses the provided version to determine the report endpoint.

Method Summary

Methods

Modifier and Type	Method and Description
protected RawReportDownloadResponse	downloadReport(com.google.api.ads.adwords.lib.utils.ReportBodyProvider reportBodyProvider) Downloads a report and returns a ReportDownloadResponse with the results.
RawReportDownloadResponse	downloadReport(String reportDefinitionXml) Downloads a report and returns a ReportDownloadResponse with the results.
RawReportDownloadResponse	downloadReport(String reportQuery, String format) Downloads a report query and returns a ReportDownloadResponse with the results.
int	getReportDownloadTimeout() Returns the reportDownloadTimeout in milliseconds
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

Constructor Detail

AdHocReportDownloadHelper

public AdHocReportDownloadHelper(AdWordsSession session,
                         String version)

Constructor that stores the session for authentication and uses the provided version to determine the report endpoint.

Method Detail

downloadReport

public RawReportDownloadResponse downloadReport(String reportDefinitionXml)
                                         throws ReportException

Downloads a report and returns a ReportDownloadResponse with the results.

Parameters:

reportDefinitionXml - to download a report for.

Returns:

ReportDownloadResponse When HTTP request completes. On success, the outputStream will be flushed and closed.

Throws:

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

downloadReport

public RawReportDownloadResponse downloadReport(String reportQuery,
                                       String format)
                                         throws ReportException

Downloads a report query and returns a ReportDownloadResponse with the results.

Parameters:

reportQuery - to download a report for.

Returns:

ReportDownloadResponse When HTTP request completes. On success, the outputStream will be flushed and closed.

Throws:

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

downloadReport

protected RawReportDownloadResponse downloadReport(com.google.api.ads.adwords.lib.utils.ReportBodyProvider reportBodyProvider)
                                            throws ReportException

Downloads a report and returns a ReportDownloadResponse with the results.

Parameters:

reportBodyProvider - with HttpContent to send to the server.

Returns:

encapsulated http response body and status code.

Throws:

ReportException - If there is any exceptions making HTTP request to the server.

getReportDownloadTimeout

public int getReportDownloadTimeout()

Returns the reportDownloadTimeout in milliseconds

setReportDownloadTimeout

public void setReportDownloadTimeout(int reportDownloadTimeout)

Sets the reportDownloadTimeout (milliseconds).