LoyaltyProgramSetup | メタデータ API 開発者ガイド

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

ファイルのサフィックスおよびディレクトリの場所

LoyaltyProgramSetup コンポーネントのサフィックスは loyaltyProgramSetup で、loyaltyProgramSetups フォルダに保存されます。

バージョン

LoyaltyProgramSetup コンポーネントは、API バージョン 54.0 以降で使用できます。

特別なアクセスルール

このメタデータ型を使用するには、組織で B2C - Loyalty、B2C - Loyalty Plus、Loyalty Management - Growth、または Loyalty Management - Advanced のいずれかのライセンスが有効になっている必要があります。

項目

項目名	説明
label	項目の型 string 説明プログラムプロセスが関連付けられているロイヤルティプログラムの名前。指定された名前のロイヤルティプログラムが存在しない場合、新しい LoyaltyProgram レコードが作成されます。ロイヤルティプログラムの名前には、少なくとも 1 つの英数字が含まれている必要があります。
programProcesses	項目の型 LoyaltyProgramProcess[] 説明ロイヤルティプログラムに関連付けられたロイヤルティプログラムプロセスのコレクション。

項目名

説明

label

項目の型: string
説明: プログラムプロセスが関連付けられているロイヤルティプログラムの名前。指定された名前のロイヤルティプログラムが存在しない場合、新しい LoyaltyProgram レコードが作成されます。ロイヤルティプログラムの名前には、少なくとも 1 つの英数字が含まれている必要があります。

programProcesses

項目の型: LoyaltyProgramProcess[]
説明: ロイヤルティプログラムに関連付けられたロイヤルティプログラムプロセスのコレクション。

LoyaltyProgramProcess

ロイヤルティプログラムプロセスに関連する項目のコレクションを表します。

項目名	説明
description	項目の型 string 説明ロイヤルティプログラムプロセスの説明。
executionType	項目の型 LoyaltyPgmProcExecutionType (string 型の列挙) 説明ロイヤルティプログラムプロセスでの取引記録の処理モード。値は次のとおりです。 `Batch` `BatchAndRealTime` `RealTime`
journalSubType	項目の型 string 説明ロイヤルティプログラムプロセスで処理される取引記録のサブタイプ。
journalType	項目の型 string 説明ロイヤルティプログラムプロセスで処理される取引記録の種別。記録種別として [獲得] または [償還] を入力できます。
loyaltyTierGroup	項目の型 string 説明ロイヤルティプログラムの階層グループ。この項目は、API バージョン 56.0 以降で使用できます。
parameters	項目の型 LoyaltyProgramProcessParameter[] 説明ロイヤルティプログラムに関連付けられたパラメータ。
processName	項目の型 string 説明必須。ロイヤルティプログラムプロセスの名前。
processType	項目の型 string 説明必須。ロイヤルティプログラムプロセスで処理されるレコードのタイプ。
rules	項目の型 LoyaltyProgramProcessRule[] 説明ロイヤルティプログラムプロセスに関連付けられたルール。
status	項目の型 LoyaltyPgmProcStatus (string 型の列挙) 説明ロイヤルティプログラムプロセスの状況。値は次のとおりです。 `Active` `Draft` `Inactive` 取引記録を処理できるのは、有効なプログラムプロセスのみです。メモ

LoyaltyProgramProcessParameter

プログラムプロセスに関連付けられているパラメータに関連する項目のコレクションを表します。パラメータはルールで使用される動的値または固定値です。パラメータの値はその種別とデータ型に基づいて定義できます。

項目名	説明
condition	項目の型 LoyaltyProgramProcessCondition 説明パラメータに保存するレコードを決定する検索条件。
dataType	項目の型 LoyaltyPgmProcParmDataType (string 型の列挙) 説明パラメータのデータ型。パラメータに保存できる値の型を決定します。値は次のとおりです。 `Boolean` `Date` `DateTime` `Numeric` `Sobject` `Text`
decimalPlaces	項目の型 int 説明パラメータの種別が Variable (変数) でデータ型�� Numeric (数値) の場合にパラメータでサポートされる小数点以下の桁数。
description	項目の型 string 説明パラメータの説明。
isCollection	項目の型 boolean 説明パラメータの種別が Variable (変数) の場合にパラメータに複数の値を保存できるかどうかを示します。
isInput	項目の型 boolean 説明パラメータをロイヤルティプログラムプロセスの外部で入力として使用できるかどうかを示します。
isOutput	項目の型 boolean 説明パラメータをロイヤルティプログラムプロセスの外部で出力として使用できるかどうかを示します。
objectName	項目の型 string 説明パラメータの種別が Variable (変数) でデータ型が sObject の場合にパラメータで保存されるレコードのオブジェクトの名前。
parameterName	項目の型 string 説明必須。パラメータの名前。
parameterType	項目の型 LoyaltyPgmProcParmType (string 型の列挙) 説明パラメータに保存できる値の種別。値は次のとおりです。 `Constant` `Formula` `Variable`
value	項目の型 string 説明パラメータの種別が Variable (変数) または Formula (数式) でデータ型が sObject ではない場合のパラメータの値。

LoyaltyProgramProcessCondition

条件に関連する項目のコレクションを表します。条件により、パラメータに保存するレコードを絞り込んだり、取引記録に対して子アクションをトリガする必要があるかどうかを確認したりします。

項目名	説明
conditionCriteria	項目の型 string 説明必須。レコードまたは取引記録によって条件がいつ満たされるかを決定する条件。
conditionFilterCriteria	項目の型 LoyaltyProgramProcessConditionFilterCriteria[] 説明絞り込むレコードまたは取引記録を決定する検索条件。
conditionName	項目の型 string 説明必須。条件の名前。

LoyaltyProgramProcessConditionFilterCriteria

条件に含まれる検索条件に関連する項目のコレクションを表します。条件には複数の検索条件を追加できます。検索条件により、関連する条件で絞り込まれるレコードが決まります。

項目名	説明
operator	項目の型 LoyaltyPgmProcCondOperator (string 型の列挙) 説明必須。検索条件の演算子。値は次のとおりです。 `Contains` `DoesNotContain` `EndsWith` `Equals` `GreaterThan` `GreaterThanOrEquals` `IsNotNull` `IsNull` `LessThan` `LessThanOrEquals` `NotEquals` `StartsWith`
sequence	項目の型 int 説明必須。条件内の検索条件の連番。
sourceFieldName	項目の型 string 説明必須。検索条件で使用される項目の名前。
value	項目の型 string 説明検索条件の値。
valueType	項目の型 LoyaltyPgmProcCondType (string 型の列挙) 説明必須。検索条件で指定される値の種別。値は次のとおりです。 `Formula` `Literal` `Lookup` `Parameter`

LoyaltyProgramProcessRule

ルールに関連する項目のコレクションを表します。ルールは一連の条件とアクションで構成されます。

項目名	説明
actions	項目の型 LoyaltyProgramProcessAction[] 説明ルールに関連付けられたアクション。
conditions	項目の型 LoyaltyProgramProcessCondition[] 説明ルールに関連付けられた条件。
description	項目の型 string 説明ルールの説明。
endDate	項目の型 date 説明ルールでの取引記録の処理を終了する日付。
previousRule	項目の型 string 説明現在のルールの前に新規取引記録を処理するルール。現在のルールは、前のルールで取引記録の処理が完了するとトリガされます。
promotion	項目の型 string 説明ルールに関連付けられたプロモーション。プロモーションがルールに関連付けられている場合、プロモーションの開始日、終了日、状況によってルールの対応する項目が決まります。
ruleName	項目の型 string 説明必須。ルールの名前。
startDate	項目の型 date 説明ルールでの取引記録の処理を開始する日付。
status	項目の型 LoyaltyPgmProcRuleStatus (string 型の列挙) 説明ルールの状況。値は次のとおりです。 `Active` `Draft` `Inactive`
stepMappings	項目の型 LoyaltyProgramProcessRuleStepMapping[] 説明ルールに関連付けられたステップ対応付けのリスト。

LoyaltyProgramProcessAction

アクションに関連する項目のコレクションを表します。

項目名	説明
actionName	項目の型 string 説明必須。アクションの名前。
actionParameters	項目の型 LoyaltyProgramProcessActionParameter[] 説明アクションのパラメータ。
actionType	項目の型 LoyaltyPgmProcActionType (string 型の列挙) 説明必須。アクションの種別。可能な値は次のとおりです。 `AssignParameterValues` — パラメータに値を割り当てます。 `AssignBadgeToMember` — ロイヤルティプログラムメンバーにバッジを割り当てます。この値は API バージョン 56.0 以降で使用できます。 `Crud` — 対象オブジェクトのレコードを作成または更新します。この値は API バージョン 56.0 以降で使用できます。 `CheckMemberBadgeAssignment` — ロイヤルティプログラムメンバーにバッジが割り当てられたかどうかを確認します。この値は API バージョン 56.0 以降で使用できます。 `ChangeMemberTier` — ロイヤルティプログラムメンバーの階層を変更します。この値は API バージョン 56.0 以降で使用できます。 `CreditPoints` — ルールで処理された取引記録に関連付けられているロイヤルティプログラムメンバーにポイントをクレジット処理します。 `CreditPoints` — ルールで処理された取引記録に関連付けられているロイヤルティプログラムメンバーのポイント残高からポイントをデビット処理します。 `GetMemberAttributesValues` — 選択したエンゲージメント属性に対するロイヤルティプログラムメンバーの属性値の詳細を取得します。この値は、API バージョン 55.0 以降で使用できます。 `GetMemberPointBalance` — ロイヤルティプログラムメンバーのポイント残高を取得します。 `GetMemberPromotions` — ロイヤルティプログラムメンバーのプロモーションを取得します。この値は API バージョン 56.0 以降で使用できます。 `GetMemberTier` — ロイヤルティプログラムメンバーの階層の詳細を取得します。 `GetOutputsFromDecisionTable` — 決定表で提供される出力を取得します。この値は API バージョン 56.0 以降で使用できます。累積プロモーションの達成に向けたロイヤルティプログラムメンバーの使用量に、指定された値を加えます。 `IncreaseUsageForCumulativePromotion` — 累積プロモーションのロイヤルティプログラムメンバーの使用量を増やします。 `IssueVoucher` — ルールで処理された取引記録に関連付けられているロイヤルティプログラムメンバーにバウチャーを発行します。 `RedeemVoucher` — ルールで処理された取引記録に関連付けられているロイヤルティプログラムメンバーのバウチャーを利用します。この値は、API バージョン 58.0 以降で使用できます。累積プロモーションの達成に向けたロイヤルティプログラムメンバーの使用量を、指定された値で更新します。 `RunFlow` — フローを実行します。 `RunProgramProcess` — 有効なロイヤルティプログラムプロセスをサブプロセスとして実行します。この値は API バージョン 56.0 以降で使用できます。 `SendMail` — 紹介プログラムのさまざまなステージでロイヤルティプログラムメンバーおよびロイヤルティプログラムメンバーが紹介する人にメールを送信します。この値は、API バージョン 58.0 以降で使用できます。 `UpdateCurrentValueForMemberAttribute` — 選択したエンゲージメント属性に対するロイヤルティプログラムメンバーの現在の属性値を更新します。この値は、API バージョン 55.0 以降で使用できます。 `UpdatePointBalance` — ルールで処理された取引記録に関連付けられているロイヤルティプログラムメンバーのポイント残高を更新します。 `UpdateUsageForCumulativePromotion` — 累積プロモーションのロイヤルティプログラムメンバーの使用量を更新します。
crudActionType	項目の型 LoyaltyPgmProcCrudActType (string 型の列挙) 説明アクションで対象オブジェクトレコードに対して実行する操作の種別。この項目は、API バージョン 56.0 以降で使用できます。この項目は、actionType 項目値が `CRUD` の場合は必須です。メモ可能な値は次のとおりです。 `create` `update`
decisionTable	項目の型 string 説明ルールで処理された取引記録に対するアクションにより呼び出される決定。
decisionTableDatasetLink	項目の型 string 説明選択された決定表に関連付けられているデータセットリンク。
entityApiName	項目の型 string 説明対象オブジェクトの API 参照名。この項目は、API バージョン 56.0 以降で使用できます。この項目は、actionType 項目値が `CRUD` の場合は必須です。メモ
flowDefinition	項目の型 string 説明ルールで処理された取引記録に対するアクションにより実行されるフロー。選択されたフローの種別は LoyaltyManagementFlow である必要があります。
loyaltyProgramProcess	項目の型 string 説明アクションによって実行されるサブプログラムプロセス。この項目は、API バージョン 56.0 以降で使用できます。この項目は、actionType 項目値が `RunProgramProcess` の場合は必須です。メモ

LoyaltyProgramProcessActionParameter

アクションパラメータに関連する項目のコレクションを表します。パラメータはアクションの入力または出力です。入力パラメータにはアクションで使用される値が保存されます。出力パラメータにはアクションの結果が保存されます。

項目名	説明
operator	項目の型 LoyaltyPgmProcActParamOper (string 型の列挙) 説明アクションで使用される演算子の種別。この項目は、API バージョン 56.0 以降で使用できます。可能な値は次のとおりです。 `Equals`
parameterName	項目の型 string 説明必須。パラメータの名前。パラメータ名は、関連付けられたアクションの種別に応じてサポートされる入力または出力項目と同じである必要があります。
sequenceNumber	項目の型 int 説明アクションのパラメータの連番。この項目は、API バージョン 56.0 以降で使用できます。
value	項目の型 string 説明必須。パラメータの値。
valueType	項目の型 LoyaltyPgmProcActParamType (string 型の列挙) 説明パラメータで提供する値の種別。この項目は、API バージョン 56.0 以降で使用できます。可能な値は次のとおりです。 `Literal` — 定数値。 `Parameter` — パラメータを使用して渡されるランタイム値。

LoyaltyProgramProcessRuleStepMapping

ステップ対応付けに関連する項目のコレクションを表します。子アクションを持つ条件を対応付けたり、親ステップを持たないアクションを対応付けたりします。

項目名	説明
associatedStep	項目の型 string 説明必須。対応付けに関連付けられたアクション。
parentStep	項目の型 string 説明 1 つ以上の子アクションが含まれる条件。
sequence	項目の型 int 説明必須。ルール内の対応付けの連番。

宣言的なメタデータの定義のサンプル

LoyaltyProgramSetup コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<LoyaltyProgramSetup xmlns="http://soap.sforce.com/2006/04/metadata">
3    <label>Cloud Kicks Inner Circle</label>
4    <programProcesses>
5        <executionType>RealTime</executionType>
6        <parameters>
7            <dataType>Numeric</dataType>
8            <decimalPlaces>0</decimalPlaces>
9            <isCollection>false</isCollection>
10            <isInput>false</isInput>
11            <isOutput>false</isOutput>
12            <parameterName>VoucherValue</parameterName>
13            <parameterType>Constant</parameterType>
14            <value>50</value>
15        </parameters>
16        <processName>Issue Vouchers</processName>
17        <processType>Transaction Journal</processType>
18        <rules>
19            <actions>
20                <actionName>Issue High Transaction Value Voucher</actionName>
21                <actionParameters>
22                    <operator>Equals</operator>
23                    <parameterName>VoucherDefinitionName</parameterName>
24                    <sequenceNumber>1</sequenceNumber>
25                    <value>Voucher for High Value Transactions</value>
26                    <valueType>Literal</valueType>
27                </actionParameters>
28                <actionParameters>
29                    <operator>Equals</operator>
30                    <parameterName>VoucherCode</parameterName>
31                    <sequenceNumber>2</sequenceNumber>
32                    <value>{!TransactionJournal.Order.Id}</value>
33                </actionParameters>
34                <actionParameters>
35                    <operator>Equals</operator>
36                    <parameterName>VoucherEffectiveDate</parameterName>
37                    <sequenceNumber>3</sequenceNumber>
38                    <value>DATEVALUE(&quot;2021-11-21 00:00:00&quot;)</value>
39                </actionParameters>
40                <actionParameters>
41                    <operator>Equals</operator>
42                    <parameterName>VoucherExpirationDate</parameterName>
43                    <sequenceNumber>4</sequenceNumber>
44                    <value>DATEVALUE(&quot;2022-01-01 00:00:00&quot;)</value>
45                </actionParameters>
46                <actionParameters>
47                    <operator>Equals</operator>
48                    <parameterName>VoucherFaceValue</parameterName>
49                    <sequenceNumber>5</sequenceNumber>
50                    <value>{!VoucherValue}</value>
51                </actionParameters>
52                <actionType>IssueVoucher</actionType>
53            </actions>
54            <conditions>
55                <conditionCriteria>1</conditionCriteria>
56                <conditionFilterCriteria>
57                    <operator>GreaterThanOrEquals</operator>
58                    <sequence>1</sequence>
59                    <sourceFieldName>TransactionJournal.TransactionAmount</sourceFieldName>
60                    <value>100</value>
61                    <valueType>Literal</valueType>
62                </conditionFilterCriteria>
63                <conditionName>New Condition</conditionName>
64                <conditionType>Condition</conditionType>
65            </conditions>
66            <endDate>2022-01-01</endDate>
67            <ruleName>Issue Voucher for Transactions Above $100</ruleName>
68            <startDate>2021-11-21</startDate>
69            <status>Draft</status>
70            <stepMappings>
71                <associatedStep>New Condition</associatedStep>
72                <sequence>1</sequence>
73            </stepMappings>
74            <stepMappings>
75                <associatedStep>Issue High Transaction Value Voucher</associatedStep>
76                <parentStep>New Condition</parentStep>
77                <sequence>1</sequence>
78            </stepMappings>
79        </rules>
80        <status>Draft</status>
81    </programProcesses>
82</LoyaltyProgramSetup>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3   ~ Copyright 2020 Salesforce, Inc.
4   ~ All Rights Reserved
5   ~ Company Confidential
6-->
7<Package xmlns="http://soap.sforce.com/2006/04/metadata">
8   <types>
9      <members>*</members>
10      <name>LoyaltyProgramSetup</name>
11   </types>
12   <version>54.0</version>
13</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。