com.google.api.ads.dfp.axis.utils.v201708

Class ReportDownloader

java.lang.Object

com.google.api.ads.dfp.axis.utils.v201708.ReportDownloader

public class ReportDownloader
extends Object

Retrieves reports using a ReportServiceInterface.

There are two main functions of this class:

• To download a report in Gzip format to a file or any OutputStream
• To get the report and perform a number of tasks on it

ReportUtils also provides the method whenReportReady(ReportCallback) to wait for a scheduled report to finish processing before taking an action on the report through the supplied ReportCallback.

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	REPORT_CHARSET
static int	SLEEP_TIMER The time to sleep before each request to the service.

Constructor Summary

Constructors

Constructor and Description
ReportDownloader(com.google.api.ads.dfp.axis.v201708.ReportServiceInterface reportService, long reportJobId) Constructs a ReportDownloader object for a ReportServiceInterface and a report job id that the the class works on.

Method Summary

Modifier and Type	Method and Description
URL	getDownloadUrl(com.google.api.ads.dfp.axis.v201708.ReportDownloadOptions options) Gets the download URL for a GZip or plain-text format report.
com.google.common.io.CharSource	getReportAsCharSource(com.google.api.ads.dfp.axis.v201708.ReportDownloadOptions options) Returns a CharSource of report contents with ReportDownloadOptions.
boolean	waitForReportReady() Blocks and waits for a report to be ready.
Thread	whenReportReady(ReportCallback callback) Waits for the report to be ready and then calls: ReportCallback.onSuccess() for a successful scheduling ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED ReportCallback.onInterruption() if the wait thread is interrupted ReportCallback.onException(Exception) if there was an exception while waiting for the report to finish

Methods inherited from class java.lang.Object

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

Field Detail

REPORT_CHARSET

public static final Charset REPORT_CHARSET

SLEEP_TIMER

public static final int SLEEP_TIMER

The time to sleep before each request to the service.

See Also:

Constant Field Values

Constructor Detail

ReportDownloader

public ReportDownloader(com.google.api.ads.dfp.axis.v201708.ReportServiceInterface reportService,
                        long reportJobId)

Constructs a ReportDownloader object for a ReportServiceInterface and a report job id that the the class works on.

Parameters:

reportService - the ReportService stub to make calls to

reportJobId - the report job ID

Method Detail

whenReportReady

public Thread whenReportReady(ReportCallback callback)

Waits for the report to be ready and then calls:

• ReportCallback.onSuccess() for a successful scheduling
• ReportCallback.onFailure() for a failed scheduling due to a ReportJobStatus.FAILED
• ReportCallback.onInterruption() if the wait thread is interrupted
• ReportCallback.onException(Exception) if there was an exception while waiting for the report to finish

Parameters:

callback - the ReportCallback to call when the job has finished, successfully or otherwise

Returns:

the thread created that handles waiting for the report. Thread.interrupt() can be called on the returned thread to interrupt it.

Throws:

IllegalArgumentException - if callback == null

waitForReportReady

public boolean waitForReportReady()
                           throws RemoteException,
                                  InterruptedException

Blocks and waits for a report to be ready. When a ReportJobStatus is received that is not ReportJobStatus#Pending or ReportJobStatus#InProgress, the report is considered finished, and the method is returned with a true if the report was successful, or an false if not.

Returns:

true if the report was successful, false otherwise

Throws:

RemoteException - if there was an error performing one of the SOAP calls

InterruptedException - if the thread was interrupted

getDownloadUrl

public URL getDownloadUrl(com.google.api.ads.dfp.axis.v201708.ReportDownloadOptions options)
                   throws RemoteException,
                          MalformedURLException

Gets the download URL for a GZip or plain-text format report. If you requested a compressed report, you may want to save your file with a gz or zip extension.

  URL url = reportDownloader.getDownloadUrl(options);
  Resources.asByteSource(url).copyTo(Files.asByteSink(file));
 

Parameters:

options - the options to download the report with

Returns:

the URL for the report download

Throws:

RemoteException - if there was an error performing any Axis call

MalformedURLException - if there is an error forming the download URL

IllegalStateException - if the report is not ready to be downloaded

getReportAsCharSource

public com.google.common.io.CharSource getReportAsCharSource(com.google.api.ads.dfp.axis.v201708.ReportDownloadOptions options)
                                                      throws IOException

Returns a CharSource of report contents with ReportDownloadOptions. The ExportFormat must be string-based, such as ExportFormat.CSV_DUMP.

Parameters:

options - the options to download the report with

Returns:

a new CharSource of report results

Throws:

IOException - if there was an error performing any I/O action, including any SOAP calls

IllegalStateException - if the report is not ready to be downloaded

IllegalArgumentException - if the ExportFormat is not a string-based format