Ads API .NET library
|
Provides methods for executing a ReportJob and retrieving performance and statistics about ad campaigns, networks, inventory and sales. More...
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.v202208.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.v202208.ExportFormat exportFormat) |
virtual string | getReportDownloadUrlWithOptions (long reportJobId, Google.Api.Ads.AdManager.v202208.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.v202208.ReportDownloadOptions reportDownloadOptions) |
virtual Google.Api.Ads.AdManager.v202208.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.v202208.ReportJobStatus > | getReportJobStatusAsync (long reportJobId) |
virtual Google.Api.Ads.AdManager.v202208.SavedQueryPage | getSavedQueriesByStatement (Google.Api.Ads.AdManager.v202208.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.v202208.SavedQueryPage > | getSavedQueriesByStatementAsync (Google.Api.Ads.AdManager.v202208.Statement filterStatement) |
virtual Google.Api.Ads.AdManager.v202208.ReportJob | runReportJob (Google.Api.Ads.AdManager.v202208.ReportJob reportJob) |
Initiates the execution of a ReportQuery on the server. More... | |
virtual System.Threading.Tasks.Task < Google.Api.Ads.AdManager.v202208.ReportJob > | runReportJobAsync (Google.Api.Ads.AdManager.v202208.ReportJob reportJob) |
Provides methods for executing a ReportJob and retrieving performance and statistics about ad campaigns, networks, inventory and sales.
Follow the steps outlined below:
ReportJob
object by invoking ReportService::runReportJob.
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.
|
inline |
Creates a new instance of the ReportService class.
|
inline |
Creates a new instance of the ReportService class.
|
inline |
Creates a new instance of the ReportService class.
|
inline |
Creates a new instance of the ReportService class.
|
inline |
Creates a new instance of the ReportService class.
|
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.
reportJobId | the ID of the ReportJob |
exportFormat | the ExportFormat for the report file |
Implements Google.Api.Ads.AdManager.v202208.ReportServiceInterface.
|
inlinevirtual |
|
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.
reportJobId | the ID of the ReportJob |
reportDownloadOptions | the ReportDownloadOptions for the request |
Implements Google.Api.Ads.AdManager.v202208.ReportServiceInterface.
|
inlinevirtual |
|
inlinevirtual |
Returns the ReportJobStatus of the report job with the specified ID.
Implements Google.Api.Ads.AdManager.v202208.ReportServiceInterface.
|
inlinevirtual |
|
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 |
filterStatement | a Publisher Query Language statement used to filter which saved queries should be returned. |
Implements Google.Api.Ads.AdManager.v202208.ReportServiceInterface.
|
inlinevirtual |
|
inlinevirtual |
Initiates the execution of a ReportQuery on the server.
The following fields are required:
reportJob | the report job to run |
Implements Google.Api.Ads.AdManager.v202208.ReportServiceInterface.
|
inlinevirtual |