--- title: "ウィッシュリストパイプライン" slug: "wish-lists-pipelines" abstract: "" --- # ウィッシュリストパイプライン カートAPIで使用されている積分および関与ロジックは、必要に応じてカスタマイズ可能なパイプラインによって実装されています。各メソッドごとにパイプラインがAPI上にあります。一部のパイプラインはSaveCartやLoadCartなど他の一般的なパイプラインを呼び出します。場合によっては、CreateOrResumeCartパイプラインで使われるif-then-elseの状況に対応するために、ロジックが複数のサブパイプラインに分割されます。 ## CreateWishListパイプライン **名前:** CreateWishList **説明:** パイプラインはウィッシュリストの作成と関連するページイベントの発生を担当します。 **使用方法:** ウィッシュリストを作成する際にConnect APIの CreateWishList メソッドで呼び出されます。 **ARGS:** \*\*リクエスト -\*\*検索条件を含む:UserID、WishListName、ShopName。パイプラインを呼び出す前に設定されます。 \*\*レスポンス -\*\*作成されたウィッシュリストオブジェクトを含む。パイプライン実行後に読み取られる。 **プロセッサー:** **TriggerWishListCreatedPageEvent** **–** **責任** – ウィッシュリスト作成ページのイベントを発生させます。 ## DeleteWishListパイプライン **名前:** DeleteWishList **説明:** パイプラインはウィッシュリストの削除と関連するページイベントの生成を担当します。 **使用方法:** ウィッシュリストを削除する際にConnect APIの DeleteWishList メソッドで呼び出されます。 **ARGS:** \*\*リクエスト -\*\*検索条件を含む:ウィッシュリスト。パイプラインを呼び出す前に設定されます。 \*\*レスポンス -\*\*WishListオブジェクトを含みます。パイプライン実行後に読み込まれます。 **プロセッサー:** **TriggerWishListDeletedPageEvent** **–** **責任** – ウィッシュリスト削除ページのイベントを発生させます。 ## EmailWishListsパイプライン **名前:** メールウィッシュリスト **説明:** 指定されたウィッシュリストをメール送信し、関連するページイベントを発生させます。 **使用方法:** ウィッシュリスト付きのメールを送る際、Connect APIの EmailWishLists 方式で呼び出されました。 **ARGS:** \*\*リクエスト -\*\*検索条件を含む:IEnumerable。パイプラインを呼び出す前に設定されます。 \*\*レスポンス -\*\*IEnumerableを含む。パイプライン実行後に読み取られます。 **プロセッサー:** **TriggerWishListsEmailedPageEvent** **–** **責任** – ウィッシュリストメールページイベントを上げる。 ## GetWishListパイプライン **名前:** GetWishList **説明:** パイプラインはすべてのウィッシュリストに対して検索を行い、指定された検索条件に合致するウィッシュリストインスタンスを返す役割を担っています。 **使用方法:** ウィッシュリストを検索する際にConnect APIの GetWishLists メソッドで呼び出されました。 **ARGS:** \*\*リクエスト -\*\*検索条件を含む:UserId、WishlistId、ShopName。パイプラインを呼び出す前に設定されます。 \*\*レスポンス -\*\*マッチするWishListオブジェクトを含む。パイプライン実行後に読み取られます。 **プロセッサー:** デフォルトのプロセッサはありません ## GetWishListsパイプライン **名前:** GetWishLists **説明:** パイプラインはすべてのウィッシュリストに対して検索を行い、指定された検索条件に合致するカートリッジのWishListHeaderインスタンスのリストを返します。 **使用方法:** ウィッシュリストを検索する際のConnect APIの GetWishLists 方式で呼び出されます。 **ARGS:** \*\*リクエスト -\*\*検索条件:UserIDとShopNameを含む。パイプラインを呼び出す前に設定される。 \*\*レスポンス -\*\*WishListHeaderオブジェクトを含む。パイプライン実行後に読み取られます。 **プロセッサー:** デフォルトのプロセッサはありません ## UpdateWishListパイプライン **名前:** 更新ウィッシュリスト **説明:** パイプラインはウィッシュリスト上の選択項目を更新する役割を担います。 **使用方法:** ウィッシュリストを更新する際にConnect APIの UpdateWishList メソッドで呼び出されます。 **ARGS:** \*\*リクエスト -\*\*検索条件を含む:ウィッシュリスト。パイプラインを呼び出す前に設定されます。 \*\*レスポンス -\*\*WishListオブジェクトを含みます。パイプライン実行後に読み込まれます。 **プロセッサー:** デフォルトのプロセッサはありません ## RemoveWishListLinesパイプライン **名前:** DeleteWishListLines(希望リストライン)を削除してください **説明:** パイプラインはウィッシュリストから選択された項目を削除する役割を担っています。 **使用方法:** カートを探す際にConnect APIの RemoveWishListLines メソッドで呼び出しました。 **ARGS:** \*\*リクエスト -\*\*検索条件のウィッシュリストと削除すべきラインアイテムIDのリストが含まれています。パイプラインを呼び出す前に設定されます。 \*\*レスポンス -\*\*更新されたウィッシュリストと削除されたラインアイテムオブジェクトを含みます。パイプライン実行後に読み込まれます。 **プロセッサー:** **TriggerLinesRemovedFromWishListPageEvent** **–** **責任** – ウィッシュリストページから削除されたラインを上げるイベント。 ## UpdateWishListLinesパイプライン **名前:** 更新ウィッシュリストライン **説明:** パイプラインは、すでにウィッシュリストに追加された特定の項目を更新する役割を担っています。 **使用方法:** ウィッシュリストの項目を更新する際にConnect APIの UpdateWishListLines メソッドで呼び出します。 **ARGS:** \*\*リクエスト -\*\*検索条件:WishListおよびWishListItemsのコレクションを含む。パイプラインを呼び出す前に設定される。 \*\*レスポンス -\*\*更新されたウィッシュリストと更新を希望されたウィッシュリスト項目を含む。パイプライン実行後に読み取られる。 **プロセッサー:** **TriggerLinesUpdatedOnWishListPageEvent****–** **責任** – Raises the Lines(希望リストページに更新)イベント。 ## AddLinesToWishListパイプライン **名前:** AddLinesToWishList **説明:** パイプラインはカートに新しい行項目を追加し、関連するページイベントを発生させる役割を担っています。 **使用方法:** ウィッシュリストに新しい行を追加する際にConnect APIの AddLinesToWishList メソッドで呼び出します。 **ARGS:** \*\*Request -\*\*条件を含む:WishListとWishListItemsのコレクション。パイプラインを呼び出す前に設定されます。 \*\*Response -\*\*更新されたWishListと初期のWishListItemオブジェクトを含みます。パイプライン実行後に読み込まれます。 **プロセッサー:** **TriggerLinesAddedToWishListPageEvent** **–** **責任** – ウィッシュリストページに追加されたラインイベント。 ## PrintWishListパイプライン **名前:** プリントウィッシュリスト **説明:** パイプラインは印刷用のウィッシュリストオブジェクトを取得する役割を担っています。 **使用方法:** 印刷したいウィッシュリストを探す際にConnect APIの PrintWishList メソッドで呼び出しました。 **ARGS:** \*\*リクエスト -\*\*検索条件を含む:WishListオブジェクト。パイプラインを呼び出す前に設定されます。 \*\*レスポンス -\*\*印刷するWishListオブジェクトを含む。パイプライン実行後に読み取られます。 **プロセッサー:** **TriggerWishListPrintedPageEvent****–** **責任** – ウィッシュリストページから削除されたラインを上げるイベント。