DimensionMetadata

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

Explains a dimension.

interface DimensionMetadata {

apiName?: string;

category?: string;

customDefinition?: boolean;

deprecatedApiNames?: string[];

description?: string;

uiName?: string;

}

§Properties

apiName?: string

[src]

This dimension's name. Useable in Dimension's name. For example, eventName.

category?: string

[src]

The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.

customDefinition?: boolean

[src]

True if the dimension is custom to this property. This includes user, event, & item scoped custom dimensions; to learn more about custom dimensions, see https://support.google.com/analytics/answer/14240153. This also include custom channel groups; to learn more about custom channel groups, see https://support.google.com/analytics/answer/13051316.

deprecatedApiNames?: string[]

[src]

Still usable but deprecated names for this dimension. If populated, this dimension is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the dimension will be available only by apiName.

description?: string

[src]

Description of how this dimension is used and calculated.

uiName?: string

[src]

This dimension's name within the Google Analytics user interface. For example, Event name.