REST Resource: properties.conversionEvents

リソース: ConversionEvent

Google アナリティクスのプロパティのコンバージョン イベント。

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

string

出力のみ。このコンバージョン イベントのリソース名。形式: properties/{property}/conversionEvents/{conversionEvent}

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

出力のみ。設定されている場合、このイベントは conversionEvents.delete で削除できます。

custom

boolean

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

countingMethod

enum (ConversionCountingMethod)

省略可。セッション内の複数のイベントにまたがってコンバージョンをカウントする方法。この値が指定されていない場合は、ONCE_PER_EVENT に設定されます。

defaultConversionValue

object (DefaultConversionValue)

省略可。コンバージョン イベントのデフォルト値または通貨を定義します。

ConversionCountingMethod

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

列挙型
CONVERSION_COUNTING_METHOD_UNSPECIFIED カウント方法が指定されていません。
ONCE_PER_EVENT 各 Event インスタンスはコンバージョンと見なされます。
ONCE_PER_SESSION イベント インスタンスは、ユーザーごとに 1 回のセッションにつき 1 回だけコンバージョンとみなします。

DefaultConversionValue

コンバージョン イベントのデフォルト値または通貨を定義します。値と通貨の両方を指定する必要があります。

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

number

この値は、イベント「value」パラメータが設定されていない、指定された eventName のすべてのコンバージョンの値の入力に使用されます。

currencyCode

string

この eventName のコンバージョン イベントに通貨が設定されていない場合は、この通貨がデフォルトとして適用されます。ISO 4217 通貨コード形式で指定してください。詳しくは、https://en.wikipedia.org/wiki/ISO_4217 をご覧ください。

Methods

create

指定された属性でコンバージョン イベントを作成します。

delete

プロパティ内のコンバージョン イベントを削除します。

get

単一のコンバージョン イベントを取得します。

list

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

patch

指定された属性でコンバージョン イベントを更新します。