ウィッシュリストサービスレイヤー

Sitecore Experience Commerce(サイトコアエクスペリエンスコマース)
コマースコネクト
Commerce Connect開発者リファレンス
サービスレイヤーの接続
ウィッシュリストサービスレイヤー
ウィッシュリストサービスプロバイダー

ウィッシュリストサービスプロバイダー

Version:

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

サービスプロバイダーは、Connectパイプラインとの対話を容易にするために設計されたラッパーオブジェクトです。プロバイダーは、Connectパイプラインを呼び出す以外のロジックを実装しません。すべてのビジネスロジックは、パイプラインプロセッサに実装されます。

プロバイダの各メソッドには、対応するRequestオブジェクトとResultオブジェクトが使用されます (たとえば、GetCartsはGetCartsRequestオブジェクトを受け取り、GetCartsResultオブジェクトを返します)。場合によっては、同じデータを返すときに応答オブジェクトが再利用されます。

デフォルトの要求引数と結果引数のカスタマイズされたバージョンは、オーバーロードされたジェネリックベースのメソッドを呼び出すことによって使用できます。

ウィッシュリストサービスプロバイダーには、カートデータを操作するための次のメソッドが含まれています。

CreateWishListメソッド

CreateWishListメソッドは、外部コマースシステムでウィッシュリストをクエリして作成し、新しく作成されたWishListオブジェクトを返すために使用されます。

名前：	ウィッシュリストを作成
形容：	指定した条件に一致するウィッシュリストを作成します。 CreateWishListパイプラインを呼び出します。
使い：	新しいウィッシュリストを作成するときに呼び出されます。たとえば、次のようなものがあります。特定のストアで特定の名前を持つユーザーのウィッシュリストを作成する。
署名：	CreateWishListResult CreateWishList(NotNullCreateWishListRequestリクエスト)
インプット：
	UserId – カートを作成するユーザーのID。
	WishListName – ウィッシュリストに割り当てるフレンドリ名。
	ショップ名 –ウィッシュリストが作成されているショップの名前。
アウトプット：
	ウィッシュリスト – 新しく作成されたウィッシュリスト。
	システムメッセージ - 外部システムからのメッセージの収集。

使用例:

var wishListService = new WishListServiceProvider();
var request = new CreateWishListRequest("Bob", "Bobs wish list", "webShop");
var result = wishListService.CreateWishList(request);

DeleteWishListメソッド

DeleteWishListメソッドは、外部コマースシステムでウィッシュリストをクエリ削除し、削除されたウィッシュリストオブジェクトを返すために使用されます。

名前：	ウィッシュリストの削除
形容：	指定した条件に一致するウィッシュリストを削除します。 DeleteWishList パイプラインを呼び出します。
使い：	ウィッシュリストを削除する必要がある場合に呼び出されます。たとえば、次のようなものがあります。特定のウィッシュリストを削除します。
署名：	DeleteWishListResult DeleteWishList(NotNullDeleteWishListRequestリクエスト)
インプット：
	ウィッシュリスト - eコマースシステムから削除するウィッシュリスト。
アウトプット：
	ウィッシュリスト – 削除されたウィッシュリスト。
	システムメッセージ - 外部システムからのメッセージの収集。

使用例:

var wishListService = new WishListServiceProvider();
var createRequest = new CreateWishListRequest("Bob", "Bob's wish list", "webShop");
var wishList = wishListService.CreateWishList(createRequest).WishList;
var deleteRequest = new DeleteWishListRequest(wishList);
var result = wishListService.DeleteWishList(deleteRequest);

EmailWishListsメソッド

EmailWishListsメソッドは、ユーザーが電子メールメッセージでウィッシュリストを送信しようとしたときにページイベントを発生させるために使用されます。

名前：	メールウィッシュリスト
形容：	指定した条件に基づいて、いくつかのウィッシュリストを含むメールメッセージを送信します。 emailWishLists パイプラインを呼び出します。
使い：	ウィッシュリストを呼び出して、メールメッセージで送信します。
署名：	EmailWishListsResult EmailWishLists(NotNull EmailWishListsRequestリクエスト)
インプット：
	IEnumerable<WishList> -ウィッシュリストは、メールメッセージで送信します。
アウトプット：
	IEnumerable<WishList> – Eメールメッセージで送信されたウィッシュリスト。
	システムメッセージ - 外部システムからのメッセージの収集。

使用例:

var wishListService = new WishListServiceProvider();
var line = new WishListLine
{
    Product = new Entities.Carts.CartProduct
    {
        ProductId = "Product1", 
        Price = new Entities.Prices.Price((decimal)22.99, "USD")
    }, 
    Quantity = 1
};
var wishList = new WishList
{
    CustomerId = "Bob", 
    Name = "Bob's wish list", 
    ShopName = "webShop", 
    Lines = new List<WishListLine>() {line}.AsReadOnly()
};
var wishLists = new Collection<WishList> { wishList };
var request = new EmailWishListsRequest(wishLists);
var result = wishListService.EmailWishLists(request);

GetWishListメソッド

GetWishListメソッドは、外部コマースシステムに対してウィッシュリストデータをクエリし、1つのウィッシュリストを返すために使用されます。

名前：	GetWishList (ゲットウィッシュリスト)
形容：	指定した条件に一致するウィッシュリストを取得します。 GetWishListパイプラインを呼び出します。
使い：	ウィッシュリストが必要なときに呼び出されます。たとえば、次のようなものがあります。ウィッシュリストIDとショップ名に基づいてユーザーのウィッシュリストを取得します。
署名：	GetWishListResult GetWishList(NotNullGetWishListRequestリクエスト)
インプット：
	ユーザーID –ウィッシュリストを所有するユーザーのID。
	WishListId – 検索されているウィッシュリストのID。
	ショップ名 – ウィッシュリストを含むストアの名前。
アウトプット：
	ウィッシュリスト – 検索条件に基づいて見つかったウィッシュリスト。
	システムメッセージ - 外部システムからのメッセージの収集。

使用例:

var wishListService = new WishListServiceProvider();
var createRequest = new CreateWishListRequest("Bob", "Bob's wish list", "webShop");
var wishList = wishListService.CreateWishList(createRequest).WishList;
var request = new GetWishListRequest("Bob", wishList.ExternalId, "webShop");
var result = wishListService.GetWishList(request);
Assert.AreEqual(wishList.Name, result.WishList.Name, "Names should be the same");

GetWishListsメソッド

GetWishListsメソッドは、外部のコマースシステムに対してウィッシュリストデータをクエリし、コレクションウィッシュリストを返すために使用されます。

名前：	GetWishLists(ゲットウィッシュリスト)
形容：	指定した条件に一致するウィッシュリストを取得します。 GetWishLists パイプラインを呼び出します。
使い：	ユーザーのすべてのウィッシュリストが必要な場合に呼び出されます。
署名：	GetWishListsResult GetWishLists(NotNullGetWishListsRequestリクエスト)
インプット：
	ユーザーID – 検索するユーザーのID。
	ショップ名 – ウィッシュリストを含むストア。
アウトプット：
	ReadOnlyCollection<WishListHeader>– 見つかったすべてのウィッシュリストのWishListHeaderオブジェクト。
	システムメッセージ - 外部システムからのメッセージの収集。

使用例:

var wishListService = new WishListServiceProvider();
var request = new GetWishListsRequest("Bob", "webShop");
var result = wishListService.GetWishLists(request);

UpdateWishListメソッド

UpdateWishListメソッドは、外部コマースシステムのウィッシュリストデータを更新し、更新されたウィッシュリストオブジェクトを返すために使用されます。

名前：	アップデートウィッシュリスト
形容：	指定したウィッシュリストを更新します。 UpdateWishListパイプラインを呼び出します。
使い：	ウィッシュリストを更新する必要があるときに呼び出されます。
署名：	GetCartsResult GetCarts(GetCartsRequestリクエスト)
インプット：
	ウィッシュリスト – 更新するウィッシュリスト。
アウトプット：
	ウィッシュリスト – 更新されたウィッシュリスト。
	システムメッセージ - 外部システムからのメッセージの収集。

使用例:

var wishListService = new WishListServiceProvider();
var createRequest = new CreateWishListRequest("Bob", "Bob's wish list", "webShop");
var wishList = wishListService.CreateWishList(createRequest).WishList;
wishList.IsFavorite = true;
var request = new UpdateWishListRequest(wishList);
var result = wishListService.UpdateWishList(request);

AddLinesToWishListメソッド

AddLinesToWishListメソッドは、外部コマースシステムのウィッシュリストに明細を追加し、更新されたウィッシュリストと追加された明細を返すために使用されます。

名前：	AddLinesToWishList (ウィッシュリストに追加)
形容：	指定した明細をウィッシュリストに追加します。 AddLinesToWishListパイプラインを呼び出します。
使い：	ウィッシュリストに品目を追加する必要がある場合に呼び出されます。
署名：	AddLinesToWishListResult AddLinesToWishList(NotNullAddLinesToWishListRequestリクエスト)
インプット：
	WishList - 明細項目を追加するウィッシュリスト。
	IEnumerable<WishListLine> – ウィッシュリストに追加する明細。
アウトプット：
	ウィッシュリスト – 更新されたウィッシュリストオブジェクト。 ReadOnlyCollection<WishListLine> - ウィッシュリストに追加された明細。
	システムメッセージ - 外部システムからのメッセージの収集。

使用例:

var wishListService = new WishListServiceProvider();
var createRequest = new CreateWishListRequest("Bob", "Bob's wish list", "webShop");
var wishList = wishListService.CreateWishList(createRequest).WishList;
var line = new WishListLine
{
    Product = new Entities.Carts.CartProduct
    {
        ProductId = "Product1", 
        Price = new Entities.Prices.Price((decimal)22.99, "USD")
    }, 
    Quantity = 1
};
var lines = new List<WishListLine> {line}.AsReadOnly();
var request = new AddLinesToWishListRequest(wishList, lines);
var result = wishListService.AddLinesToWishList(request);

RemoveWishListLinesメソッド

RemoveWishListLinesメソッドは、ウィッシュリストから特定の明細項目を削除し、更新されたウィッシュリストを返すために使用されます。

名前：	ウィッシュリストラインの削除
形容：	指定した条件に一致するウィッシュリストから広告申込情報を削除します。 RemoveWishListLinesパイプラインを呼び出します。
使い：	ウィッシュリストから明細を削除する必要がある場合に呼び出されます。
署名：	RemoveWishListLinesResult RemoveWishListLines(NotNullRemoveWishListLinesRequestリクエスト)
インプット：
	ウィッシュリスト – アイテムを削除する必要があるウィッシュリスト。
	IEnumerable<string> - 削除する明細項目のID。
アウトプット：
	ウィッシュリスト – 広告申込情報が削除されたウィッシュリスト。 ReadOnlyCollection<WishListLine> – ウィッシュリストから削除された明細。
	システムメッセージ - 外部システムからのメッセージの収集。

使用例:

var wishListService = new WishListServiceProvider();
var createRequest = new CreateWishListRequest("Bob", "Bob's wish list", "webShop");
var wishList = wishListService.CreateWishList(createRequest).WishList;
var line = new WishListLine
{
    Product = new Entities.Carts.CartProduct
    {
        ProductId = "Product1", 
        Price = new Entities.Prices.Price((decimal)22.99, "USD")
    }, 
    Quantity = 1
};
var line2 = new WishListLine
{
    Product = new Entities.Carts.CartProduct
    {
        ProductId = "Product2", 
        Price = new Entities.Prices.Price((decimal)33.77, "USD")
    }, 
    Quantity = 2
};
var lines = new List<WishListLine> { line, line2 };
var addLinesRequest = new AddLinesToWishListRequest(wishList, lines);
wishList = wishListService.AddLinesToWishList(addLinesRequest).WishList;
var request = new RemoveWishListLinesRequest(wishList, new List<string> { wishList.Lines[0].ExternalId });
var result = wishListService.RemoveWishListLines(request);

UpdateWishListLinesメソッド

UpdateWishListLinesメソッドは、外部コマースシステムのウィッシュリスト内の品目を更新し、更新されたウィッシュリストとそれに追加された品目を返すために使用されます。

名前：	UpdateWishListLinesの
形容：	ウィッシュリストの特定の明細を更新します。 UpdateWishListLines パイプラインを呼び出します。
使い：	ウィッシュリストの一部の品目を更新する必要がある場合に呼び出されます。
署名：	UpdateWishListLinesResult UpdateWishListLines(NotNullUpdateWishListLinesRequestリクエスト)
インプット：
	ウィッシュリスト –更新が必要な品目を含むウィッシュリスト。
	IEnumerable<WishListLine> – 更新するウィッシュリストアイテム。
アウトプット：
	ウィッシュリスト – 更新されたウィッシュリスト。 ReadOnlyCollection<WishListLine> – 更新されたウィッシュリストの項目。
	システムメッセージ - 外部システムからのメッセージの収集。

使用例:

var wishListService = new WishListServiceProvider();
var createRequest = new CreateWishListRequest("Bob", "Bob's wish list", "webShop");
var wishList = wishListService.CreateWishList(createRequest).WishList;
var line = new WishListLine
{
    Product = new Entities.Carts.CartProduct
    {
        ProductId = "Product1", 
        Price = new Entities.Prices.Price((decimal)22.99, "USD")
    }, 
    Quantity = 1
};
var lines = new List<WishListLine> { line };
var addLinesRequest = new AddLinesToWishListRequest(wishList, lines);
wishList = wishListService.AddLinesToWishList(addLinesRequest).WishList;
line = new WishListLine
{
    Product = new Entities.Carts.CartProduct
    {
        ProductId = "Product2", 
        Price = new Entities.Prices.Price((decimal)33.77, "USD")
    }, 
    Quantity = 2
};
lines = wishList.Lines.ToList();
lines.Add(line);
var request = new UpdateWishListLinesRequest(wishList, lines);
var result = wishListService.UpdateWishListLines(request);

PrintWishListメソッド

PrintWishListメソッドは、ユーザーがウィッシュリストを印刷しようとしたときにページイベントを発生させるために使用されます。

名前：	PrintWishList(プリントウィッシュリスト)
形容：	指定した条件に一致するウィッシュリストを取得します。 PrintWishListパイプラインを呼び出します。
使い：	ウィッシュリストのコピーが印刷に必要な場合に呼び出されます。
署名：	PrintWishListResult PrintWishList(NotNull PrintWishListRequestリクエスト)
インプット：
	ウィッシュリスト – 印刷に必要なウィッシュリスト。
アウトプット：
	ウィッシュリスト – 印刷用のウィッシュリスト
	システムメッセージ - 外部システムからのメッセージの収集。

使用例:

var wishListService = new WishListServiceProvider();
var line = new WishListLine
{
    Product = new Entities.Carts.CartProduct
    {
        ProductId = "Product1", 
        Price = new Entities.Prices.Price((decimal)22.99, "USD")
    }, 
    Quantity = 1
};
var wishList = new WishList
{
    CustomerId = "Bob", 
    Name = "Bob's wish list", 
    ShopName = "webShop", 
    Lines = new List<WishListLine>() { line }.AsReadOnly()
};
var request = new PrintWishListRequest(wishList);
var result = wishListService.PrintWishList(request);

この記事を改善するための提案がある場合は、お知らせください!