Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Protected Member Functions | Properties | List of all members
Google.Api.Ads.Common.Util.Reports.AdsReportUtilities Class Referenceabstract

The base class for all Ads API report download utilities. More...

Inheritance diagram for Google.Api.Ads.Common.Util.Reports.AdsReportUtilities:
Google.Api.Ads.AdManager.Util.v202305.ReportUtilities Google.Api.Ads.AdManager.Util.v202308.ReportUtilities Google.Api.Ads.AdManager.Util.v202311.ReportUtilities Google.Api.Ads.AdManager.Util.v202402.ReportUtilities

Public Member Functions

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

Protected Member Functions

virtual bool ShouldWaitMore ()
 Returns a flag indicating whether the caller should wait more time for the report download to complete. More...
 
virtual void Schedule ()
 Schedules a report for download. More...
 
abstract ReportResponse GetReport ()
 Gets the report response. More...
 

Properties

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

The base class for all Ads API report download utilities.

Constructor & Destructor Documentation

Google.Api.Ads.Common.Util.Reports.AdsReportUtilities.AdsReportUtilities ( AdsUser  user)
inline

Initializes a new instance of the AdsReportUtilities class.

Parameters
userAdWords user to be used along with this utilities object.

Member Function Documentation

abstract ReportResponse Google.Api.Ads.Common.Util.Reports.AdsReportUtilities.GetReport ( )
protectedpure virtual

Gets the report response.

Returns
The report response.

Implemented in Google.Api.Ads.AdManager.Util.v202305.ReportUtilities, Google.Api.Ads.AdManager.Util.v202308.ReportUtilities, Google.Api.Ads.AdManager.Util.v202311.ReportUtilities, and Google.Api.Ads.AdManager.Util.v202402.ReportUtilities.

virtual ReportResponse Google.Api.Ads.Common.Util.Reports.AdsReportUtilities.GetResponse ( )
inlinevirtual

Gets the report download response.

Returns
The report response.
virtual void Google.Api.Ads.Common.Util.Reports.AdsReportUtilities.GetResponseAsync ( )
inlinevirtual

Gets the report download response asynchronously.

delegate void Google.Api.Ads.Common.Util.Reports.AdsReportUtilities.OnFailedCallback ( AdsReportsException  exception)

Delegate to be triggered when the report download failed.

Parameters
exceptionThe report download exception.
delegate void Google.Api.Ads.Common.Util.Reports.AdsReportUtilities.OnReadyCallback ( ReportResponse  response)

Delegate to be triggered when the report is ready to download.

Parameters
responseThe report response.
virtual void Google.Api.Ads.Common.Util.Reports.AdsReportUtilities.Schedule ( )
inlineprotectedvirtual

Schedules a report for download.

virtual bool Google.Api.Ads.Common.Util.Reports.AdsReportUtilities.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 in Google.Api.Ads.AdManager.Util.v202305.ReportUtilities, Google.Api.Ads.AdManager.Util.v202308.ReportUtilities, Google.Api.Ads.AdManager.Util.v202311.ReportUtilities, and Google.Api.Ads.AdManager.Util.v202402.ReportUtilities.

Property Documentation

OnFailedCallback Google.Api.Ads.Common.Util.Reports.AdsReportUtilities.OnFailed
getset

Gets or sets the callback that will be triggered when the report download fails.

OnReadyCallback Google.Api.Ads.Common.Util.Reports.AdsReportUtilities.OnReady
getset

Gets or sets the callback that will be triggered when the report is ready to be downloaded.

AdsUser Google.Api.Ads.Common.Util.Reports.AdsReportUtilities.User
get

Returns the user associated with this object.

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