REST Resource: properties.customDimensions

リソース: CustomDimension

CustomDimension の定義。

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

string

ID。この CustomDimension リソースのリソース名。形式: properties/{property}/customDimensions/{customDimension}

parameterName

string

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

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

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

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

displayName

string

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

description

string

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

scope

enum (DimensionScope)

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

disallowAdsPersonalization

boolean

省略可。true に設定すると、このディメンションが NPA として設定され、広告のパーソナライズから除外されます。

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

DimensionScope

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

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

メソッド

archive

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

create

CustomDimension を作成します。

get

単一の CustomDimension を検索します。

list

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

patch

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