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)

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

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
deletable

boolean

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

boolean

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

enum (CountingMethod)

必須。セッション内の複数のイベントにまたがってキーイベントをカウントする方法。
defaultValue

object (DefaultValue)

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

CountingMethod

セッション内の複数のイベントにまたがってキーイベントをカウントする方法。

列挙型
COUNTING_METHOD_UNSPECIFIED カウント方法が指定されていません。
ONCE_PER_EVENT 各イベント インスタンスはキーイベントと見なされます。
ONCE_PER_SESSION Event インスタンスは、ユーザーごとに 1 回のセッションにつき 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

 単一のキーイベントを取得します。

list

 指定された親プロパティのキーイベントのリストを返します。

patch

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