カート パイプライン

Cart API で使用される統合およびエンゲージメント ロジックは、必要に応じてカスタマイズできるパイプラインによって実装されます。API のメソッドごとにパイプラインがあります。一部のパイプラインは、SaveCart パイプラインや LoadCart パイプラインなどの他の一般的なパイプラインを呼び出します。場合によっては、CreateOrResumeCart パイプラインで使用されているように、ロジックがいくつかのサブパイプラインに分けられ、if-then-else の状況を処理します。

名前:

GetCarts

説明:

このパイプラインは、すべてのカートに対して検索を実行して、指定した検索条件に一致する見つかったカートの CartBase インスタンスのリストを返します。

カートは、ECS または EA 状態の両方で保持されている場合があります。

メインのカート リポジトリの場所に応じて、パイプラインに設定されるプロセッサーは Connect プロバイダーの実装によって異なります。

使用方法:

カートを検索するときに、Connect API の GetCarts メソッドで呼び出します。

引数:

要求: 検索条件の UserID、CustomerID、CartName、CartStatus、IsLocked、ShopName を含めます。パイプラインを呼び出す前に設定します。

応答: カート オブジェクトが含まれています。パイプラインが実行された後に読み取られます。

プロセッサー:

GetCartsFromEAState:

役割: 入力パラメーター (UserID、CustomerID、CartName、ShopName) に一致するすべてのユーザーに対して、EA 状態に保存されているカートのクエリを実行します。

デフォルトの実装では、このプロセッサーは次の 2 つに分けられます。

  • BuildQuery。

  • ExecuteQuery。EA リポジトリにクエリを実行します。

使用方法: このプロセッサーは、EA 状態を検索してカートのリストを返すための汎用プロセッサーです。外部のコマース システムがカートの保持をサポートしている場合は、このプロセッサーを ECS に対してクエリを実行するカスタムの GetCarts プロセッサーに置き換える必要があります (以下を参照)。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: より多くの検索パラメーターが必要な場合は、プロセッサーを継承して上書きして検索する必要があります。

GetCarts:

役割: 入力パラメーター (UserID、CustomerID、CartName、ShopName) に一致する外部のコマース システムに保存されているカートのクエリを実行します。

使用方法: ECS がカートの保持をサポートしている場合は、このプロセッサーを EA 状態に対してクエリを実行するデフォルトの Connect のプロセッサーに置き換えます。

サポートしていない場合は、代わりに EA 状態と GetCartsFromEAState プロセッサーを使用する必要があります

所有権: ECS ベンダー

カスタマイズ: このプロセッサーは ECS にカスタマイズされています。より多くの検索パラメーターが必要な場合は、それらをサポートするようにこのプロセッサーを拡張する必要があります。

名前:

CreateOrResumeCart

説明:

ショッピング カートを作成し、その過程で以下のことを行います。

  • 保持されている放棄された可能性のあるカートがある場合は読み込み、それを返します。

  • 新しいカートが作成されたら、DMS でイベントをトリガーします。

  • 新しいショッピング カートの ID を使用して、エンゲージメント オートメーション プランにユーザーを入力します。

このパイプラインは、既存のカートがあるかどうかと再開できるかどうかに応じて、別のパイプラインを呼び出します。

使用方法:

Connect API の CreateOrResumeCart メソッドで呼び出します。

引数:

要求: 既存のカートの検索にも使用する重要なカートのパラメーターを含めます。パイプラインを呼び出す前に設定します。

応答: 指定したパラメーターに一致するカート オブジェクトまたは複数のカートがある場合の CartBase インスタンスのリストが含まれます。パイプラインを呼び出した後にカート プロバイダーによって読み取られます。

プロセッサー:

FindCartInEAState:

役割: 入力パラメーター (UserID、CustomerID、CartName、ShopName) に一致する現在のコンタクト/訪問者の EA 状態のカートを見つけます。

一致するものが見つかった場合、カート ID がパイプラインのカスタムの引数の CartID (args.CustomData[“CartID”]) に設定されます。

このプロセッサーは、LoadCart メソッドを呼び出す前に既存のカートのカート ID を取得するために必要です。

使用方法: このプロセッサーは、EA 状態で検索して、指定した入力パラメーターに一致するカートのカート ID を返すための汎用プロセッサーです。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 追加のクエリ パラメーターが導入されない限り、特にデフォルトの機能を上書きする必要はありません。

RunLoadCart:

役割: LoadCart パイプラインを呼び出し、指定した ID のカートを読み込みます。ID は、CartId パラメーターで指定します。

カートが見つからない場合は、パイプラインの引数でカートが null または空になります。

使用方法: 必須。このプロセッサーは、CartID でカートを読み込んで他のパイプラインで使用できる LoadCart パイプラインを呼び出すための汎用プロセッサーです。

カートの読み込みに使用する CartID は、顧客パイプラインの引数の “CartID” (args.CustomData[“CartID”]) に保存されていることを前提としています。

RunResumeCart パイプラインは、実行する前に再開するカートが読み込まれていることを前提としています。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

RunResumeCart:

役割: 読み込まれたカートを再開するために ResumeCart パイプラインを呼び出します (可能な場合)。

パイプラインの引数にカートがあることを前提としています。

カートがない場合、このプロセッサーは ResumeCart パイプラインを呼び出しません。

使用方法: 必須。このプロセッサーは、ResumeCart パイプラインを呼び出すための汎用プロセッサーです。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

RunCreateCart:

役割: 新しいカートを作成するために CreateCart パイプラインを呼び出します。

パイプラインの引数にカートがないことを前提としています。

カートがある場合、このプロセッサーは CreateCart パイプラインを呼び出しません。

使用方法: 必須。このプロセッサーは、CreateCart パイプラインを呼び出すための汎用プロセッサーです。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

名前:

CreateCart

説明:

新しいショッピング カートを作成して保存し、その過程で以下のことを行います。

  • DMS で新しいカートのイベントをトリガーします。

  • 新しいショッピング カートを使用して、訪問者/コンタクトをエンゲージメント オートメーション プランに入力します。

使用方法:

カートがない場合に、CreateOrResumeCart パイプラインから分岐の 1 つとして呼び出されます。

引数:

要求: CreateOrResumeCart パイプラインと同じパラメーターが含まれます。これは、CreateOrResumeCart パイプラインから渡されます。

応答: カート オブジェクトが含まれます。パイプラインが呼び出された後にカート プロバイダーによって読み取られます。

プロセッサー:

CreateCart:

役割: 新しいカートを作成し、引数の値を初期化して返します。

パイプラインの引数にカートが既にある場合、そのカートは無視され、上書きされます。

使用方法: 任意。デフォルトのプロセッサーは、ドメイン モデルのカートを作成して値を初期化するための汎用プロセッサーですが、ECS を呼び出すことはありません。

一部の統合シナリオでは、この時点で ECS を呼び出して新しいカートを作成することが重要になります。その場合、このプロセッサーはカート ドメイン オブジェクトを初期化するため、基本クラスとして使用して拡張することも、すべて置き換えることもできます。

別の統合シナリオでは、この時点では ECS を呼び出しません。代わりに、カートの品目を操作するときに呼び出したり、カートを保存するときにのみ呼び出したりします。これは、統合するシステムによって異なります。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: このプロセッサーを基本クラスとして使用し、カート ドメイン モデル オブジェクトを初期化した後に ECS を呼び出すことでプロセッサーを拡張すると役立つ場合があります。

RunSaveCart:

役割: 指定したカートを保存する SaveCart パイプラインを呼び出します。

使用方法: 任意。ただし、このようにカートを変更したときには必ず呼び出す必要があります。このプロセッサーは、SaveCart パイプラインを呼び出すための汎用プロセッサーであり、他のパイプラインでも使用できます。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

TriggerPageEventForResultCart:

役割: 指定したページ イベントをトリガーし、カートの値 (ExternalCartId、UserId、CartName、CartStatus) を登録します。

ページ イベントのテキストは、Sitecore のディクショナリを参照してローカライズされます。

使用方法: 任意。このプロセッサーは、args.Result 引数に格納されているカートの指定したパラメーターを使用してページ イベントをトリガーするための汎用プロセッサーです。

トリガーするイベントは、プロセッサーの PageEventName パラメーターで指定します。

使用するイベントのテキストは、プロセッサーの PageEventText パラメーターで指定します。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: カートから他の値を登録する場合は、プロセッサーを上書きします。

名前:

CreateOrResumeCart

説明:

引数で指定したカートを検証して再開し、その過程で以下のことを行います。

  • 放棄されたカートのエンゲージメントで状態を初期状態にします (再起動)。

  • カートの状態を更新します。

  • カートを保存します。

  • DMS でイベントをトリガーします。

使用方法:

Sitecore から Connect API で呼び出します。

引数:

要求: 検索条件を含めます。パイプラインを呼び出す前にカート プロバイダーで設定します。

応答: カート オブジェクトが含まれます。パイプラインが呼び出された後にカート プロバイダーによって読み取られます。

プロセッサー:

ChangeCartStatus:

役割: カートのステータス フィールドの値を CartStatus.InProcess 定数から取得した InProcess の値で更新します。

使用方法: 任意。このプロセッサーは汎用ですが、カートに設定されるステータス値は InProcess に固定されています。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: このプロセッサーを更新して、コードの定数ではなく、パラメーターから状態値を取得することができます。

RunSaveCart:

役割: 指定したカートを保存する SaveCart パイプラインを呼び出します。

使用方法: 必須。このプロセッサーは、SaveCart パイプラインを呼び出すための汎用プロセッサーで、他のパイプラインで使用できます。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

TriggerPageEventForResumedCart:

役割: カートを再開するときに、指定したページ イベントをトリガーし、以下のカートの値を登録します。

  • ExternalCartIdUserIdCartNameCartStatusStateName (移行した前の状態を含みます)。

ページ イベントのテキストは、Sitecore のディクショナリを参照してローカライズされます。

使用方法: 任意。このプロセッサーは、カートを再開するためと、args.Result 引数に格納されているカートの指定したパラメーターを使用してページ イベントをトリガーするための専用のプロセッサーです。

前の状態の値は PreviousState パイプラインの引数にあり、ExternalCartId. と一緒にページ イベントのテキストに挿入されます。

使用するイベントのテキストは、プロセッサーの PageEventText パラメーターで指定します。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: カートの他の値を登録する場合やテキストの書式設定を変更する場合にプロセッサーを上書きします。

名前:

LoadCart

説明:

指定した条件 (ID や ShopName など) に一致するカートを読み込みます。

このパイプラインは、コマース システムで管理されている特定のカートのデータを読み取ります。このパイプラインは、コマース システムまたはエンゲージメント オートメーション状態からカートのデータを読み取ります。

使用方法:

  • Sitecore から Connect API の LoadCart メソッドで直接呼び出します。

  • Connect API の CreateOrResumeCart メソッドで間接的に呼び出します。

引数:

要求: 取得する対象のカートを決定する条件を含めます。パイプラインを呼び出す前に設定します。

応答: パイプラインが呼び出された後のカート オブジェクトが含まれます。

プロセッサー:

LoadCartFromEAState:

役割:

指定した CartID と ShopName パラメーターで指定したショップを使用して、EA 状態から既存のカートを読み込みます。

パフォーマンス上の理由により、デフォルトの実装は次のように機能します。

  • まず、カートが現在の訪問者/コンタクトの EA 状態のデータから読み込まれ、指定したパラメーターでフィルタリングされます。見つかった場合は、パイプラインの応答の引数のプロパティに書き込まれ、実行が停止されます。

  • 見つからない場合は、すべてのコンタクトのすべてのカートが読み込まれ、指定したパラメーターでフィルタリングされます。すべてのコンタクトを検索するのは、負荷の高い操作です。

  • EA 状態でカートが見つかった場合は、パイプラインの応答の引数のプロパティに書き込まれます。

使用方法: このプロセッサーは、EA 状態からカートを読み込むための汎用プロセッサーです。

ECS でカートの保持を使用できない場合やカートの処理が Sitecore のみで発生する場合、このプロセッサーは LoadCart パイプラインで単独で使用される場合があります。

また、ECS がカート リポジトリのみを管理する場合も、パイプラインから除外される場合があります。

一部の ECS システムでは、カート ドメイン モデルで指定した情報の一部が提供されず、ハイブリッド構成を使用して主なデータが ECS から読み取られ、追加のプロセッサーを挿入することで EA 状態に保存された追加のカートのデータが追加される場合があります。

放棄されたカートは、ECS から削除されても、Sitecore の EA 状態には残っている場合があります。この場合、パイプラインに両方のプロセッサーがあると役に立ちます。そうすると、Sitecore はカートのバックアップ ストレージとして機能します。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

LoadCart:

役割:

指定した CartID と ShopName パラメーターで指定したショップを使用して、ECS から既存のカートを読み込みます。

使用方法: このプロセッサーは、ECS からカートを読み込むための専用のプロセッサーです。

ECS でカートの保持を使用できる場合、このプロセッサーは LoadCart パイプラインで単独で使用される場合があります。LoadCartFromEAState プロセッサーの説明のシナリオも参照してください。

一部の ECS システムでは、カート ドメイン モデルで指定した情報の一部が提供されず、ハイブリッド構成を使用して主なデータが ECS から読み取られ、追加のプロセッサーを挿入することで EA 状態に保存された追加のカートのデータが追加される場合があります。

LoadCartFromEAState と組み合わせて使用する場合、カートが EA 状態から既に読み込まれている場合でも、ECS を確認し、ECS からカートを読み込んで、最新バージョンが使用されていることを確認することが重要です。

カートが外部のコマース システムにある場合、パイプラインの応答の引数のプロパティに既に格納されているカートで上書きまたはマージできます。これは、ECS を使用した Connect プロバイダーの実装によって異なります。

所有権: このプロセッサーは ECS によって提供されます。

カスタマイズ: ECS 専用に構築する必要があります。

名前:

SaveCart

説明:

カートを外部のコマース システムとエンゲージメント オートメーション状態の両方に保存します。

使用方法:

他のサービス レイヤーのメソッドから呼び出されますが、明示的にはほとんど呼び出されません。

引数:

要求: 取得する対象のカートを決定する条件を含めます。パイプラインを呼び出す前に設定します。

応答: パイプラインが呼び出された後のカート オブジェクトが含まれます。

プロセッサー:

SaveCart:

役割:

指定されたカートを ECS に保存します。

使用方法: このプロセッサーは、ECS にカートを保存するための専用のプロセッサーです。

このプロセッサーは、既存のカートを再開する機能が EA 状態に保存されているカートにも依存するため、SaveCart パイプラインで単独で使用しないでください。FindCartInEAState プロセッサーは、LoadCart を使用して ECS からカートを読み込むための CartId を取得するために、EA 状態のカートを検索します。

一部の ECS システムでは、カート ドメイン モデルで指定した情報の一部が提供されず、ハイブリッド構成を使用して主なデータが ECS に保存され、EA 状態に追加のカートのデータが保存される場合があります。

一部の ECS の実装では、SaveCart パイプラインは ECS システムに Connect からカートが提供される最初で唯一の場所です。

ECS はカートのプライマリ リポジトリであるため、一意の CartID キーが ECS によって提供されることを前提としています。

所有権: このプロセッサーは ECS によって提供されます。

カスタマイズ: ECS 専用に構築する必要があります。

SaveCartToEAState:

役割:

カートを EA 状態に保存します。

使用方法: 必須。このプロセッサーは、EA 状態にカートを保存するための汎用プロセッサーです。

ECS でカートの保持を使用できない場合やカートの処理が Sitecore のみで発生する場合、このプロセッサーは LoadCart パイプラインで単独で使用される場合があります。

このプロセッサーは、既存のカートを再開する機能が EA 状態に保存されているカートにも依存するため、SaveCart パイプラインで使用する必要があります。FindCartInEAState プロセッサーは、LoadCart パイプラインを使用して ECS からカートを読み込むための CartId を取得するために、EA 状態のカートを検索します。

一部の ECS システムでは、カート ドメイン モデルで指定した情報の一部が提供されず、ハイブリッド構成を使用して主なデータが ECS から読み取られ、追加のプロセッサーを挿入することで EA 状態に保存された追加のカートのデータが追加される場合があります。

放棄されたカートは、ECS から購入されても、Sitecore の EA 状態には残っている場合があります。この場合、パイプラインに両方のプロセッサーがあると役に立ちます。そうすると、Sitecore はカートのバックアップ ストレージとして機能します。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

名前:

AddCartLines

説明:

このパイプラインは、ショッピング カートに新しい品目を追加し、DMS で対応するページ イベントを記録します。これは、商品がカートに追加されたときに発生します。

使用方法:

Sitecore から呼び出されます。

引数:

要求: 更新するカートと、カートに追加する必要のある品目を含めます。

パイプラインを呼び出す前に設定されます。

応答: パイプラインが呼び出された後の更新されたカート オブジェクトが含まれます。

プロセッサー:

CheckIfLocked:

役割: カートがロックされているかどうかを確認し、ロックされている場合はパイプラインを中止して、ロック状態を通知する SystemMessages を返します。

使用方法: 任意。このプロセッサーは、カートがロックされているかどうかを確認するための汎用プロセッサーです。このプロセッサーは、カートの内容を変更する可能性のあるすべてのパイプラインで使用されている必要があります。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

AddLinesToCart:

役割: 指定した品目を指定したカートに追加します。

このメソッドを呼び出すと、品目が同じ商品を含むカートに既に存在する場合でも、カートの既存の品目のコレクションに指定した品目が常に追加されます。または、商品の品目が既に存在していて数量を調整するだけの場合は、UpdateLinesOnCart メソッドを呼び出すことができます。

使用方法: 任意。このプロセッサーはカートに品目を追加するための汎用プロセッサーですが、ECS に固有の実装に置き換える必要がある場合があります。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: デフォルトの実装は、Sitecore のカート ドメイン モデルでのみ動作します。

ほとんどの ECS との統合では、この実装を継承して上書きまたは置き換えて ECS を呼び出すことで、カートへの変更が渡され、任意のビジネス ロジックを適用できるようにすることが重要です。

RunSaveCart:

役割: 指定したカートを保存する SaveCart パイプラインを呼び出します。

使用方法: 任意ですが、カートを変更した際に必ず呼び出す必要があるため、ここでは必須です。SaveCart パイプラインを呼び出すための汎用プロセッサーであり、他のパイプラインでも使用できます。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

TriggerPageEventsForCartLines:

役割: カートに品目を追加するときに、指定したページ イベントをトリガーし、次の値を登録します。

  • 商品 ID、数量、価格、通貨

トリガーするイベントは、パラメーターおよびページ イベントのテキストとして渡されます。

この場合のイベントは、カートへの品目の追加です。ページ イベントのテキストは、Sitecore のディクショナリを参照してローカライズされます。

使用方法: 任意。このプロセッサーは、カートの品目を変更するときにページ イベントをトリガーするための汎用プロセッサーです。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: カートの他の値を登録する場合やテキストの書式設定を変更する場合にプロセッサーを上書きします。

TriggerAddToCartStockStatusPageEvent:

役割: ページ イベントの AddToCartStockStatus を ShopName、カート ID、商品 ID、在庫ステータス、予約注文可能、在庫到着日、配送日と一緒にトリガーします。ただし、在庫ステータスが InStock でない場合に限ります。

使用方法: 必須。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 必要ありません。

UpdateVisitorInAutomationPlan:

役割: 現在のコンタクトを AbandonedCart キャンペーン プロセッサーに登録します。

使用方法: 任意。Commerce マーケティング オートメーション キャンペーンで使用します。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 以下のパラメーターを使用して、現在のコンタクトをカート放棄マーケティング オートメーション キャンペーンに登録します。

  • basePlanName はキャンペーン プラン名です。デフォルト値は Abandoned Cart です。

  • allowDuplicateContacts は、マーケティング オートメーション キャンペーンに同じコンタクトを複数回登録することを許可するかどうかを示します。デフォルト値は false です。

  • allowUnauthenticatedContacts は、匿名ユーザーや未登録ユーザーの登録を許可するかどうかを示します。デフォルト値は true です。

さらにカスタマイズするために、プロセッサーを継承することができます。

名前:

RemoveCartLines

説明:

カートから品目を削除します。

使用方法:

Sitecore から呼び出されます。

引数:

要求: 更新するカートと、カートから削除する品目を含めます。

パイプラインを呼び出す前に設定されます。

応答: パイプラインが呼び出された後の更新されたカート オブジェクトが含まれます。

プロセッサー:

CheckIfLocked:

役割: カートがロックされているかどうかを確認し、ロックされている場合はパイプラインを中止して、ロック状態を通知する SystemMessage を返します。

使用方法: 任意。このプロセッサーは、カートがロックされているかどうかを確認するための汎用プロセッサーです。このプロセッサーは、カートの内容を変更する可能性のあるすべてのパイプラインで使用されている必要があります。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

RemoveLinesFromCart:

役割: 指定した品目を指定したカートから削除します。

削除する品目のリストは、カートの CartLines コレクションの品目への直接の参照である必要があります。それらは、cart.CartLines = cart.CartLines.Except(request.CartLines).ToList(); の参照によって削除されます。

使用方法: 任意。このプロセッサーはカートから品目を削除するための汎用プロセッサーですが、ECS に固有の実装に置き換える必要がある場合があります。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: デフォルトの実装は、Sitecore のカート ドメイン モデルでのみ動作します。

ほとんどの ECS との統合では、この実装を継承して上書きまたは置き換えて ECS を呼び出すことで、カートへの変更が渡され、任意のビジネス ロジックを適用できるようにすることが重要です。

SaveCart:

役割: 指定したカートを保存する SaveCart パイプラインを呼び出します。

使用方法: 任意。ただし、このようにカートを変更したときには必ず呼び出す必要があります。このプロセッサーは、SaveCart パイプラインを呼び出すための汎用プロセッサーであり、他のパイプラインでも使用できます。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

TriggerPageEventsForCartLines:

役割: カートに品目を追加するときに、指定したページ イベントをトリガーし、次の値を登録します。

  • 商品 ID、数量、価格、通貨

トリガーするイベントは、パラメーターおよびページ イベントのテキストとして渡されます。この場合のイベントは、カートからの品目の削除です。ページ イベントのテキストは、Sitecore のディクショナリを参照してローカライズされます。

使用方法: 任意。このプロセッサーは、カートの品目を変更するときにページ イベントをトリガーするための汎用プロセッサーです。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: カートの他の値を登録する場合やテキストの書式設定を変更する場合にプロセッサーを上書きします。

UpdateVisitorInAutomationPlan:

役割: 現在のコンタクトを AbandonedCart キャンペーン プロセッサーに登録します。

使用方法: 任意。Commerce マーケティング オートメーション キャンペーンにコンタクトを登録するために使用します。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 以下のパラメーターに基づいて、コンタクトを Commerce マーケティング オートメーション キャンペーンに登録します。

  • basePlanName はキャンペーン プラン名です。デフォルト値は Abandoned Cart です。

  • allowDuplicateContacts は、マーケティング オートメーション キャンペーンに同じコンタクトを複数回登録することを許可するかどうかを示します。デフォルト値は false です。

  • allowUnauthenticatedContacts は、匿名ユーザーや未登録ユーザーの登録を許可するかどうかを示します。デフォルト値は true です。

名前:

UpdateCartLines

説明:

カートの品目を更新します。

使用方法:

Sitecore から呼び出されます。

引数:

要求: 更新するカートと、カートの品目を含めます。

パイプラインを呼び出す前に設定されます。

応答: パイプラインが呼び出された後の更新されたカート オブジェクトが含まれます。

プロセッサー:

CheckIfLocked:

役割: カートがロックされているかどうかを確認し、ロックされている場合はパイプラインを中止して、ロック状態を通知する SystemMessages を返します。

使用方法: 任意。このプロセッサーは、カートがロックされているかどうかを確認するための汎用プロセッサーです。このプロセッサーは、カートの内容を変更する可能性のあるすべてのパイプラインで使用されている必要があります。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

UpdateLinesOnCart:

役割: 指定したカートで指定した品目を更新します。

デフォルトの実装では、元のカートの品目は処理されませんが、渡されたカートで品目が既に更新されているカートが返されます。

そのため、更新された品目のリストは、カートの CartLines コレクションへの参照になります。

使用方法: 任意。このプロセッサーはカートの品目を更新するための汎用プロセッサーですが、ECS に固有の実装に置き換える必要がある場合があります。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: デフォルトの実装は、Sitecore のカート ドメイン モデルでのみ動作します。

ほとんどの ECS との統合では、この実装を継承して上書きまたは置き換えて ECS を呼び出すことで、カートへの変更が渡され、任意のビジネス ロジックを適用できるようにすることが重要です。

SaveCart:

役割: 指定したカートを保存する SaveCart パイプラインを呼び出します。

使用方法: 任意ですが、カートを変更した際に必ず呼び出す必要があるため、ここでは必須です。SaveCart パイプラインを呼び出すための汎用プロセッサーであり、他のパイプラインでも使用できます。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

TriggerPageEventsForCartLines:

役割: カートに品目を追加するときに、指定したページ イベントをトリガーし、次の値を登録します。

  • 商品 ID、数量、価格、通貨

トリガーするイベントは、パラメーターおよびページ イベントのテキストとして渡されます。この場合のイベントは、カートの品目の更新です。ページ イベントのテキストは、Sitecore のディクショナリを参照してローカライズされます。

使用方法: 任意。このプロセッサーは、カートの品目を変更するときにページ イベントをトリガーするための汎用プロセッサーです。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: カートの他の値を登録する場合やテキストの書式設定を変更する場合にプロセッサーを上書きします。

UpdateVisitorInAutomationPlan:

役割: 現在のコンタクトを AbandonedCart キャンペーン プロセッサーに登録します。

使用方法: 任意。Commerce マーケティング オートメーション キャンペーンに誰が登録されているかを確認するために使用します。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 以下のパラメーターに基づいて、Commerce マーケティング オートメーション キャンペーンに誰が登録されているかを確認します。

  • basePlanName はキャンペーン プラン名です。デフォルト値は Abandoned Cart です。

  • allowDuplicateContacts は、マーケティング オートメーション キャンペーンに同じコンタクトを複数回登録することを許可するかどうかを示します。デフォルト値は false です。

  • allowUnauthenticatedContacts は、匿名ユーザーや未登録ユーザーの登録を許可するかどうかを示します。デフォルト値は true です。

さらにカスタマイズするために、プロセッサーを継承することができます。

名前:

DeleteCart

説明:

カートを完全に削除します。

  • カートを削除します。

  • DMS でイベントをトリガーして、カートが削除されたことを通知します。

使用方法:

Sitecore から呼び出されます。

引数:

要求: 削除するカートを含めます。

パイプラインを呼び出す前に設定されます。

応答: SystemMessages。

プロセッサー:

CheckIfLocked:

役割: カートがロックされているかどうかを確認し、ロックされている場合はパイプラインを中止して、ロック状態を通知する SystemMessages を返します。

使用方法: 任意。このプロセッサーは、カートがロックされているかどうかを確認するための汎用プロセッサーです。このプロセッサーは、カートの内容を変更する可能性のあるすべてのパイプラインで使用されている必要があります。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

DeleteCart:

役割: ECS のストレージからカートを削除します。

使用方法: 必須。

所有権: このプロセッサーは ECS によって提供されます。

カスタマイズ: ECS 専用に構築する必要があります。

DeleteCartFromEAState:

役割: EA 状態のカートを見つけて削除します。

使用方法: 任意。このプロセッサーは、EA 状態のカートを削除するための汎用プロセッサーです。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

TriggerPageEventForRequestCart:

役割: カートを削除するときに、指定したページ イベントをトリガーし、次の値を登録します。

  • ExternalCartId、UserId、CartName、CartStatus

トリガーするイベントは、パラメーターおよびページ イベントのテキストとして渡されます。この場合のイベントは、カートの削除です。ページ イベントのテキストは、Sitecore のディクショナリを参照してローカライズされます。

使用方法: 任意。CartRequest パラメーター タイプに基づいて引数をとるプロセッサーのページ イベントをトリガーするための汎用プロセッサーです。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: カートの他の値を登録する場合やテキストの書式設定を変更する場合にプロセッサーを上書きします。

名前:

UpdateCart

説明:

更新されたカートを外部のコマース システムに渡します。

DMS でイベントをトリガーして、カートが更新されていることを通知します。

使用方法:

Sitecore から呼び出されます。

引数:

要求: カートと、Cart Base で更新するデータを含めます。

パイプラインを呼び出す前に設定されます。

応答: パイプラインが呼び出された後の更新されたカート オブジェクトが含まれます。

プロセッサー:

CheckIfLocked:

役割: カートがロックされているかどうかを確認し、ロックされている場合はパイプラインを中止して、ロック状態を通知する SystemMessages を返します。

使用方法: 任意。このプロセッサーは、カートがロックされているかどうかを確認するための汎用プロセッサーです。このプロセッサーは、カートの内容を変更する可能性のあるすべてのパイプラインで使用されている必要があります。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

SetAnonymousPreferredEmail:

役割: 請求ページから匿名ユーザーのメール アドレスを取得し、それを優先メール アドレスとして設定します。

使用方法: 匿名ユーザーのメール アドレスを取得するために Commerce マーケティング オートメーション キャンペーンで使用します。UpdateVisitorinAutomationPlan プロセッサーと連携して動作します。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ:

UpdateCart:

役割: カート本体 (CartBase オブジェクトのみ。品目などは含まれません) の更新された値でカートを更新します。

デフォルトの実装では、CustomerID、CartName、ShopName を除く CartBase のすべてのデフォルトのプロパティが更新されます。null と空白の値を含むすべてが含まれます。

使用方法: 任意。このプロセッサーは、カート本体を更新するための汎用プロセッサーです。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: デフォルトの Connect のドメイン モデルをカスタマイズする場合は、カスタマイズしたプロパティを含めるためにプロセッサーを上書きする必要があります。

TriggerPageEventForRequestCartChanges:

役割: カートを削除するときに、指定したページ イベントをトリガーし、次の値を登録します。

  • CustomerId、CartName、ShopName

トリガーするイベントは、パラメーターおよびページ イベントのテキストとして渡されます。この場合のイベントは、カートの削除です。ページ イベントのテキストは、Sitecore のディクショナリを参照してローカライズされます。

使用方法: 任意。UpdateCartRequest パラメーター タイプに基づいて引数をとるプロセッサーのページ イベントをトリガーするための汎用プロセッサーです。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: カートの他の値を登録する場合やテキストの書式設定を変更する場合にプロセッサーを上書きします。

RunSaveCart:

役割: 指定したカートを保存する SaveCart パイプラインを呼び出します。

使用方法: 任意ですが、カートを変更した際に必ず呼び出す必要があるため、ここでは必須です。SaveCart パイプラインを呼び出すための汎用プロセッサーであり、他のパイプラインでも使用できます。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

UpdateVisitorInAutomationPlan:

役割: 現在のコンタクトを AbandonedCart キャンペーン プロセッサーに登録します。

使用方法: 任意。Commerce マーケティング オートメーション キャンペーンに誰が登録されているかを確認するために使用します。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 以下のパラメーターに基づいて、Commerce マーケティング オートメーション キャンペーンに誰が登録されているかを確認します。

  • basePlanName はキャンペーン プラン名です。デフォルト値は Abandoned Cart です。

  • allowDuplicateContacts は、マーケティング オートメーション キャンペーンに同じコンタクトを複数回登録することを許可するかどうかを示します。デフォルト値は false です。

  • allowUnauthenticatedContacts は、匿名ユーザーや未登録ユーザーの登録を許可するかどうかを示します。デフォルト値は true です。

さらにカスタマイズするために、プロセッサーを継承することができます。

名前:

LockCart

説明:

カートをロック状態に設定し、変更されないようにします。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - ロックするカートを含みます。

パイプラインを呼び出す前に設定されます。

応答 - パイプラインが呼び出された後のカート オブジェクトが含まれます。

プロセッサー:

LockCart –

役割: カートをロック状態に設定します (IsLocked = true)。

使用方法: 任意。カートをロックするための汎用プロセッサーです。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: デフォルトの実装では ECS は呼び出されません。ロック時に ECS を呼び出すために、実装を変更または置換することが適切な場合があります。

RunSaveCart –

役割: 指定したカートを保存する SaveCart パイプラインを呼び出します。

使用方法: 任意ですが、カートを変更した際に必ず呼び出す必要があるため、ここでは必須です。SaveCart パイプラインを呼び出すための汎用プロセッサーであり、他のパイプラインでも使用できます。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

TriggerPageEventForRequestCart

役割: カートを削除するときに、指定されたページ イベントをトリガーし、次の値を登録します。

  • ExternalCartId、UserId、CartName、CartStatus

トリガーされるイベントは、ページ イベント テキストのほか、パラメーターとしても渡されます。ここでは CartLocked イベントがトリガーされます。ページ イベント テキストは、Sitecore ディクショナリで検索することでローカライズされます。

使用方法: 任意。CartRequest パラメーター タイプに基づいて引数をとるプロセッサーのページ イベントをトリガーするための汎用プロセッサーです。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: カートの他の値を登録する場合やテキストの書式設定を変更する場合にプロセッサーを上書きします。

名前:

UnlockCart

説明:

カートをロック解除状態に設定します。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - ロック解除するカートを含みます。

パイプラインを呼び出す前に設定されます。

応答 - パイプラインが呼び出された後のカート オブジェクトが含まれます。

プロセッサー:

UnlockCart –

役割: カートをロックされていない状態に設定します (IsLocked = false)。

使用方法: 任意。カートをロック解除するための汎用プロセッサーです。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: デフォルトの実装では ECS は呼び出されません。ロック解除時に ECS を呼び出すために、実装を変更または置換することが適切な場合があります。

RunSaveCart –

役割: 指定したカートを保存する SaveCart パイプラインを呼び出します。

使用方法: 任意ですが、カートを変更した際に必ず呼び出す必要があるため、ここでは必須です。SaveCart パイプラインを呼び出すための汎用プロセッサーであり、他のパイプラインでも使用できます。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。

TriggerPageEventForRequestCart

役割: カートを削除するときに、指定されたページ イベントをトリガーし、次の値を登録します。

  • ExternalCartId、UserId、CartName、CartStatus

トリガーされるイベントは、ページ イベント テキストのほか、パラメーターとしても渡されます。ここでは Cart Unlocked イベントがトリガーされます。ページ イベント テキストは、Sitecore ディクショナリで検索することでローカライズされます。

使用方法: 任意。CartRequest パラメーター タイプに基づいて引数をとるプロセッサーのページ イベントをトリガーするための汎用プロセッサーです。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: カートの他の値を登録する場合やテキストの書式設定を変更する場合にプロセッサーを上書きします。

名前:

MergeCart

説明:

ユーザー カートを匿名カートとマージします。

使用方法:

Sitecore から呼び出されます。

引数:

要求 - ユーザー カートと匿名カートを含みます。

応答 - マージされたユーザー カートを含みます。

プロセッサー:

MergeCart –

役割: ユーザ ーカートと匿名カートをマージします。

使用方法: 任意。カートをマージするための汎用プロセッサーです。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: デフォルトの実装では ECS は呼び出されません。カスタムなマージ規則が必要な場合に、実装を変更または置換することが適切な場合があります。

RunSaveCart –

役割: 指定したカートを保存する SaveCart パイプラインを呼び出します。

使用方法: 任意ですが、カートを変更した際に必ず呼び出す必要があるため、ここでは必須です。SaveCart パイプラインを呼び出すための汎用プロセッサーであり、他のパイプラインでも使用できます。

所有権: このプロセッサーは、Connect で提供されます。

カスタマイズ: 特にデフォルトの機能を上書きする必要はありません。