Draft an Analytics custom dimension
draft_ga4_custom_dimensionDraft registering, changing or archiving a GA4 custom dimension, returning a PREVIEW.
Registering makes an event parameter (EVENT scope), a user property (USER) or an ecommerce item parameter (ITEM) reportable as a dimension. Before anything reaches Google the draft refuses a parameter that is already registered, a taken display name and a full property (see list_ga4_custom_definitions), and the preview warns that GA4 fills the dimension only from now on and that parameter_name and scope cannot change later. Update changes display_name, description or (USER scope) disallow_ads_personalization; archive removes it from reports and frees the slot, cannot be undone and needs a double confirmation. Nothing changes until confirm_and_apply applies it. GA4 Admin API (customDimensions).
Google Analytics Data API: https://developers.google.com/analytics/devguides/reporting/data/v1 and Admin API: https://developers.google.com/analytics/devguides/config/admin/v1
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "draft_ga4_custom_dimension"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | EVENT (default), USER or ITEM. | EVENT |
| action | No | "create" (default), "update" or "archive". | create |
| description | No | Up to 150 characters. On update, "" clears it. | |
| property_id | No | Numeric GA4 property ID, with or without the "properties/" prefix. If empty, uses the default from config. | |
| display_name | No | Name shown in GA4; defaults to parameter_name on create. | |
| parameter_name | No | The event parameter or user property name exactly as sent, e.g. "plan_type". Required for create; identifies the dimension for update and archive. | |
| custom_dimension | No | Resource name, instead of parameter_name, for update or archive. | |
| disallow_ads_personalization | No | USER scope only: keep this dimension out of ads personalization. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||