La nouvelle API Search Ads 360 Reporting est désormais disponible. Rejoignez le groupe Google
searchads-api-announcements pour vous tenir informé des améliorations et versions à venir.
REST Resource: customers.customColumns
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ressource : CustomColumn
| Représentation JSON |
{
"resourceName": string,
"id": string,
"name": string,
"description": string,
"valueType": enum (CustomColumnValueType),
"referencesAttributes": boolean,
"referencesMetrics": boolean,
"queryable": boolean,
"referencedSystemColumns": [
string
]
} |
| Champs |
resourceName |
string
Immuable. Nom de ressource de la colonne personnalisée. Les noms de ressources des colonnes personnalisées présentent le format suivant : customers/{customerId}/customColumns/{custom_column_id}
|
id |
string (int64 format)
Uniquement en sortie. ID de la colonne personnalisée.
|
name |
string
Uniquement en sortie. Nom de la colonne personnalisée défini par l'utilisateur.
|
description |
string
Uniquement en sortie. Description de la colonne personnalisée définie par l'utilisateur.
|
valueType |
enum (CustomColumnValueType)
Uniquement en sortie. Type de la valeur de résultat de la colonne personnalisée.
|
referencesAttributes |
boolean
Uniquement en sortie. Vrai lorsque la colonne personnalisée fait référence à un ou plusieurs attributs.
|
referencesMetrics |
boolean
Uniquement en sortie. Vrai lorsque la colonne personnalisée fait référence à une ou plusieurs métriques.
|
queryable |
boolean
Uniquement en sortie. Vrai lorsque la colonne personnalisée peut être utilisée dans la requête de SearchAds360Service.Search et SearchAds360Service.SearchStream.
|
referencedSystemColumns[] |
string
Uniquement en sortie. Liste des colonnes système référencées de cette colonne personnalisée. Par exemple, une colonne personnalisée "Somme des impressions et des clics" fait référence aux colonnes système {"metrics.clicks", "metrics.impressions"}.
|
CustomColumnValueType
Énumération contenant les types de valeurs de colonnes personnalisées possibles.
| Enums |
UNSPECIFIED |
Non spécifié. |
UNKNOWN |
Inconnu. |
STRING |
La valeur de la colonne personnalisée est une chaîne. |
INT64 |
La valeur de la colonne personnalisée est un nombre entier. |
DOUBLE |
La valeur de la colonne personnalisée est un double nombre. |
BOOLEAN |
La valeur de la colonne personnalisée est une valeur booléenne. |
Méthodes |
|
|
Renvoie la colonne personnalisée demandée en détail. |
|
|
Renvoie toutes les colonnes personnalisées associées au client en détail. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2023/08/23 (UTC).
[null,null,["Dernière mise à jour le 2023/08/23 (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. |"]]
