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

Represents the fields that can be used to create a ReportDefinition. This class allows the user to query the list of fields applicable to a given report type. Consumers of reports will be able use the retrieved fields through the ReportDefinitionService::getReportFields api and run the corresponding reports. More...

Inheritance diagram for Google.Api.Ads.AdWords.v201809.ReportDefinitionField:
Google.Api.Ads.AdWords.Util.Reports.IReportDefinitionField

Properties

string fieldName [get, set]
 The field name. This field is read only and will be ignored when sent to the API. More...
 
string displayFieldName [get, set]
 The name that is displayed in the downloaded report. This field is read only and will be ignored when sent to the API. More...
 
string xmlAttributeName [get, set]
 The XML attribute in the downloaded report. This field is read only and will be ignored when sent to the API. More...
 
string fieldType [get, set]
 The type of field. Useful for knowing what operation type to pass in for a given field in a predicate. This field is read only and will be ignored when sent to the API. More...
 
string fieldBehavior [get, set]
 The behavior of this field. Possible values are: "ATTRIBUTE", "METRIC" and "SEGMENT". This field is read only and will be ignored when sent to the API. More...
 
string[] enumValues [get, set]
 List of enum values for the corresponding field if and only if the field is an enum type. This field is read only and will be ignored when sent to the API. More...
 
bool canSelect [get, set]
 Indicates if the user can select this field. This field is read only and will be ignored when sent to the API. More...
 
bool canSelectSpecified [get, set]
 
bool canFilter [get, set]
 Indicates if the user can filter on this field. This field is read only and will be ignored when sent to the API. More...
 
bool canFilterSpecified [get, set]
 
bool isEnumType [get, set]
 Indicates that the field is an enum type. This field is read only and will be ignored when sent to the API. More...
 
bool isEnumTypeSpecified [get, set]
 
bool isBeta [get, set]
 Indicates that the field is only available with beta access. This field is read only and will be ignored when sent to the API. More...
 
bool isBetaSpecified [get, set]
 
bool isZeroRowCompatible [get, set]
 Indicates if the field can be selected in queries that explicitly request zero rows. This field is read only and will be ignored when sent to the API. More...
 
bool isZeroRowCompatibleSpecified [get, set]
 
EnumValuePair[] enumValuePairs [get, set]
 List of enum values in api to their corresponding display values in the downloaded reports. This field is read only and will be ignored when sent to the API. More...
 
string[] exclusiveFields [get, set]
 List of mutually exclusive fields of this field. This field cannot be selected or used in a predicate together with any of the mutually exclusive fields in this list. This field is read only and will be ignored when sent to the API. More...
 
- Properties inherited from Google.Api.Ads.AdWords.Util.Reports.IReportDefinitionField
string fieldName [get, set]
 The field name. This field is read only and will be ignored when sent to the API. More...
 
string xmlAttributeName [get, set]
 The XML attribute in the downloaded report. This field is read only and will be ignored when sent to the API. More...
 
string fieldType [get, set]
 The type of field. Useful for knowing what operation type to pass in for a given field in a predicate. This field is read only and will be ignored when sent to the API. More...
 
string[] enumValues [get, set]
 List of enum values for the corresponding field if and only if the field is an enum type. This field is read only and will be ignored when sent to the API. More...
 

Detailed Description

Represents the fields that can be used to create a ReportDefinition. This class allows the user to query the list of fields applicable to a given report type. Consumers of reports will be able use the retrieved fields through the ReportDefinitionService::getReportFields api and run the corresponding reports.

Property Documentation

bool Google.Api.Ads.AdWords.v201809.ReportDefinitionField.canFilter
getset

Indicates if the user can filter on this field. This field is read only and will be ignored when sent to the API.

bool Google.Api.Ads.AdWords.v201809.ReportDefinitionField.canFilterSpecified
getset

true, if a value is specified for canFilter, false otherwise.

bool Google.Api.Ads.AdWords.v201809.ReportDefinitionField.canSelect
getset

Indicates if the user can select this field. This field is read only and will be ignored when sent to the API.

bool Google.Api.Ads.AdWords.v201809.ReportDefinitionField.canSelectSpecified
getset

true, if a value is specified for canSelect, false otherwise.

string Google.Api.Ads.AdWords.v201809.ReportDefinitionField.displayFieldName
getset

The name that is displayed in the downloaded report. This field is read only and will be ignored when sent to the API.

EnumValuePair [] Google.Api.Ads.AdWords.v201809.ReportDefinitionField.enumValuePairs
getset

List of enum values in api to their corresponding display values in the downloaded reports. This field is read only and will be ignored when sent to the API.

string [] Google.Api.Ads.AdWords.v201809.ReportDefinitionField.enumValues
getset

List of enum values for the corresponding field if and only if the field is an enum type. This field is read only and will be ignored when sent to the API.

Referenced by Google.Api.Ads.AdWords.Examples.CSharp.v201809.GetReportFields.Run().

string [] Google.Api.Ads.AdWords.v201809.ReportDefinitionField.exclusiveFields
getset

List of mutually exclusive fields of this field. This field cannot be selected or used in a predicate together with any of the mutually exclusive fields in this list. This field is read only and will be ignored when sent to the API.

string Google.Api.Ads.AdWords.v201809.ReportDefinitionField.fieldBehavior
getset

The behavior of this field. Possible values are: "ATTRIBUTE", "METRIC" and "SEGMENT". This field is read only and will be ignored when sent to the API.

string Google.Api.Ads.AdWords.v201809.ReportDefinitionField.fieldName
getset

The field name. This field is read only and will be ignored when sent to the API.

string Google.Api.Ads.AdWords.v201809.ReportDefinitionField.fieldType
getset

The type of field. Useful for knowing what operation type to pass in for a given field in a predicate. This field is read only and will be ignored when sent to the API.

bool Google.Api.Ads.AdWords.v201809.ReportDefinitionField.isBeta
getset

Indicates that the field is only available with beta access. This field is read only and will be ignored when sent to the API.

bool Google.Api.Ads.AdWords.v201809.ReportDefinitionField.isBetaSpecified
getset

true, if a value is specified for isBeta, false otherwise.

bool Google.Api.Ads.AdWords.v201809.ReportDefinitionField.isEnumType
getset

Indicates that the field is an enum type. This field is read only and will be ignored when sent to the API.

bool Google.Api.Ads.AdWords.v201809.ReportDefinitionField.isEnumTypeSpecified
getset

true, if a value is specified for isEnumType, false otherwise.

bool Google.Api.Ads.AdWords.v201809.ReportDefinitionField.isZeroRowCompatible
getset

Indicates if the field can be selected in queries that explicitly request zero rows. This field is read only and will be ignored when sent to the API.

bool Google.Api.Ads.AdWords.v201809.ReportDefinitionField.isZeroRowCompatibleSpecified
getset

true, if a value is specified for isZeroRowCompatible, false otherwise.

string Google.Api.Ads.AdWords.v201809.ReportDefinitionField.xmlAttributeName
getset

The XML attribute in the downloaded report. This field is read only and will be ignored when sent to the API.


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