REST Resource: customers.customColumns

资源:CustomColumn

自定义列。请参阅 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)

自定义列的 ID。

name

string

用户定义的自定义列名称。

description

string

用户定义的自定义列说明。

valueType

enum (CustomColumnValueType)

自定义列的结果值的类型。

referencesAttributes

boolean

如果自定义列引用了一个或多个属性,则为 true。

referencesMetrics

boolean

如果自定义列引用了一个或多个指标,则为 true。

queryable

boolean

如果自定义列可用于 SearchAds360Service.Search 和 SearchAds360Service.SearchStream 的查询,则为 true。

referencedSystemColumns[]

string

此自定义列的引用系统列的列表。例如,自定义列“展示次数和点击次数之和”的引用系统列为 {"metrics.clicks", "metrics.impressions"}。

renderType

enum (CustomColumnRenderType)

应如何解读自定义列的结果值。

CustomColumnValueType

包含可能的自定义列值类型的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 未知。
STRING 自定义列值是字符串。
INT64 自定义列值是 int64 数字。
DOUBLE 自定义列值是双精度数字。
BOOLEAN 自定义列值是布尔值。
DATE 自定义列值是日期,采用 YYYYMMDD 格式。

CustomColumnRenderType

包含自定义列的不同解读方式的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 未知。
NUMBER 自定义列是原始数值。请参阅 valueType 字段,以确定它是整数还是双精度浮点数。
PERCENT 自定义列应乘以 100 以检索百分比值。
MONEY 自定义列值是货币价值,以微单位表示。
STRING 自定义列值是字符串。
BOOLEAN 自定义列值是布尔值。
DATE 自定义列值是日期,以 YYYYMMDD 格式的整数表示。

方法

get

返回所请求的自定义列的完整详细信息。

list

返回与客户相关联的所有自定义列的完整详细信息。