analyticsadmin.properties.customMetrics.create
Creates a CustomMetric on a Google Analytics property to track event-scoped metrics. Send the metric definition as JSON to register it for reporting.
Instructions
Creates a CustomMetric [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 GoogleAnalyticsAdminV1betaCustomMetric object accepting description, displayName, measurementUnit, name, parameterName, restrictedMetricType, scope; pass it via params or whole via body_file Siblings over the same resource: archive, get, list, patch.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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. | |
| parent | Yes | [URL path segment] Required. Example format: properties/1234 | |
| 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 GoogleAnalyticsAdminV1betaCustomMetric object. | |
| request_body | No | Request body of type GoogleAnalyticsAdminV1betaCustomMetric: 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 | ||
| measurementUnit | No | ||
| restrictedMetricType | No |