REST Resource: customers.customColumns
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
资源:CustomColumn
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
当自定义列引用一个或多个属性时,该值为 true。
|
referencesMetrics |
boolean
当自定义列引用一个或多个指标时,该值为 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 格式的整数表示。 |
方法 |
|
详细返回所请求的自定义列。 |
|
返回与客户关联的所有自定义列的完整详细信息。 |
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[[["\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. |"]]