grr

Overview Schema Source Related Servers Discussions Admin

analyticsadmin.properties.customDimensions.patch

Updates a Google Analytics property's custom dimension via PATCH using an update mask, with optional dry-run preview and JSON response.

Instructions

Updates a CustomDimension on a property [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaCustomDimension object accepting description, disallowAdsPersonalization, displayName, name, parameterName, scope; pass it via params or whole via body_file Siblings over the same resource: archive, create, get, list.

Input Schema

Name	Required	Description
`name`	Yes	[URL path segment] Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
`query`	No	Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
`params`	No	Parameter map merged into the request; typed parameters win.
`dry_run`	No	Return the request that would be sent, without sending it.
`body_file`	No	Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON GoogleAnalyticsAdminV1betaCustomDimension object.
`updateMask`	No	[query parameter] Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fiel
`request_body`	No	Request body of type GoogleAnalyticsAdminV1betaCustomDimension: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

Name	Required	Description	Default
`name`	No
`scope`	No
`description`	No
`displayName`	No
`parameterName`	No
`disallowAdsPersonalization`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedOct 26, 2026

changedInput schema / properties / body_file / description

Previous value: -"Read the request body from this file ('-' for stdin) instead of building one from the parameters."New value: +"Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON GoogleAnalyticsAdminV1betaCustomDimension object."

addedInput schema / properties / request_body

Added value: +{
+  "description": "Request body of type GoogleAnalyticsAdminV1betaCustomDimension: pass it via `params` (merged into the built body) or whole via `body_file`.",
+  "properties": {
+    "description": {
+      "type": "string"
+    },
+    "disallowAdsPersonalization": {
+      "type": "boolean"
+    },
+    "displayName": {
+      "type": "string"
+    },
+    "name": {
+      "type": "string"
+    },
+    "parameterName": {
+      "type": "string"
+    },
+    "scope": {
+      "enum": [
+        "DIMENSION_SCOPE_UNSPECIFIED",
+        "EVENT",
+        "USER",
+        "ITEM"
+      ],
+      "type": "string"
+    }
+  },
+  "type": "object"
+}

Changed5 schema fields changedOct 26, 2026

changedInput schema / properties / name / description

Previous value: -"Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}"New value: +"[URL path segment] Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}"

addedInput schema / properties / name / pattern

Added value: +"^properties/[^/]+/customDimensions/[^/]+$"

changedInput schema / properties / updateMask / description

Previous value: -"Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fiel"New value: +"[query parameter] Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fiel"

addedInput schema / properties / updateMask / format
```
Added value: +"google-fieldmask"
```

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "description": {
+      "type": "string"
+    },
+    "disallowAdsPersonalization": {
+      "type": "boolean"
+    },
+    "displayName": {
+      "type": "string"
+    },
+    "name": {
+      "type": "string"
+    },
+    "parameterName": {
+      "type": "string"
+    },
+    "scope": {
+      "enum": [
+        "DIMENSION_SCOPE_UNSPECIFIED",
+        "EVENT",
+        "USER",
+        "ITEM"
+      ],
+      "type": "string"
+    }
+  },
+  "type": "object"
+}

First observedOct 26, 2026

TDQS

A4.1/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries real behavioral weight: it discloses the HTTP PATCH mutation semantics, the readonly-profile refusal, and that the response resource is returned as JSON. It doesn't cover permission requirements or reversibility, but it is well above the annotation-free baseline.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the core action and the readonly constraint, then covers return value, body, and siblings. Some redundancy with the schema (body field list, params vs body_file), but every clause still serves a purpose and nothing is bloated.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with a 7-param nested schema and an existing output schema, the description supplies the key missing pieces: mutation nature, safety refusal, and body-passing mechanism. Complete enough to invoke correctly, with the noted updateMask omission being minor given the schema covers it.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description restates the body fields (description, disallowAdsPersonalization, displayName, name, parameterName, scope) and the params/body_file mechanism, but this largely duplicates what the schema already documents, and it omits the required updateMask nuance.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Updates a CustomDimension on a property') and explicitly names the sibling operations over the same resource (archive, create, get, list), so an agent can distinguish patch from create/archive without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides clear context for when the tool applies and a useful when-not signal ('refused under --readonly safety profiles'), plus names the sibling alternatives. It stops short of routing the agent with explicit conditions for choosing patch vs create vs archive, so it is a strong 4 rather than a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server