REST Resource: customers.customColumns

資源:CustomColumn

自訂欄。請參閱 https://support.google.com/sa360/answer/9633916 中的「searchAds360.search Ads 360 自訂欄」

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

如果自訂欄參照一或多個屬性,則為「是」。

referencesMetrics

boolean

如果自訂欄參照一或多個指標,則為「是」。

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

傳回與客戶相關聯的所有自訂欄,並提供完整詳細資料。