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

Defines report utility functions for the client library. More...

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

Public Member Functions

 ReportUtilities (AdWordsUser user, string query, string format)
 Initializes a new instance of the ReportUtilities class. More...
 
 ReportUtilities (AdWordsUser user, IReportDefinition reportDefinition)
 Initializes a new instance of the ReportUtilities class. More...
 
 ReportUtilities (AdWordsUser user, string reportVersion, string query, string format)
 Initializes a new instance of the ReportUtilities class. More...
 
 ReportUtilities (AdWordsUser user, string reportVersion, IReportDefinition reportDefinition)
 Initializes a new instance of the ReportUtilities class. More...
 
override ReportResponse GetResponse ()
 Gets the report download response. More...
 
override void GetResponseAsync ()
 Gets the report download response asynchronously. 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...
 

Protected Member Functions

override ReportResponse GetReport ()
 Gets the report response. More...
 
- Protected Member Functions inherited from Google.Api.Ads.Common.Util.Reports.AdsReportUtilities
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...
 

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

Defines report utility functions for the client library.

Constructor & Destructor Documentation

Google.Api.Ads.AdWords.Util.Reports.ReportUtilities.ReportUtilities ( AdWordsUser  user,
string  query,
string  format 
)
inline

Initializes a new instance of the ReportUtilities class.

Parameters
userAdWords user to be used along with this utilities object.
queryThe AWQL for downloading reports.
formatThe report download format.
Google.Api.Ads.AdWords.Util.Reports.ReportUtilities.ReportUtilities ( AdWordsUser  user,
IReportDefinition  reportDefinition 
)
inline

Initializes a new instance of the ReportUtilities class.

Parameters
userAdWords user to be used along with this utilities object.
reportDefinitionThe report definition.
Google.Api.Ads.AdWords.Util.Reports.ReportUtilities.ReportUtilities ( AdWordsUser  user,
string  reportVersion,
string  query,
string  format 
)
inline

Initializes a new instance of the ReportUtilities class.

Parameters
userAdWords user to be used along with this utilities object.
queryThe AWQL for downloading reports.
formatThe report download format.
reportVersionThe report version.
Google.Api.Ads.AdWords.Util.Reports.ReportUtilities.ReportUtilities ( AdWordsUser  user,
string  reportVersion,
IReportDefinition  reportDefinition 
)
inline

Initializes a new instance of the ReportUtilities class.

Parameters
userAdWords user to be used along with this utilities object.
reportDefinitionThe report definition.
reportVersionThe report version.

Member Function Documentation

override ReportResponse Google.Api.Ads.AdWords.Util.Reports.ReportUtilities.GetReport ( )
inlineprotectedvirtual

Gets the report response.

Returns
The report response.

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

override ReportResponse Google.Api.Ads.AdWords.Util.Reports.ReportUtilities.GetResponse ( )
inlinevirtual

Gets the report download response.

Returns
The report response.

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

override void Google.Api.Ads.AdWords.Util.Reports.ReportUtilities.GetResponseAsync ( )
inlinevirtual

Gets the report download response asynchronously.

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


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