API جدید Search Ads 360 Reporting اکنون در دسترس است. به گروه Google
searchads-api-announcements بپیوندید تا در مورد پیشرفت‌ها و نسخه‌های آینده به‌روز باشید.
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) شناسه ستون سفارشی |
name | string نام ستون سفارشی تعریف شده توسط کاربر. |
description | string شرح تعریف شده توسط کاربر از ستون سفارشی. |
valueType | enum ( CustomColumnValueType ) نوع مقدار نتیجه ستون سفارشی. |
referencesAttributes | boolean درست زمانی که ستون سفارشی به یک یا چند ویژگی اشاره دارد. |
referencesMetrics | boolean درست زمانی که ستون سفارشی به یک یا چند معیار اشاره دارد. |
queryable | boolean درست زمانی که ستون سفارشی برای استفاده در جستار SearchAds360Service.Search و SearchAds360Service.SearchStream در دسترس باشد. |
referencedSystemColumns[] | string لیست ستون های سیستم ارجاع شده این ستون سفارشی. به عنوان مثال، یک ستون سفارشی "مجموع نمایش ها و کلیک ها" به ستون های سیستمی از {"metrics.clicks"، "metrics.impressions"} ارجاع داده شده است. |
renderType | enum ( CustomColumnRenderType ) چگونه مقدار نتیجه ستون سفارشی باید تفسیر شود. |
CustomColumnValueType
Enum حاوی انواع مقدار ستون سفارشی ممکن است.
| Enums |
|---|
UNSPECIFIED | مشخص نشده است. |
UNKNOWN | ناشناس. |
STRING | مقدار ستون سفارشی یک رشته است. |
INT64 | مقدار ستون سفارشی یک عدد int64 است. |
DOUBLE | مقدار ستون سفارشی یک عدد دو برابر است. |
BOOLEAN | مقدار ستون سفارشی یک بولی است. |
DATE | مقدار ستون سفارشی یک تاریخ است، در قالب YYYYMMDD. |
CustomColumnRenderType
Enum حاوی راه های مختلفی برای تفسیر یک ستون سفارشی است.
| Enums |
|---|
UNSPECIFIED | مشخص نشده است. |
UNKNOWN | ناشناس. |
NUMBER | ستون سفارشی یک مقدار عددی خام است. فیلد valueType را ببینید تا مشخص کنید عدد صحیح است یا دوتایی. |
PERCENT | برای بازیابی مقدار درصد، ستون سفارشی باید در 100 ضرب شود. |
MONEY | مقدار ستون سفارشی یک مقدار پولی است و بر حسب میکرو است. |
STRING | مقدار ستون سفارشی یک رشته است. |
BOOLEAN | مقدار ستون سفارشی یک بولی است. |
DATE | مقدار ستون سفارشی تاریخی است که به عنوان یک عدد صحیح در قالب YYYYMMDD نمایش داده می شود. |
روش ها |
|---|
| ستون سفارشی درخواستی را با جزئیات کامل برمی گرداند. |
| تمام ستون های سفارشی مرتبط با مشتری را با جزئیات کامل برمی گرداند. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 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. |"]]
