REST Resource: customers.customColumns

資源:CustomColumn

自訂欄。請參閱 https://support.google.com/sa360/answer/9633916,瞭解 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

如果自訂欄參照一或多個屬性,則為 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

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