REST Resource: customers.customColumns

リソース: CustomColumn

カスタム列。searchAds360.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

カスタム列が 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 カスタム列の値が倍精度浮動小数点数である。
BOOLEAN カスタム列の値はブール値です。
DATE カスタム列の値は、YYYYMMDD 形式の日付です。

CustomColumnRenderType

カスタム列を解釈するさまざまな方法を含む列挙型。

列挙型
UNSPECIFIED 指定されていません。
UNKNOWN 不明。
NUMBER カスタム列は未加工の数値です。整数か浮動小数点数かを確認するには、valueType フィールドをご覧ください。
PERCENT パーセンテージ値を取得するには、カスタム列に 100 を掛ける必要があります。
MONEY カスタム列の値は金額で、マイクロ単位です。
STRING カスタム列の値は文字列です。
BOOLEAN カスタム列の値はブール値です。
DATE カスタム列の値は、YYYYMMDD 形式の整数で表される日付です。

メソッド

get

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

list

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