REST Resource: customers.customColumns

Resource: CustomColumn

A custom column. See searchAds360.search Ads 360 custom column at https://support.google.com/sa360/answer/9633916

JSON representation
{
  "resourceName": string,
  "id": string,
  "name": string,
  "description": string,
  "valueType": enum (CustomColumnValueType),
  "referencesAttributes": boolean,
  "referencesMetrics": boolean,
  "queryable": boolean,
  "referencedSystemColumns": [
    string
  ]
}
Fields
resourceName

string

The resource name of the custom column. Custom column resource names have the form:

customers/{customerId}/customColumns/{custom_column_id}

id

string (int64 format)

ID of the custom column.

name

string

User-defined name of the custom column.

description

string

User-defined description of the custom column.

valueType

enum (CustomColumnValueType)

The type of the result value of the custom column.

referencesAttributes

boolean

True when the custom column is referring to one or more attributes.

referencesMetrics

boolean

True when the custom column is referring to one or more metrics.

queryable

boolean

True when the custom column is available to be used in the query of SearchAds360Service.Search and SearchAds360Service.SearchStream.

referencedSystemColumns[]

string

The list of the referenced system columns of this custom column. For example, A custom column "sum of impressions and clicks" has referenced system columns of {"metrics.clicks", "metrics.impressions"}.

CustomColumnValueType

Enum containing possible custom column value types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Unknown.
STRING The custom column value is a string.
INT64 The custom column value is an int64 number.
DOUBLE The custom column value is a double number.
BOOLEAN The custom column value is a boolean.

Methods

get

Returns the requested custom column in full detail.

list

Returns all the custom columns associated with the customer in full detail.