REST Resource: properties.keyEvents

リソース: KeyEvent

Google アナリティクス プロパティのキーイベント。

JSON 表現 
{
  "name": string,
  "eventName": string,
  "createTime": string,
  "deletable": boolean,
  "custom": boolean,
  "countingMethod": enum (CountingMethod),
  "defaultValue": {
    object (DefaultValue)
  }
}
フィールド
name

string

出力専用。このキーイベントのリソース名。形式: properties/{property}/keyEvents/{keyEvent}
eventName

string

変更不可。このキーイベントのイベント名。例: 'click'、'purchase'
createTime

string (Timestamp format)

出力専用。このキーイベントがプロパティで作成された日時。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
deletable

boolean

出力専用。true に設定すると、このイベントは削除できます。
custom

boolean

出力専用。true に設定すると、このキーイベントはカスタム イベントを参照します。false に設定した場合、このキーイベントは GA のデフォルト イベントを参照します。デフォルト イベントは通常、GA で特別な意味を持つイベントです。デフォルト イベントは通常、GA システムによって自動的に作成されますが、プロパティ管理者が作成することもできます。カスタム イベントは、プロパティごとに作成できるカスタム キーイベントの最大数にカウントされます。
countingMethod

enum (CountingMethod)

必須。セッション内の複数のイベントでキーイベントをカウントする方法。
defaultValue

object (DefaultValue)

省略可。キーイベントのデフォルト値/通貨を定義します。

CountingMethod

セッション内の複数のイベントでキーイベントをカウントする方法。

列挙型
COUNTING_METHOD_UNSPECIFIED カウント方法が指定されていません。
ONCE_PER_EVENT 各 Event インスタンスはキーイベントと見なされます。
ONCE_PER_SESSION イベント インスタンスは、ユーザーごとにセッションごとに最大 1 回キーイベントと見なされます。

DefaultValue

キーイベントのデフォルト値/通貨を定義します。

JSON 表現 
{
  "numericValue": number,
  "currencyCode": string
}
フィールド
numericValue

number

必須。この値は、このキーイベント（eventName で指定）の発生時に、そのパラメータが未設定の場合に「value」パラメータに入力されます。
currencyCode

string

必須。このキーイベント（eventName で指定）の発生時に通貨が設定されていない場合、この通貨がデフォルトとして適用されます。ISO 4217 通貨コードの形式で指定する必要があります。

詳細については、https://en.wikipedia.org/wiki/ISO_4217 をご覧ください。

メソッド

create

 キーイベントを作成します。

delete

 キーイベントを削除します。

get

 1 つのキーイベントを取得します。

list

 指定された親プロパティ内の Key Event のリストを返します。

patch

 キーイベントを更新します。