customers

GET /v23/customers/{customersId}/customColumns/{customColumnsId}

Returns the requested custom column in full detail.

Request

Path parameters

customersIdstring required
customColumnsIdstring required

Response

Successful response

descriptionstring

Output only. User-defined description of the custom column.

idstring int64

Output only. ID of the custom column.

namestring

Output only. User-defined name of the custom column.

queryableboolean

Output only. True when the custom column is available to be used in the query of SearchAds360Service.Search and SearchAds360Service.SearchStream.

referencedSystemColumnsstring[]

Output only. The list of the referenced system columns of this custom column. For example, A custom column "sum of impressions and clicks" has referenced system columns of {"metrics.clicks", "metrics.impressions"}.

referencesAttributesboolean

Output only. True when the custom column is referring to one or more attributes.

referencesMetricsboolean

Output only. True when the custom column is referring to one or more metrics.

renderType'UNSPECIFIED' | 'UNKNOWN' | 'NUMBER' | 'PERCENT' | 'MONEY' | 'STRING' | 'BOOLEAN' | 'DATE'

Output only. How the result value of the custom column should be interpreted.

resourceNamestring

Immutable. The resource name of the custom column. Custom column resource names have the form: customers/{customer_id}/customColumns/{custom_column_id}

valueType'UNSPECIFIED' | 'UNKNOWN' | 'STRING' | 'INT64' | 'DOUBLE' | 'BOOLEAN' | 'DATE'

Output only. The type of the result value of the custom column.

Changes

No recorded changes to this operation across all 4 revisions of this API.