REST Resource: customers.customColumns

Ресурс: CustomColumn

Пользовательский столбец. См. специальный столбец searchAds360.search Ads 360 по адресу https://support.google.com/sa360/answer/9633916.

JSON-представление 
{
  "resourceName": string,
  "id": string,
  "name": string,
  "description": string,
  "valueType": enum (CustomColumnValueType),
  "referencesAttributes": boolean,
  "referencesMetrics": boolean,
  "queryable": boolean,
  "referencedSystemColumns": [
    string
  ],
  "renderType": enum (CustomColumnRenderType)
}
Поля
resource Name

string

Имя ресурса настраиваемого столбца. Имена ресурсов настраиваемых столбцов имеют вид:

customers/{customerId}/customColumns/{custom_column_id}

id

string ( int64 format)

Идентификатор специального столбца.

name

string

Определяемое пользователем имя настраиваемого столбца.

description

string

Пользовательское описание специального столбца.

value Type

enum ( CustomColumnValueType )

Тип значения результата специального столбца.

references Attributes

boolean

Значение true, если пользовательский столбец ссылается на один или несколько атрибутов.

references Metrics

boolean

Истинно, если специальный столбец ссылается на один или несколько показателей.

queryable

boolean

Значение true, если специальный столбец доступен для использования в запросах SearchAds360Service.Search и SearchAds360Service.SearchStream.

referenced System Columns[]

string

Список связанных системных столбцов этого настраиваемого столбца. Например, специальный столбец "Сумма показов и кликов" ссылается на системные столбцы {"metrics.clicks", "metrics.impressions"}.

render Type

enum ( CustomColumnRenderType )

Как следует интерпретировать значение результата специального столбца.

CustomColumnValueType

Перечисление, содержащее возможные типы значений настраиваемых столбцов.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Неизвестный.
STRING Значение пользовательского столбца представляет собой строку.
INT64 Значение пользовательского столбца — это число int64.
DOUBLE Значение специального столбца представляет собой двойное число.
BOOLEAN Значение пользовательского столбца является логическим.
DATE Значением специального столбца является дата в формате ГГГГММДД.

CustomColumnRenderType

Перечисление, содержащее различные способы интерпретации настраиваемого столбца.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Неизвестный.
NUMBER Пользовательский столбец представляет собой необработанное числовое значение. См. поле valueType, чтобы определить, является ли оно целым или двойным.
PERCENT Пользовательский столбец необходимо умножить на 100, чтобы получить процентное значение.
MONEY Значение пользовательского столбца представляет собой денежную величину и выражается в микронах.
STRING Значение пользовательского столбца представляет собой строку.
BOOLEAN Значение пользовательского столбца является логическим.
DATE Значение пользовательского столбца — это дата, представленная целым числом в формате ГГГГММДД.

Методы

get

 Возвращает запрошенный специальный столбец с полной информацией.

list

 Возвращает все пользовательские столбцы, связанные с клиентом, в подробностях.