Skip to main content
Glama

analyticsadmin.properties.keyEvents.patch

Updates a Google Analytics Admin key event via PATCH, applying only fields named in the update mask and returning the updated resource as JSON.

Instructions

Updates a Key Event [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaKeyEvent object accepting countingMethod, createTime, custom, defaultValue, deletable, eventName, name; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list.

Input Schema

NameRequiredDescriptionDefault
nameYes[URL path segment] Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
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 GoogleAnalyticsAdminV1betaKeyEvent object.
updateMaskNo[query parameter] Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the enti
request_bodyNoRequest body of type GoogleAnalyticsAdminV1betaKeyEvent: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

NameRequiredDescriptionDefault
nameNo
customNo
deletableNo
eventNameNo
createTimeNo
defaultValueNo
countingMethodNo

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 GoogleAnalyticsAdminV1betaKeyEvent object."
    • addedInput schema / properties / request_body
      Added value: +{
      +  "description": "Request body of type GoogleAnalyticsAdminV1betaKeyEvent: pass it via `params` (merged into the built body) or whole via `body_file`.",
      +  "properties": {
      +    "countingMethod": {
      +      "enum": [
      +        "COUNTING_METHOD_UNSPECIFIED",
      +        "ONCE_PER_EVENT",
      +        "ONCE_PER_SESSION"
      +      ],
      +      "type": "string"
      +    },
      +    "createTime": {
      +      "type": "string"
      +    },
      +    "custom": {
      +      "type": "boolean"
      +    },
      +    "defaultValue": {
      +      "properties": {
      +        "currencyCode": {
      +          "type": "string"
      +        },
      +        "numericValue": {
      +          "type": "number"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "deletable": {
      +      "type": "boolean"
      +    },
      +    "eventName": {
      +      "type": "string"
      +    },
      +    "name": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed5 schema fields changed
    • changedInput schema / properties / name / description
      Previous value: -"Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}"New value: +"[URL path segment] Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}"
    • addedInput schema / properties / name / pattern
      Added value: +"^properties/[^/]+/keyEvents/[^/]+$"
    • changedInput schema / properties / updateMask / description
      Previous value: -"Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the enti"New value: +"[query parameter] Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the enti"
    • addedInput schema / properties / updateMask / format
      Added value: +"google-fieldmask"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "countingMethod": {
      +      "enum": [
      +        "COUNTING_METHOD_UNSPECIFIED",
      +        "ONCE_PER_EVENT",
      +        "ONCE_PER_SESSION"
      +      ],
      +      "type": "string"
      +    },
      +    "createTime": {
      +      "type": "string"
      +    },
      +    "custom": {
      +      "type": "boolean"
      +    },
      +    "defaultValue": {
      +      "properties": {
      +        "currencyCode": {
      +          "type": "string"
      +        },
      +        "numericValue": {
      +          "type": "number"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "deletable": {
      +      "type": "boolean"
      +    },
      +    "eventName": {
      +      "type": "string"
      +    },
      +    "name": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  3. First observed

TDQS

A3.9/5.0
Behavior3/5

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

With no annotations, the description carries the burden: it usefully discloses the readonly-profile refusal and that the API's response resource is returned as JSON. It omits permission requirements, irreversibility/omitted-field behavior, and the fact that updateMask governs the scope of the mutation — notable gaps for a write tool with zero annotation coverage.

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?

A single dense, front-loaded sentence with no filler; the verb/HTTP method comes first and the sibling routing comes last. It is slightly run-on, packing body fields, transport options and siblings into one block, but every clause is informative.

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, so the return-value explanation is redundant but harmless, and the safety-profile refusal note is genuinely necessary given no annotations. The main residual gap is not clarifying the updateMask semantics that drive a PATCH on this resource.

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 the required name pattern and updateMask. The description adds modest value by listing the body fields and explaining that the body can be passed via `params` or whole via `body_file`, which is the baseline-plus level.

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 (updates), resource (Key Event), and transport ([HTTP PATCH]), and explicitly enumerates the sibling operations over the same resource (create, delete, get, list), so an agent can place it precisely among them.

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?

Gives a real selection constraint — 'refused under --readonly safety profiles' — and distinguishes itself from create/delete/get/list. It does not say when to prefer patch over a hypothetical full update, nor flag that updateMask is mandatory in practice, but the context is clear.

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