REST Resource: customers.customColumns

Ресурс: Пользовательская колонка

Пользовательская колонка. См. раздел «Пользовательская колонка в 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)
}
Поля
resourceName

string

Имя ресурса пользовательского столбца. Имена ресурсов пользовательских столбцов имеют следующий формат:

customers/{customerId}/customColumns/{custom_column_id}

id

string ( int64 format)

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

name

string

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

description

string

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

valueType

enum ( CustomColumnValueType )

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

referencesAttributes

boolean

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

referencesMetrics

boolean

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

queryable

boolean

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

referencedSystemColumns[]

string

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

renderType

enum ( CustomColumnRenderType )

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

CustomColumnValueType

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

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

CustomColumnRenderType

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

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

Методы

get

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

list

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