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

More...

Inheritance diagram for Google.Api.Ads.AdWords.v201809.ReportDefinitionService:
Google.Api.Ads.AdWords.v201809.IReportDefinitionService Google.Api.Ads.AdWords.v201809.ReportDefinitionServiceInterface

Public Member Functions

 ReportDefinitionService ()
 Creates a new instance of the ReportDefinitionService class. More...
 
 ReportDefinitionService (string endpointConfigurationName)
 Creates a new instance of the ReportDefinitionService class. More...
 
 ReportDefinitionService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the ReportDefinitionService class. More...
 
 ReportDefinitionService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the ReportDefinitionService class. More...
 
 ReportDefinitionService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the ReportDefinitionService class. More...
 
virtual
Google.Api.Ads.AdWords.v201809.ReportDefinitionField[] 
getReportFields (Google.Api.Ads.AdWords.v201809.ReportDefinitionReportType reportType)
 Returns the available report fields for a given report type. When using this method the More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.ReportDefinitionField[]> 
getReportFieldsAsync (Google.Api.Ads.AdWords.v201809.ReportDefinitionReportType reportType)
 

Detailed Description

Note: As of v201109 this service is read-only. New report definitions are no longer allowed.

A report definition describes the report type, date range, and fields to include in the report. Additionally, you can specify predicates to filter which rows are returned in a generated report. Please note that sorting and paging are not supported for report downloads.

To find out which report fields are available based on report type, see the Report Types appendix or call #getReportFields.

For more information about retrieving reports, see Reporting Basics.

Constructor & Destructor Documentation

Google.Api.Ads.AdWords.v201809.ReportDefinitionService.ReportDefinitionService ( )
inline

Creates a new instance of the ReportDefinitionService class.

Google.Api.Ads.AdWords.v201809.ReportDefinitionService.ReportDefinitionService ( string  endpointConfigurationName)
inline

Creates a new instance of the ReportDefinitionService class.

Google.Api.Ads.AdWords.v201809.ReportDefinitionService.ReportDefinitionService ( string  endpointConfigurationName,
string  remoteAddress 
)
inline

Creates a new instance of the ReportDefinitionService class.

Google.Api.Ads.AdWords.v201809.ReportDefinitionService.ReportDefinitionService ( string  endpointConfigurationName,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the ReportDefinitionService class.

Google.Api.Ads.AdWords.v201809.ReportDefinitionService.ReportDefinitionService ( System.ServiceModel.Channels.Binding  binding,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the ReportDefinitionService class.

Member Function Documentation

virtual Google.Api.Ads.AdWords.v201809.ReportDefinitionField [] Google.Api.Ads.AdWords.v201809.ReportDefinitionService.getReportFields ( Google.Api.Ads.AdWords.v201809.ReportDefinitionReportType  reportType)
inlinevirtual

Returns the available report fields for a given report type. When using this method the

clientCustomerId header field is optional. Callers are discouraged from setting the clientCustomerId header field in calls to this method as its presence will trigger an authorization error if the caller does not have access to the customer with the included ID.

Parameters
reportTypeThe type of report.
Returns
The list of available report fields. Each ReportDefinitionField encapsulates the field name, the field data type, and the enum values (if the field's type is enum).
Exceptions
AdWordsApiExceptionif a problem occurred while fetching the ReportDefinitionField information.

Implements Google.Api.Ads.AdWords.v201809.IReportDefinitionService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.ReportDefinitionField[]> Google.Api.Ads.AdWords.v201809.ReportDefinitionService.getReportFieldsAsync ( Google.Api.Ads.AdWords.v201809.ReportDefinitionReportType  reportType)
inlinevirtual

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