Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdManager.Util.v202105.ReportUtilities Class Reference

Utility class for DFP API report downloads. More...

Inheritance diagram for Google.Api.Ads.AdManager.Util.v202105.ReportUtilities:
Google.Api.Ads.Common.Util.Reports.AdsReportUtilities

Public Member Functions

 ReportUtilities (ReportService reportService, long reportJobId)
 Initializes a new instance of the ReportUtilities class. More...
 
- Public Member Functions inherited from Google.Api.Ads.Common.Util.Reports.AdsReportUtilities
delegate void OnReadyCallback (ReportResponse response)
 Delegate to be triggered when the report is ready to download. More...
 
delegate void OnFailedCallback (AdsReportsException exception)
 Delegate to be triggered when the report download failed. More...
 
 AdsReportUtilities (AdsUser user)
 Initializes a new instance of the AdsReportUtilities class. More...
 
virtual void GetResponseAsync ()
 Gets the report download response asynchronously. More...
 
virtual ReportResponse GetResponse ()
 Gets the report download response. More...
 

Public Attributes

ReportDownloadOptions reportDownloadOptions
 The options to use when downloading the completed report. More...
 

Protected Member Functions

override bool ShouldWaitMore ()
 Returns a flag indicating whether the caller should wait more time for the report download to complete. More...
 
override ReportResponse GetReport ()
 Gets the report response. More...
 
- Protected Member Functions inherited from Google.Api.Ads.Common.Util.Reports.AdsReportUtilities
virtual void Schedule ()
 Schedules a report for download. More...
 

Additional Inherited Members

- Properties inherited from Google.Api.Ads.Common.Util.Reports.AdsReportUtilities
AdsUser User [get]
 Returns the user associated with this object. More...
 
OnReadyCallback OnReady [get, set]
 Gets or sets the callback that will be triggered when the report is ready to be downloaded. More...
 
OnFailedCallback OnFailed [get, set]
 Gets or sets the callback that will be triggered when the report download fails. More...
 

Detailed Description

Utility class for DFP API report downloads.

Constructor & Destructor Documentation

Google.Api.Ads.AdManager.Util.v202105.ReportUtilities.ReportUtilities ( ReportService  reportService,
long  reportJobId 
)
inline

Initializes a new instance of the ReportUtilities class.

Parameters
reportServiceReportService to be used
reportJobIdThe ID of the report job

Member Function Documentation

override ReportResponse Google.Api.Ads.AdManager.Util.v202105.ReportUtilities.GetReport ( )
inlineprotectedvirtual

Gets the report response.

Returns
The report response.

Implements Google.Api.Ads.Common.Util.Reports.AdsReportUtilities.

override bool Google.Api.Ads.AdManager.Util.v202105.ReportUtilities.ShouldWaitMore ( )
inlineprotectedvirtual

Returns a flag indicating whether the caller should wait more time for the report download to complete.

Returns
True, if the caller should wait more, false otherwise.

Reimplemented from Google.Api.Ads.Common.Util.Reports.AdsReportUtilities.

Member Data Documentation

ReportDownloadOptions Google.Api.Ads.AdManager.Util.v202105.ReportUtilities.reportDownloadOptions

The options to use when downloading the completed report.


The documentation for this class was generated from the following file: