Ads API .NET library
|
Utility class for DFP API report downloads. More...
Public Member Functions | |
ReportUtilities (ReportService reportService, long reportJobId) | |
Initializes a new instance of the ReportUtilities class. More... | |
![]() | |
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... | |
![]() | |
virtual void | Schedule () |
Schedules a report for download. More... | |
Additional Inherited Members | |
![]() | |
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... | |
Utility class for DFP API report downloads.
|
inline |
Initializes a new instance of the ReportUtilities class.
reportService | ReportService to be used |
reportJobId | The ID of the report job |
|
inlineprotectedvirtual |
Gets the report response.
Implements Google.Api.Ads.Common.Util.Reports.AdsReportUtilities.
|
inlineprotectedvirtual |
Returns a flag indicating whether the caller should wait more time for the report download to complete.
Reimplemented from Google.Api.Ads.Common.Util.Reports.AdsReportUtilities.
ReportDownloadOptions Google.Api.Ads.AdManager.Util.v202405.ReportUtilities.reportDownloadOptions |
The options to use when downloading the completed report.