A nova API Search Ads 360 Reporting já está disponível. Participe do grupo do Google
searchads-api-announcements para ficar por dentro das próximas melhorias e versões.
REST Resource: customers.customColumns
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recurso: CustomColumn
Representação JSON |
{
"resourceName": string,
"id": string,
"name": string,
"description": string,
"valueType": enum (CustomColumnValueType ),
"referencesAttributes": boolean,
"referencesMetrics": boolean,
"queryable": boolean,
"referencedSystemColumns": [
string
],
"renderType": enum (CustomColumnRenderType )
} |
Campos |
resourceName |
string
O nome de recurso da coluna personalizada. Os nomes dos recursos de colunas personalizadas têm o seguinte formato: customers/{customerId}/customColumns/{custom_column_id}
|
id |
string (int64 format)
ID da coluna personalizada.
|
name |
string
Nome definido pelo usuário da coluna personalizada.
|
description |
string
Descrição da coluna personalizada definida pelo usuário.
|
valueType |
enum (CustomColumnValueType )
O tipo do valor do resultado da coluna personalizada.
|
referencesAttributes |
boolean
Verdadeiro quando a coluna personalizada se refere a um ou mais atributos.
|
referencesMetrics |
boolean
Verdadeiro quando a coluna personalizada se refere a uma ou mais métricas.
|
queryable |
boolean
Verdadeiro quando a coluna personalizada está disponível para ser usada na consulta do SearchAds360Service.Search e SearchAds360Service.SearchStream.
|
referencedSystemColumns[] |
string
Lista das colunas do sistema referenciadas por essa coluna personalizada. Por exemplo, uma coluna personalizada "soma de impressões e cliques" tem colunas do sistema referenciadas de {"metrics.clicks", "metrics.impressions"}.
|
renderType |
enum (CustomColumnRenderType )
Como o valor do resultado da coluna personalizada deve ser interpretado.
|
CustomColumnValueType
Enum que contém possíveis tipos de valor de coluna personalizada.
Enums |
UNSPECIFIED |
Não especificado. |
UNKNOWN |
Desconhecido. |
STRING |
O valor da coluna personalizada é uma string. |
INT64 |
O valor da coluna personalizada é um número int64. |
DOUBLE |
O valor da coluna personalizada é um número duplo. |
BOOLEAN |
O valor da coluna personalizada é um booleano. |
DATE |
O valor da coluna personalizada é uma data no formato AAAAMMDD. |
CustomColumnRenderType
Enum que contém as diferentes maneiras de interpretar uma coluna personalizada.
Enums |
UNSPECIFIED |
Não especificado. |
UNKNOWN |
Desconhecido. |
NUMBER |
A coluna personalizada é um valor numérico bruto. Consulte o campo valueType para determinar se ele é um número inteiro ou um número duplo. |
PERCENT |
A coluna personalizada precisa ser multiplicada por 100 para extrair o valor percentual. |
MONEY |
O valor da coluna personalizada é monetário e está em micros. |
STRING |
O valor da coluna personalizada é uma string. |
BOOLEAN |
O valor da coluna personalizada é um booleano. |
DATE |
O valor da coluna personalizada é uma data representada como um número inteiro no formato AAAAMMDD. |
Métodos |
|
Retorna a coluna personalizada solicitada com todos os detalhes. |
|
Retorna todas as colunas personalizadas associadas ao cliente com todos os detalhes. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[[["\u003cp\u003eA \u003ccode\u003eCustomColumn\u003c/code\u003e 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.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCustomColumnValueType\u003c/code\u003e and \u003ccode\u003eCustomColumnRenderType\u003c/code\u003e 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.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize methods like \u003ccode\u003eget\u003c/code\u003e and \u003ccode\u003elist\u003c/code\u003e 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.\u003c/p\u003e\n"]]],["Custom columns are user-defined fields in Search Ads 360, defined by a `resourceName`, `id`, `name`, and `description`. They can reference attributes or metrics, be queryable, and include system columns. The `valueType` (e.g., string, int64, date) determines the column's data type, while `renderType` (e.g., number, percent, money) dictates how it's interpreted. Methods include `get` for retrieving a specific column and `list` for all columns.\n"],null,["# REST Resource: customers.customColumns\n\n- [Resource: CustomColumn](#CustomColumn)\n - [JSON representation](#CustomColumn.SCHEMA_REPRESENTATION)\n- [CustomColumnValueType](#CustomColumnValueType)\n- [CustomColumnRenderType](#CustomColumnRenderType)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CustomColumn\n----------------------\n\nA custom column. See searchAds360.search Ads 360 custom column at \u003chttps://support.google.com/sa360/answer/9633916\u003e\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"resourceName\": string, \"id\": string, \"name\": string, \"description\": string, \"valueType\": enum (/search-ads/reporting/api/reference/rest/v0/customers.customColumns#CustomColumnValueType), \"referencesAttributes\": boolean, \"referencesMetrics\": boolean, \"queryable\": boolean, \"referencedSystemColumns\": [ string ], \"renderType\": enum (/search-ads/reporting/api/reference/rest/v0/customers.customColumns#CustomColumnRenderType) } ``` |\n\n| Fields ||\n|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `resourceName` | `string` The resource name of the custom column. Custom column resource names have the form: `customers/{customerId}/customColumns/{custom_column_id}` |\n| `id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` ID of the custom column. |\n| `name` | `string` User-defined name of the custom column. |\n| `description` | `string` User-defined description of the custom column. |\n| `valueType` | `enum (`[CustomColumnValueType](/search-ads/reporting/api/reference/rest/v0/customers.customColumns#CustomColumnValueType)`)` The type of the result value of the custom column. |\n| `referencesAttributes` | `boolean` True when the custom column is referring to one or more attributes. |\n| `referencesMetrics` | `boolean` True when the custom column is referring to one or more metrics. |\n| `queryable` | `boolean` True when the custom column is available to be used in the query of SearchAds360Service.Search and SearchAds360Service.SearchStream. |\n| `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\"}. |\n| `renderType` | `enum (`[CustomColumnRenderType](/search-ads/reporting/api/reference/rest/v0/customers.customColumns#CustomColumnRenderType)`)` How the result value of the custom column should be interpreted. |\n\nCustomColumnValueType\n---------------------\n\nEnum containing possible custom column value types.\n\n| Enums ||\n|---------------|--------------------------------------------------------|\n| `UNSPECIFIED` | Not specified. |\n| `UNKNOWN` | Unknown. |\n| `STRING` | The custom column value is a string. |\n| `INT64` | The custom column value is an int64 number. |\n| `DOUBLE` | The custom column value is a double number. |\n| `BOOLEAN` | The custom column value is a boolean. |\n| `DATE` | The custom column value is a date, in YYYYMMDD format. |\n\nCustomColumnRenderType\n----------------------\n\nEnum containing the different ways a custom column can be interpreted.\n\n| Enums ||\n|---------------|---------------------------------------------------------------------------------------------------------------|\n| `UNSPECIFIED` | Not specified. |\n| `UNKNOWN` | Unknown. |\n| `NUMBER` | The custom column is a raw numerical value. See valueType field to determine if it is an integer or a double. |\n| `PERCENT` | The custom column should be multiplied by 100 to retrieve the percentage value. |\n| `MONEY` | The custom column value is a monetary value and is in micros. |\n| `STRING` | The custom column value is a string. |\n| `BOOLEAN` | The custom column value is a boolean. |\n| `DATE` | The custom column value is a date represented as an integer in YYYYMMDD format. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------|\n| ### [get](/search-ads/reporting/api/reference/rest/v0/customers.customColumns/get) | Returns the requested custom column in full detail. |\n| ### [list](/search-ads/reporting/api/reference/rest/v0/customers.customColumns/list) | Returns all the custom columns associated with the customer in full detail. |"]]