type ReportDefinitionField (v201802)

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.


Namespace
https://adwords.google.com/api/adwords/cm/v201802

Field

fieldName

xsd:string

The field name.

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

displayFieldName

xsd:string

The name that is displayed in the downloaded report.

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

xmlAttributeName

xsd:string

The XML attribute in the downloaded report.

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

fieldType

xsd:string

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.

fieldBehavior

xsd:string

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.

enumValues

xsd:string[]

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.

canSelect

xsd:boolean

Indicates if the user can select this field.

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

canFilter

xsd:boolean

Indicates if the user can filter on this field.

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

isEnumType

xsd:boolean

Indicates that the field is an enum type.

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

isBeta

xsd:boolean

Indicates that the field is only available with beta access.

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

isZeroRowCompatible

xsd:boolean

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.

enumValuePairs

EnumValuePair[]

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.

exclusiveFields

xsd:string[]

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.

Send feedback about...

AdWords API
AdWords API
Need help? Visit our support page.