GoogleAnalyticsAdminV1betaCustomMetric

import type { GoogleAnalyticsAdminV1betaCustomMetric } from "https://googleapis.deno.dev/v1/analyticsadmin:v1beta.ts";

A definition for a custom metric.

interface GoogleAnalyticsAdminV1betaCustomMetric {

description?: string;

displayName?: string;

measurementUnit?:

| "MEASUREMENT_UNIT_UNSPECIFIED"

| "STANDARD"

| "CURRENCY"

| "FEET"

| "METERS"

| "KILOMETERS"

| "MILES"

| "MILLISECONDS"

| "SECONDS"

| "MINUTES"

| "HOURS";

readonly name?: string;

parameterName?: string;

restrictedMetricType?: "RESTRICTED_METRIC_TYPE_UNSPECIFIED" | "COST_DATA" | "REVENUE_DATA"[];

scope?: "METRIC_SCOPE_UNSPECIFIED" | "EVENT";

}

§Properties

description?: string

[src]

Optional. Description for this custom dimension. Max length of 150 characters.

displayName?: string

[src]

Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.

[src]

Required. The type for the custom metric's value.

readonly name?: string

[src]

Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}

parameterName?: string

[src]

Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.

restrictedMetricType?: "RESTRICTED_METRIC_TYPE_UNSPECIFIED" | "COST_DATA" | "REVENUE_DATA"[]

[src]

Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.

scope?: "METRIC_SCOPE_UNSPECIFIED" | "EVENT"

[src]

Required. Immutable. The scope of this custom metric.