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

Provides methods for executing a ReportJob and retrieving performance and statistics about ad campaigns, networks, inventory and sales. More...

Inheritance diagram for Google.Api.Ads.AdManager.v202305.ReportService:
Google.Api.Ads.AdManager.v202305.IReportService Google.Api.Ads.AdManager.v202305.ReportServiceInterface

Public Member Functions

 ReportService ()
 Creates a new instance of the ReportService class. More...
 
 ReportService (string endpointConfigurationName)
 Creates a new instance of the ReportService class. More...
 
 ReportService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the ReportService class. More...
 
 ReportService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the ReportService class. More...
 
 ReportService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the ReportService class. More...
 
virtual string getReportDownloadURL (long reportJobId, Google.Api.Ads.AdManager.v202305.ExportFormat exportFormat)
 Returns the URL at which the report file can be downloaded. More...
 
virtual
System.Threading.Tasks.Task
< string > 
getReportDownloadURLAsync (long reportJobId, Google.Api.Ads.AdManager.v202305.ExportFormat exportFormat)
 
virtual string getReportDownloadUrlWithOptions (long reportJobId, Google.Api.Ads.AdManager.v202305.ReportDownloadOptions reportDownloadOptions)
 Returns the URL at which the report file can be downloaded, and allows for customization of the downloaded report. More...
 
virtual
System.Threading.Tasks.Task
< string > 
getReportDownloadUrlWithOptionsAsync (long reportJobId, Google.Api.Ads.AdManager.v202305.ReportDownloadOptions reportDownloadOptions)
 
virtual
Google.Api.Ads.AdManager.v202305.ReportJobStatus 
getReportJobStatus (long reportJobId)
 Returns the ReportJobStatus of the report job with the specified ID. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202305.ReportJobStatus
getReportJobStatusAsync (long reportJobId)
 
virtual
Google.Api.Ads.AdManager.v202305.SavedQueryPage 
getSavedQueriesByStatement (Google.Api.Ads.AdManager.v202305.Statement filterStatement)
 Retrieves a page of the saved queries either created by or shared with the current user. Each SavedQuery in the page, if it is compatible with the current API version, will contain a ReportQuery object which can be optionally modified and used to create a ReportJob. This can then be passed to ReportService::runReportJob. The following fields are supported for filtering: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202305.SavedQueryPage
getSavedQueriesByStatementAsync (Google.Api.Ads.AdManager.v202305.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202305.ReportJob 
runReportJob (Google.Api.Ads.AdManager.v202305.ReportJob reportJob)
 Initiates the execution of a ReportQuery on the server. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202305.ReportJob
runReportJobAsync (Google.Api.Ads.AdManager.v202305.ReportJob reportJob)
 

Detailed Description

Provides methods for executing a ReportJob and retrieving performance and statistics about ad campaigns, networks, inventory and sales.

Follow the steps outlined below:

Test network behavior

The networks created using NetworkService::makeTestNetwork are unable to provide reports that would be comparable to the production environment because reports require traffic history. In the test networks, reports will consistently return no data for all reports.

Constructor & Destructor Documentation

Google.Api.Ads.AdManager.v202305.ReportService.ReportService ( )
inline

Creates a new instance of the ReportService class.

Google.Api.Ads.AdManager.v202305.ReportService.ReportService ( string  endpointConfigurationName)
inline

Creates a new instance of the ReportService class.

Google.Api.Ads.AdManager.v202305.ReportService.ReportService ( string  endpointConfigurationName,
string  remoteAddress 
)
inline

Creates a new instance of the ReportService class.

Google.Api.Ads.AdManager.v202305.ReportService.ReportService ( string  endpointConfigurationName,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the ReportService class.

Google.Api.Ads.AdManager.v202305.ReportService.ReportService ( System.ServiceModel.Channels.Binding  binding,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the ReportService class.

Member Function Documentation

virtual string Google.Api.Ads.AdManager.v202305.ReportService.getReportDownloadURL ( long  reportJobId,
Google.Api.Ads.AdManager.v202305.ExportFormat  exportFormat 
)
inlinevirtual

Returns the URL at which the report file can be downloaded.

The report will be generated as a gzip archive, containing the report file itself.

Implements Google.Api.Ads.AdManager.v202305.ReportServiceInterface.

virtual System.Threading.Tasks.Task<string> Google.Api.Ads.AdManager.v202305.ReportService.getReportDownloadURLAsync ( long  reportJobId,
Google.Api.Ads.AdManager.v202305.ExportFormat  exportFormat 
)
inlinevirtual
virtual string Google.Api.Ads.AdManager.v202305.ReportService.getReportDownloadUrlWithOptions ( long  reportJobId,
Google.Api.Ads.AdManager.v202305.ReportDownloadOptions  reportDownloadOptions 
)
inlinevirtual

Returns the URL at which the report file can be downloaded, and allows for customization of the downloaded report.

By default, the report will be generated as a gzip archive, containing the report file itself. This can be changed by setting ReportDownloadOptions::useGzipCompression to false.

Implements Google.Api.Ads.AdManager.v202305.ReportServiceInterface.

virtual System.Threading.Tasks.Task<string> Google.Api.Ads.AdManager.v202305.ReportService.getReportDownloadUrlWithOptionsAsync ( long  reportJobId,
Google.Api.Ads.AdManager.v202305.ReportDownloadOptions  reportDownloadOptions 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202305.ReportJobStatus Google.Api.Ads.AdManager.v202305.ReportService.getReportJobStatus ( long  reportJobId)
inlinevirtual

Returns the ReportJobStatus of the report job with the specified ID.

Implements Google.Api.Ads.AdManager.v202305.ReportServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202305.ReportJobStatus> Google.Api.Ads.AdManager.v202305.ReportService.getReportJobStatusAsync ( long  reportJobId)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202305.SavedQueryPage Google.Api.Ads.AdManager.v202305.ReportService.getSavedQueriesByStatement ( Google.Api.Ads.AdManager.v202305.Statement  filterStatement)
inlinevirtual

Retrieves a page of the saved queries either created by or shared with the current user. Each SavedQuery in the page, if it is compatible with the current API version, will contain a ReportQuery object which can be optionally modified and used to create a ReportJob. This can then be passed to ReportService::runReportJob. The following fields are supported for filtering:

PQL Property Object Property
id SavedQuery::id
name SavedQuery::name

Implements Google.Api.Ads.AdManager.v202305.ReportServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202305.SavedQueryPage> Google.Api.Ads.AdManager.v202305.ReportService.getSavedQueriesByStatementAsync ( Google.Api.Ads.AdManager.v202305.Statement  filterStatement)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202305.ReportJob Google.Api.Ads.AdManager.v202305.ReportService.runReportJob ( Google.Api.Ads.AdManager.v202305.ReportJob  reportJob)
inlinevirtual

Initiates the execution of a ReportQuery on the server.

The following fields are required:

Implements Google.Api.Ads.AdManager.v202305.ReportServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202305.ReportJob> Google.Api.Ads.AdManager.v202305.ReportService.runReportJobAsync ( Google.Api.Ads.AdManager.v202305.ReportJob  reportJob)
inlinevirtual

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