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
  ]
}
フィールド
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"} のシステム列を参照しています。

CustomColumnValueType

使用可能なカスタム列の値の型を含む列挙型。

列挙型
UNSPECIFIED 指定されていません。
UNKNOWN 不明
STRING カスタム列の値は文字列です。
INT64 カスタム列の値は int64 数値です。
DOUBLE カスタム列の値が倍精度浮動小数点です。
BOOLEAN カスタム列の値はブール値です。

Methods

get

 リクエストされたカスタム列をすべて返します。

list

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