REST Resource: customers.customColumns

リソース: CustomColumn

カスタム列。https://support.google.com/sa360/answer/9633916 で検索広告 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

カスタム列が 1 つ以上の属性を参照している場合は true。
referencesMetrics

boolean

カスタム列が 1 つ以上の指標を参照している場合は true。
queryable

boolean

SearchAds360Service.Search と SearchAds360Service.SearchStream のクエリでカスタム列を使用できる場合は true。
referencedSystemColumns[]

string

このカスタム列の参照先システム列のリスト。たとえば、「表示回数とクリック数の合計」というカスタム列の参照先システム列は {"metrics.clicks", "metrics.impressions"} です。
renderType

enum (CustomColumnRenderType)

カスタム列の結果値の解釈方法。

CustomColumnValueType

カスタム列の値の型として使用できる列挙型。

列挙型
UNSPECIFIED 指定されていません。
UNKNOWN 不明。
STRING カスタム列の値は文字列です。
INT64 カスタム列の値は int64 の数値です。
DOUBLE カスタム列の値は double の数値です。
BOOLEAN カスタム列の値はブール値です。
DATE カスタム列の値は日付で、YYYYMMDD 形式です。

CustomColumnRenderType

カスタム列の解釈方法を示す列挙型。

列挙型
UNSPECIFIED 指定されていません。
UNKNOWN 不明。
NUMBER カスタム列は生の数値です。整数か double かは valueType フィールドで確認してください。
PERCENT カスタム列に 100 を掛けてパーセンテージ値を取得します。
MONEY カスタム列の値は金銭的価値で、マイクロ単位です。
STRING カスタム列の値は文字列です。
BOOLEAN カスタム列の値はブール値です。
DATE カスタム列の値は日付で、YYYYMMDD 形式の整数で表されます。

メソッド

get

 リクエストされたカスタム列の詳細を返します。

list

 顧客に関連付けられているすべてのカスタム列の詳細を返します。