REST Resource: properties.customDimensions

リソース: CustomDimension

CustomDimension の定義。

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

string

出力専用。このカスタム ディメンション リソースのリソース名。形式: 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 コマース商品にスコープ設定されたディメンション

メソッド

archive

 プロパティのカスタム ディメンションをアーカイブします。

create

 CustomDimension を作成します。

get

 単一のカスタム ディメンションを検索します。

list

 プロパティのカスタム ディメンションを一覧表示します。

patch

 プロパティのカスタム ディメンションを更新します。