Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: googleAdsFields

Resource: GoogleAdsField

A field or resource (artifact) used by GoogleAdsService.

JSON representation
{
  "resourceName": string,
  "category": enum (GoogleAdsFieldCategory),
  "selectableWith": [
    string
  ],
  "attributeResources": [
    string
  ],
  "metrics": [
    string
  ],
  "segments": [
    string
  ],
  "enumValues": [
    string
  ],
  "dataType": enum (GoogleAdsFieldDataType),
  "name": string,
  "selectable": boolean,
  "filterable": boolean,
  "sortable": boolean,
  "typeUrl": string,
  "isRepeated": boolean
}
Fields
resourceName

string

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

googleAdsFields/{name}

category

enum (GoogleAdsFieldCategory)

Output only. The category of the artifact.

selectableWith[]

string

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

attributeResources[]

string

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[]

string

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[]

string

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.

enumValues[]

string

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.

dataType

enum (GoogleAdsFieldDataType)

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

name

string

Output only. The name of the artifact.

selectable

boolean

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

filterable

boolean

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

sortable

boolean

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

typeUrl

string

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

isRepeated

boolean

Output only. Whether the field artifact is repeated.

GoogleAdsFieldCategory

The category of the artifact.

Enums
UNSPECIFIED Unspecified
UNKNOWN Unknown
RESOURCE The described artifact is a resource.
ATTRIBUTE The described artifact is a field and is an attribute of a resource. Including a resource attribute field in a query may segment the query if the resource to which it is attributed segments the resource found in the FROM clause.
SEGMENT The described artifact is a field and always segments search queries.
METRIC The described artifact is a field and is a metric. It never segments search queries.

GoogleAdsFieldDataType

These are the various types a GoogleAdsService artifact may take on.

Enums
UNSPECIFIED Unspecified
UNKNOWN Unknown
BOOLEAN

Maps to google.protobuf.BoolValue

Applicable operators: =, !=

DATE

Maps to google.protobuf.StringValue. It can be compared using the set of operators specific to dates however.

Applicable operators: =, <, >, <=, >=, BETWEEN, DURING, and IN

DOUBLE

Maps to google.protobuf.DoubleValue

Applicable operators: =, !=, <, >, IN, NOT IN

ENUM

Maps to an enum. It's specific definition can be found at typeUrl.

Applicable operators: =, !=, IN, NOT IN

FLOAT

Maps to google.protobuf.FloatValue

Applicable operators: =, !=, <, >, IN, NOT IN

INT32

Maps to google.protobuf.Int32Value

Applicable operators: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN

INT64

Maps to google.protobuf.Int64Value

Applicable operators: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN

MESSAGE

Maps to a protocol buffer message type. The data type's details can be found in typeUrl.

No operators work with MESSAGE fields.

RESOURCE_NAME

Maps to google.protobuf.StringValue. Represents the resource name (unique id) of a resource or one of its foreign keys.

No operators work with RESOURCE_NAME fields.

STRING

Maps to google.protobuf.StringValue.

Applicable operators: =, !=, LIKE, NOT LIKE, IN, NOT IN

UINT64

Maps to google.protobuf.UInt64Value

Applicable operators: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN

Methods

get

Returns just the requested field.
Returns all fields that match the search query.