ロイヤルティプログラムとカードサービスプロバイダー

Version:

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

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

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

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

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

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

GetLoyaltyProgramメソッド

GetLoyaltyProgramメソッドは、外部のコマースシステムに対して特定の忠実なプログラムを照会するために使用されます。

名前：	GetLoyaltyProgram(ロイヤリティプログラム)
形容：	指定した条件に一致するロイヤルティプログラムを取得します。 GetLoyaltyProgramパイプラインを呼び出します。
使い：	特定のロイヤルティプログラムが必要な場合に呼び出されます。たとえば、次のようなものがあります。特定のショップとプログラムIDのプログラムを取得します。特定のショップ、プログラムID、およびユーザーのプログラムを取得します。
署名：	GetLoyaltyProgramResult GetLoyaltyProgram(NotNullGetLoyaltyProgramRequestリクエスト)
インプット：
	UserId - オプション - カートを取得するユーザーのID。値を指定しない場合、カートの取得時にユーザー IDは考慮されません。
	プログラムID – 必要なプログラムのIDが返されます。
	ショップ名 – 随意。カートを検索するショップの名前。
アウトプット：
	LoyaltyProgram – 要求されたロイヤルティプログラム。オブジェクトは、要求で指定された基準に一致するプログラムを表します。
	システムメッセージ - 外部システムからのメッセージの収集。

使用例:

var loyaltyProgramService = new LoyaltyProgramServiceProvider();
var request = new GetLoyaltyProgramRequest("myShop", "John");
var result = loyaltyProgramService.GetLoyaltyProgram(request);

GetLoyaltyProgramsメソッド

GetLoyaltyProgramsメソッドは、外部コマースシステムに対してロイヤルティプログラムの一覧を照会するために使用されます。

名前：	GetLoyaltyPrograms (ロイヤリティプログラム)
形容：	指定した条件に一致するロイヤルティプログラムを取得します。 GetLoyaltyProgramsパイプラインを呼び出します。
使い：	ロイヤルティプログラムのリストが必要な場合に呼び出されます。たとえば、次のようなものがあります。ショップのプログラムを取得する。特定のショップのユーザー向けのプログラムを取得する。
署名：	GetLoyaltyProgramsResult GetLoyaltyPrograms(NotNullGetLoyaltyProgramsRequestリクエスト)
インプット：
	UserId – オプション - 返された関連プログラムのユーザーのID。
	ショップ名 – カートを検索するショップの名前
アウトプット：
	ReadOnlyCollection<LoyaltyProgramSummary> – LoyaltyProgramSummaryオブジェクトのコレクションリストは、要求で指定された基準に一致するプログラムを表します。
	システムメッセージ - 外部システムからのメッセージの収集。

使用例:

var loyaltyProgramService = new LoyaltyProgramServiceProvider();
var request = new GetLoyaltyProgramsRequest("myShop", "John");
var result = loyaltyProgramService.GetLoyaltyPrograms(request);

GetLoyaltyProgramStatusメソッド

GetCartsは、外部コマースシステムに対してカートデータをクエリするために使用され、カートのコレクションではなく、メインカートデータの概要のみを含むCartBaseオブジェクトのコレクションを返します。

名前：	GetLoyaltyProgramStatus(ロイヤリティプログラムステータス)
形容：	すべてのプログラムまたは特定のプログラムに対するロイヤルティカードの状態を取得します。 GetLoyaltyProgramStatusパイプラインを呼び出します。
使い：	ポイントカードプログラムの状態が必要な場合に呼び出されます。たとえば、次のようなものがあります。すべてのプログラムに対するポイントカードのステータスを取得します。特定のプログラムに対するポイントカードのステータスを取得する。
署名：	GetLoyaltyProgramStatusResult GetLoyaltyProgramStatus(NotNullGetLoyaltyProgramStatusRequestリクエスト)
インプット：
	LoyaltyCard:ステータスを確認するポイントカード。
	ProgramIds – オプション – ステータスを確認するプログラムIDのオプションのリスト。
アウトプット：
	ReadOnlyCollection<LoyaltyProgramStatus> – 特定のプログラムに対するステータスのコレクション。
	システムメッセージ - 外部システムからのメッセージの収集。

使用例:

var loyaltyProgramService = new LoyaltyProgramServiceProvider();
var loyaltyCard = new LoyaltyCard
{
    CardNumber = "1234567890", 
    CustomerId = "John", 
    ProgramIds = new List<string>(new List<string> {"ProgamId1"})
};
var request = new GetLoyaltyProgramStatusRequest(loyaltyCard);
var result = loyaltyProgramService.GetLoyaltyProgramStatus(request);

JoinLoyaltyProgramメソッド

JoinLoyaltyProgramメソッドは、外部コマースシステムのロイヤルティプログラムにユーザーを追加するために使用されます。

名前：	JoinLoyaltyProgram(ロイヤリティプログラムに参加)
形容：	指定した条件でユーザーをロイヤルティプログラムに参加させます。 JoinLoyaltyProgramパイプラインを呼び出します。
使い：	ユーザーがロイヤルティプログラムに参加する必要があるときに呼び出されます。たとえば、次のようなものがあります。ストア内のすべてのロイヤルティプログラムにユーザーを参加させます。ストア内の特定のロイヤルティプログラムにユーザーを参加させます。
署名：	JoinLoyaltyProgramResult JoinLoyaltyProgram(NotNullJoinLoyaltyProgramRequestリクエスト)
インプット：
	UserId - プログラムに参加する必要があるユーザーのID。
	ShopName – ユーザーがプログラムに登録しているショップ。
	ProgramId – オプション。ユーザーを追加するプログラム。
アウトプット：
	ロイヤルティカード – プログラムで作成されたロイヤルティカード。
	システムメッセージ - 外部システムからのメッセージの収集。

使用例:

var loyaltyProgramService = new LoyaltyProgramServiceProvider();
var request = new JoinLoyaltyProgramRequest("Rob", "webShop");
var result = loyaltyProgramService.JoinLoyaltyProgram(request);
var loyaltyCard = result.LoyaltyCard;

GetLoyaltyCardsメソッド

GetLoyaltyCardsメソッドは、ロイヤルティカードのコレクションを返すために使用されます。

名前：	GetLoyaltyカード
形容：	指定した条件に一致するポイントカードを取得します。 GetLoyaltyCardsパイプラインを呼び出します。
使い：	ポイントカードのリストまたは1つのポイントカードが必要な場合に呼び出されます。たとえば、次のようなものがあります。ストアでユーザーのすべてのカードを取得します。店舗でユーザー用の特定のカードを取得します。
署名：	GetLoyaltyCardsResult GetLoyaltyCards(NotNullGetLoyaltyCardsRequestリクエスト)
インプット：
	UserId- カードを取得するユーザーのID。
	ショップネーム - カードを検索するショップの名前。
	CardId – オプション - 特定のカードを探している場合のカードのID。
アウトプット：
	ReadOnlyCollection<LoyaltyCard> – 指定した条件に一致するカードが見つかりました。
	システムメッセージ - 外部システムからのメッセージの収集。

使用例:

var loyaltyProgramService = new LoyaltyProgramServiceProvider();
var request = new GetLoyaltyCardsRequest("Rob", "WebShop");
var result = loyaltyProgramService.GetLoyaltyCards(request);

GetLoyaltyCardTransactionsメソッド

GetLoyaltyCardTransactionsメソッドは、特定のカードのトランザクションのリストを返します。

名前：	GetLoyaltyCardトランザクション
形容：	指定した条件に一致するトランザクションの一覧を取得します。 GetLoyaltyCardTransactionsパイプラインを呼び出します。
使い：	カードのトランザクションの一覧が必要な場合に呼び出されます。
署名：	GetLoyaltyCardTransactionsResult GetLoyaltyCardTransactions(NotNullGetLoyaltyCardTransactionsRequestリクエスト)
インプット：
	LoyaltyCard – トランザクションを取得するロイヤルティカード。
アウトプット：
	ReadOnlyCollection<LoyaltyCardTransaction> – カードのトランザクションのコレクション。
	システムメッセージ - 外部システムからのメッセージの収集。

使用例:

var loyaltyProgramService = new LoyaltyProgramServiceProvider();
            
var loyaltyCard = new LoyaltyCard
{
    CardNumber = "1234567890", 
    CustomerId = "Mike", 
    ProgramIds = new List<string> {"ProgamId1"}
};
var request = new GetLoyaltyCardTransactionsRequest(loyaltyCard);
var result = loyaltyProgramService.GetLoyaltyCardTransactions(request);

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