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 コマースの items 配列にあるパラメータ名になります。

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

displayName

string

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

description

string

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

scope

enum (DimensionScope)

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

disallowAdsPersonalization

boolean

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

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

DimensionScope

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

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

メソッド

archive

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

create

CustomDimension を作成します。

get

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

list

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

patch

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