REST Resource: properties.customDimensions

リソース: CustomDimension

CustomDimension の定義。

JSON 表現
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "scope": enum (DimensionScope),
  "disallowAdsPersonalization": boolean
}
フィールド
name

string

出力専用。この CustomDimension リソースのリソース名。形式: properties/{property}/customDimensions/{customDimension}

parameterName

string

必須。変更不可。このカスタム ディメンションのタグ設定パラメータ名。

ユーザー スコープのディメンションの場合は、ユーザー プロパティ名です。イベント スコープのディメンションの場合は、イベント パラメータ名になります。

アイテム スコープのディメンションの場合、e コマースのアイテム配列にあるパラメータ名です。

使用できるのは、英数字とアンダースコアのみで、先頭は英字にします。ユーザー スコープのディメンションの場合は最大 24 文字、イベント スコープのディメンションの場合は 40 文字以内です。

displayName

string

必須。アナリティクス管理画面に表示されるこのカスタム ディメンションの表示名。最大 82 文字で、英数字、スペース、アンダースコア。先頭は英字にします。以前のシステム生成の表示名には角かっこが含まれていることがありますが、このフィールドを更新しても角かっこは使用されなくなります。

description

string

省略可。このカスタム ディメンションの説明。最大長は 150 文字です。

scope

enum (DimensionScope)

必須。変更不可。このディメンションのスコープ。

disallowAdsPersonalization

boolean

省略可。true に設定した場合、このディメンションを非パーソナライズド広告として設定し、広告のパーソナライズから除外します。

現在、これはユーザー スコープのカスタム ディメンションでのみサポートされています。

DimensionScope

このディメンションのスコープの有効な値。

列挙型
DIMENSION_SCOPE_UNSPECIFIED スコープが不明か、指定されていません。
EVENT イベントをスコープとするディメンション。
USER ユーザーをスコープとするディメンション。
ITEM e コマース アイテムをスコープとするディメンション

Methods

archive

プロパティの CustomDimension をアーカイブします。

create

CustomDimension を作成します。

get

1 つの CustomDimension のルックアップ。

list

プロパティの CustomDimensions を一覧表示します。

patch

プロパティの CustomDimension を更新します。