GoogleAdsField

A field or resource (artifact) used by GoogleAdsService.

Fields

resource_name

string

Output only. The resource name of the artifact. Artifact resource names have the form:

googleAdsFields/{name}

name

StringValue

Output only. The name of the artifact.

category

GoogleAdsFieldCategory

Output only. The category of the artifact.

selectable

BoolValue

Output only. Whether the artifact can be used in a SELECT clause in search queries.

filterable

BoolValue

Output only. Whether the artifact can be used in a WHERE clause in search queries.

sortable

BoolValue

Output only. Whether the artifact can be used in a ORDER BY clause in search queries.

selectable_with[]

StringValue

Output only. The names of all resources, segments, and metrics that are selectable with the described artifact.

attribute_resources[]

StringValue

Output only. The names of all resources that are selectable with the described artifact. Fields from these resources do not segment metrics when included in search queries.

This field is only set for artifacts whose category is RESOURCE.

metrics[]

StringValue

Output only. At and beyond version V1 this field lists the names of all metrics that are selectable with the described artifact when it is used in the FROM clause. It is only set for artifacts whose category is RESOURCE.

Before version V1 this field lists the names of all metrics that are selectable with the described artifact. It is only set for artifacts whose category is either RESOURCE or SEGMENT

segments[]

StringValue

Output only. At and beyond version V1 this field lists the names of all artifacts, whether a segment or another resource, that segment metrics when included in search queries and when the described artifact is used in the FROM clause. It is only set for artifacts whose category is RESOURCE.

Before version V1 this field lists the names of all artifacts, whether a segment or another resource, that segment metrics when included in search queries. It is only set for artifacts of category RESOURCE, SEGMENT or METRIC.

enum_values[]

StringValue

Output only. Values the artifact can assume if it is a field of type ENUM.

This field is only set for artifacts of category SEGMENT or ATTRIBUTE.

data_type

GoogleAdsFieldDataType

Output only. This field determines the operators that can be used with the artifact in WHERE clauses.

type_url

StringValue

Output only. The URL of proto describing the artifact's data type.

is_repeated

BoolValue

Output only. Whether the field artifact is repeated.