---
title: "ロイヤルティプログラムとカードパイプライン"
slug: "loyalty-programs-and-cards-pipelines"
abstract: ""
---
# ロイヤルティプログラムとカードパイプライン

ロイヤルティプログラムおよびカードAPIで使用される統合および関与ロジックは、必要に応じてカスタマイズ可能なパイプラインによって実装されています。API上には各メソッドごとにパイプラインがあります。

## GetLoyaltyProgramパイプライン

**名前:**

ゲットロイヤルティプログラム

**説明:**

ショップやショップ内のユーザー向けの特定のロイヤルティプログラムを手に入れます。

**使用方法:**

ロイヤルティプログラムを探す際にConnect APIの GetLoyaltyProgram 方式で呼び出されます。

**ARGS:**

\*\*リクエスト -\*\*検索条件:UserID、ShopName、ProgramIDを含む。パイプラインを呼び出す前に設定される。

\*\*Response -\*\*LoyaltyProgramオブジェクトを含みます。パイプライン実行後に読み込まれます。

**プロセッサー:**

デフォルトのプロセッサーはありません。

## GetLoyaltyProgramsパイプライン

**名前:**

ゲットロイヤルティプログラム

**説明:**

ショップやショップ内のユーザー向けのロイヤルティプログラムのコレクションを手に入れます。

**使用方法:**

ロイヤルティプログラムを探す際にConnect APIの GetLoyaltyPrograms 方式で呼び出されます。

**ARGS:**

\*\*リクエスト -\*\*検索条件を含む:ShopName、UserId。パイプラインを呼び出す前に設定されます。

\*\*Response -\*\*LoyaltyProgramSummaryオブジェクトのコレクションを含みます。パイプライン実行後に読み込まれます。

**プロセッサー:**

デフォルトのプロセッサーはありません。

## GetLoyaltyProgramStatus pipeline

**名前:**

GetLoyaltyProgramStatus

**説明:**

ロイヤルティカードやカードに関連付けられている特定のプログラムのステータスを取得します。

**使用方法:**

プログラムのステータスを検索する際にConnect APIの GetLoyaltyProgramStatus メソッドで呼び出されました。

**ARGS:**

\*\*Request -\*\*検索条件を含む:LoyaltyCardオブジェクトとプログラムIDのリスト。パイプラインを呼び出す前に設定されます。

**Response**–LoyaltyProgramStatusオブジェクトの集合です。パイプライン実行後に読み込まれます。

**プロセッサー:**

デフォルトのプロセッサーはありません。

## JoinLoyaltyProgramパイプライン

**名前:**

JoinLoyaltyProgram

**説明:**

ユーザーを店舗内の全プログラムまたは特定のプログラムに参加します。

**使用方法:**

ユーザーをプログラムに結合しようとする際に、Connect APIの JoinLoyaltyProgram メソッドで呼び出されます。

**ARGS:**

\*\*Request -\*\*検索条件:userId、shopName、programIdを含む。パイプラインを呼び出す前に設定される。

**レスポン**ス\*\*–\*\*LoyaltyCardオブジェクト。パイプライン実行後に読み出されます。

**プロセッサー:**

**TriggerLoyaltyProgramJoinedGoal**\*\*–\*\*Triggers the Loyalty Program Join Goal  
  
**AddVisitorToEaPlan** – ロイヤルティプログラムに参加するためにユーザーをEAPに追加します。

## GetLoyaltyCardsパイプライン

**名前:**

ゲットロイヤルティカード

**説明:**

店舗のユーザー用ロイヤルティカードや特定のカードを入手します。

**使用方法:**

カードの取得を試みる際にConnect APIの GetLoyaltyCards メソッドで呼び出されます。

**ARGS:**

\*\*リクエスト -\*\*検索条件:UserID、ShopName、CardIdを含む。パイプラインを呼び出す前に設定される。

\*\*レスポンス -\*\*LoyaltyCardオブジェクトのコレクションを含みます。パイプライン実行後に読み込まれます。

**プロセッサー:**

デフォルトのプロセッサーはありません。

## GetLoyaltyCardTransactionsパイプライン

**名前:**

GetLoyaltyCardTransactions

**説明:**

特定のカードのすべての取引を取得できます。

**使用方法:**

ステータス取得時にConnect APIの GetLoyaltyCardTransactions 方式で呼び出しました。

**ARGS:**

\*\*リクエスト -\*\*検索条件を含む:LoyaltyCard。パイプラインを呼び出す前に設定されます。

\*\*Response -\*\*LoyaltyCardTransactionオブジェクトのコレクションを含みます。パイプライン実行後に読み取られます。

**プロセッサー:**

デフォルトのプロセッサーはありません。