The new Search Ads 360 Reporting API is now available. Join thesearchads-api-announcements Google group to stay up to date on upcoming enhancements and releases.

REST Resource: customers.customColumns

  • ACustomColumn is a user-defined column in Search Ads 360 that can reference attributes and metrics to create custom calculations or data views, with its structure and properties defined in a JSON format.

  • CustomColumnValueType andCustomColumnRenderType are enumerations that determine the data type and interpretation of values in a custom column, respectively, influencing how the column's output is displayed and used.

  • Developers can utilize methods likeget andlist to retrieve details or a complete list of custom columns associated with a Search Ads 360 customer, enabling programmatic management and analysis of custom data within the platform.

Resource: CustomColumn

A custom column. See searchAds360.search Ads 360 custom column athttps://support.google.com/sa360/answer/9633916

JSON representation
{"resourceName":string,"id":string,"name":string,"description":string,"valueType":enum (CustomColumnValueType),"referencesAttributes":boolean,"referencesMetrics":boolean,"queryable":boolean,"referencedSystemColumns":[string],"renderType":enum (CustomColumnRenderType)}
Fields
resourceName

string

The resource name of the custom column. Custom column resource names have the form:

customers/{customerId}/customColumns/{custom_column_id}

id

string (int64 format)

ID of the custom column.

name

string

User-defined name of the custom column.

description

string

User-defined description of the custom column.

valueType

enum (CustomColumnValueType)

The type of the result value of the custom column.

referencesAttributes

boolean

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

referencesMetrics

boolean

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

queryable

boolean

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

referencedSystemColumns[]

string

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"}.

renderType

enum (CustomColumnRenderType)

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

CustomColumnValueType

Enum containing possible custom column value types.

Enums
UNSPECIFIEDNot specified.
UNKNOWNUnknown.
STRINGThe custom column value is a string.
INT64The custom column value is an int64 number.
DOUBLEThe custom column value is a double number.
BOOLEANThe custom column value is a boolean.
DATEThe custom column value is a date, in YYYYMMDD format.

CustomColumnRenderType

Enum containing the different ways a custom column can be interpreted.

Enums
UNSPECIFIEDNot specified.
UNKNOWNUnknown.
NUMBERThe custom column is a raw numerical value. See valueType field to determine if it is an integer or a double.
PERCENTThe custom column should be multiplied by 100 to retrieve the percentage value.
MONEYThe custom column value is a monetary value and is in micros.
STRINGThe custom column value is a string.
BOOLEANThe custom column value is a boolean.
DATEThe custom column value is a date represented as an integer in YYYYMMDD format.

Methods

get

 Returns the requested custom column in full detail.

list

 Returns all the custom columns associated with the customer in full detail.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-04-02 UTC.