メタデータ API 開発者ガイド
jIndustriesLoyaltySettings
Metadata メタデータ型を拡張し、その fullName 項目を継承します。
パッケージマニフェストでは、Settings の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
IndustriesLoyaltySettings の値は、settings フォルダの IndustriesLoyalty.settings という 1 つのファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
IndustriesLoyaltySettings コンポーネントは、API バージョン 53.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| enableAutomaticVoucherCodeGeneration | boolean | バウチャーコードを自動的に生成する機能が有効化されているか (true)、否か (false) を示します。この項目は、API バージョン 57.0 以降で使用できます。 |
| enableNQPRealTimePointBalance | boolean | メンバーの対象外ポイント残高をリアルタイムで更新する機能が組織���有効化されているか (true)、無効化されているか (false) を示します。デフォルト値は true です。 |
| enableFixedTypeNQPAggregation | boolean | 固定種別対象外ポイントを一括で集計して期限切れにする機能が組織で有効化されているか (true)、無効化されているか (false) を示します。デフォルト値は true です。この項目は、API バージョン 54.0 以降で使用できます。 |
| enableNonQualifyingPointsConsolidation | boolean | 固定種別対象外ポイントをリアルタイムで集計して期限切れにする機能が組織で有効化されているか (true)、無効化されているか (false) を示します。デフォルト値は true です。この項目は、API バージョン 58.0 以降で使用できます。 |
| enableQPRealTimePointBalance | boolean | 対象ポイント残高のリアルタイム更新機能が組織で有効化されているか (true)、無効化されているか (false) を示します。デフォルト値は true です。この項目は、API バージョン 55.0 以降で使用できます。 |
| enableLoyaltyRulesVerifyCdpMemberSegment | boolean | 次のいずれかとなります。
デフォルト値は false です。この項目は、API バージョン 55.0 以降で使用できます。 |
| enableLoyaltyRedeemedPointsExpirationInfoPref | boolean | 利用がキャンセルされたためにメンバーに戻されたポイントの有効期限を自動的に計算して追加する機能が組織で有効化されているか (true)、無効化されているか (false) を示します。デフォルト値は true です。この項目は、API バージョン 55.0 以降で使用できます。 |
| enableLoyaltyServiceExcellence | boolean | ロイヤルティ管理のサービスコンソールが組織で有効化されているか (true)、無効化されているか (false) を示します。デフォルト値は false です。この項目は、API バージョン 57.0 以降で使用できます。 |
| enableLoyaltyApiAccessForExternalSiteUsers | boolean | Experience Cloud サイトで顧客がロイヤルティプログラムへの参加や離脱を行ったり、メンバーがプロモーションへの参加やオプトアウトを行ったりできるようにする機能が組織で有効化されているか (true)、無効化されているか (false) を示します。デフォルト値は false です。この項目は、API バージョン 58.0 以降で使用できます。 |
| enableAutomaticMemberTierAssessmentSelection | boolean | メンバーの対象ポイント残高が変化したときにメンバーをランク評価の対象として自動的に選択する機能が組織で有効化されているか (true)、無効化されているか (false) を示します。デフォルト値は false です。この項目は、API バージョン 58.0 以降で使用できます。 |
宣言的なメタデータの定義のサンプル
IndustriesLoyaltySettings コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<IndustriesLoyaltySettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <enableAutomaticVoucherCodeGeneration>true</enableAutomaticVoucherCodeGeneration>
4 <enableNQPRealTimePointBalance>false</enableNQPRealTimePointBalance>
5...<enableNonQualifyingPointsConsolidation>true</enableNonQualifyingPointsConsolidation>
6 <enableFixedTypeNQPAggregation>true</enableFixedTypeNQPAggregation>
7 <enableQPRealTimePointBalance>true</enableQPRealTimePointBalance>
8 <enableLoyaltyRulesVerifyCdpMemberSegment>false</enableLoyaltyRulesVerifyCdpMemberSegment>
9 <enableLoyaltyRedeemedPointsExpirationInfoPref>true</enableLoyaltyRedeemedPointsExpirationInfoPref>
10...<enableLoyaltyServiceExcellence>false</enableLoyaltyServiceExcellence>
11...<enableLoyaltyApiAccessForExternalSiteUsers>false</enableLoyaltyApiAccessForExternalSiteUsers>
12...<enableAutomaticMemberTierAssessmentSelection>true</enableAutomaticMemberTierAssessmentSelection>
13</IndustriesLoyaltySettings>前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>IndustriesLoyalty</members>
5 <name>Settings</name>
6 </types>
7 <version>53.0</version>
8</Package>マニフェストファイル内のワイルドカードのサポート
package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) は、機能設定のメタデータ型には適用されません。ワイルドカードは、個々の設定ではなくすべての設定を取得するときにのみ適用されます。詳細は、「設定」を参照してください。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。