Skip to main content
Glama

analyticsadmin.properties.customDimensions.create

Creates a Google Analytics custom dimension for a property, defining event, user, or item metadata for reporting while avoiding collection of individual user data.

Instructions

Creates a CustomDimension. Warning: It's not permissible to use this method to collect data on individual users. In particular, sending user IDs in custom dimensions violates the Google Analytics Terms of Service [HTTP POST] — creates or triggers a change; 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, get, list, patch.

Input Schema

NameRequiredDescriptionDefault
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
parentYes[URL path segment] Required. Example format: properties/1234
dry_runNoReturn the request that would be sent, without sending it.
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON GoogleAnalyticsAdminV1betaCustomDimension object.
request_bodyNoRequest body of type GoogleAnalyticsAdminV1betaCustomDimension: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

NameRequiredDescriptionDefault
nameNo
scopeNo
descriptionNo
displayNameNo
parameterNameNo
disallowAdsPersonalizationNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • 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"
      +}
  2. Changed3 schema fields changed
    • changedInput schema / properties / parent / description
      Previous value: -"Required. Example format: properties/1234"New value: +"[URL path segment] Required. Example format: properties/1234"
    • addedInput schema / properties / parent / pattern
      Added value: +"^properties/[^/]+$"
    • 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"
      +}
  3. First observed

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 the full burden and does well: it flags HTTP POST mutation semantics, warns the call is refused under --readonly safety profiles, and cites a ToS restriction on individual-user data. It omits permission/OAuth scope requirements and idempotency behavior, keeping it from a 5.

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 warning, and every clause is relevant (ToS, mutation safety, body mechanism, siblings). It is somewhat dense with bracketed asides and em-dashes, which slightly hurts readability but wastes little.

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?

An output schema exists, yet the description still clarifies that the response resource is returned as JSON, and it covers the required parent, body fields, safety profile, and sibling alternatives. Only auth-scope and idempotency details are missing for a mutation tool with no annotations.

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 coverage is 100%, so the schema already documents every parameter including parent, params, and body_file. The description restates the body fields (description, disallowAdsPersonalization, displayName, name, parameterName, scope) but adds no syntax or format meaning beyond the schema — baseline 3 applies.

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?

Opens with a specific verb+resource ("Creates a CustomDimension") and explicitly enumerates the sibling set over the same resource (archive, get, list, patch), so an agent can immediately distinguish create from patch/archive without opening the 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?

The named siblings imply when this tool is preferred over patch/archive, and it tells the agent to supply the body via `params` or `body_file`. It stops short of an explicit 'use this when you need a new dimension vs. modifying an existing one' statement, leaving some inference.

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

Deploy Server

Other Tools