GoogleAnalyticsAdminV1betaCustomDimension

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

A definition for a CustomDimension.

interface GoogleAnalyticsAdminV1betaCustomDimension {

description?: string;

disallowAdsPersonalization?: boolean;

displayName?: string;

readonly name?: string;

parameterName?: string;

scope?:

| "DIMENSION_SCOPE_UNSPECIFIED"

| "EVENT"

| "USER"

| "ITEM";

}

§Properties

description?: string

[src]

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

disallowAdsPersonalization?: boolean

[src]

Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.

displayName?: string

[src]

Required. Display name for this custom dimension 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.

readonly name?: string

[src]

Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}

parameterName?: string

[src]

Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.

scope?: "DIMENSION_SCOPE_UNSPECIFIED" | "EVENT" | "USER" | "ITEM"

[src]

Required. Immutable. The scope of this dimension.