この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

tpm-promotion コンポーネントの参照

この Lightning Web コンポーネントは、TPM プロモーションを読み込むサービスコンポーネントです。TPM プロモーションを読み込むことによって、プロモーションの状態を更新するメソッドを公開するほか、プロモーションの状態が変化したときにイベントを生成し、プロモーションページのすべての UI コンポーネントを同期します。このコンポーネントは、リリースされた管理パッケージの一部として提供される Lightning Web コンポーネントです。

この Consumer Goods Cloud トレードプロモーション管理ドキュメントの内容は、機密扱いとなっており、Salesforce が承認した顧客またはパートナーのみが参照できます。Salesforce からの書面による事前の同意がない限り、この内容をコピーしてさらに配布することは禁止されています。本内容は、Salesforce の高度な機密情報および独自開発の情報となっており、お客様と Salesforce との契約の守秘義務の下で保護されています。したがって、本内容は、Consumer Goods Cloud トレードプロモーション管理の機能の実装に必要な場合に限って使用できます。

このドキュメントの内容は、プレビューとしてリリースされています。したがって、一般公開はされず、エラーが含まれている場合があります。Salesforce は、このドキュメントを現状のまま提供し、その内容の正確性に関しては、いかなる説明も保証もいたしません。Salesforce は、このドキュメントを更新および改訂する権利を有しており、Consumer Goods Cloud トレードプロモーション管理の機能を説明する内容は、変更、追加、削除されることがあります。Salesforce がこのドキュメントの更新版を配布またはリリースする場合、お客様は、この���キュメントの以前のバージョンを削除および破棄することを認め、同意することものとします。

重要

名前空間

イベント

onfocusedareachange

このイベントは、アプリケーションの別のエリアがナビゲーション先になるたびにトリガーされます。

onisplgridfilteropenchange

このイベントは、P&L 検索条件がオープン (true) またはクローズ (false) されるたびにトリガーされます。

onstatuschange

このイベントは、tpm プロモーションコンポーネントのライフサイクル状態が変更されるたびにトリガーされます。状況の変更は、プロモーションレコードに対するライフサイクル操作によってトリガーされます。

oncalculationstatuschange

このイベントは、プロモーショングリッドが計算または再計算されるたびにトリガーされます。

可能な値は次のとおりです。

  • LOADING
  • VALID
  • ERROR
  • DISABLED

oneditmodechange

このイベントは、ページの編集モードが変更されるたびにトリガーされます。

onselectedtacticidchange

このイベントは、焦点が当てられた戦略が変更されるたびにトリガーされます。

onpromotionchange

このイベントは、プロモーション属性が変更されるたびにトリガーされます。

oneffectivecategorieschange

このイベントは、プロモーションの有効なカテゴリが変更されるたびにトリガーされます。

oneffectivebrandschange

このイベントは、プロモーションの有効なブランドが変更されるたびにトリガーされます。

ontacticschange

このイベントは、いずれかの戦略属性が変更されるたびにトリガーされます。

ontacticfundschange

このイベントは、いずれかの戦略資金のプロパティが資産が変更されるたびにトリガーされます。

onpromotionattachmentlinkschange

このイベントは、いずれかのプロモーション添付ファイルリンクのプロパティが変更されるたびにトリガーされます。

onpromotionattachmentschange

このイベントは、いずれかのプロモーション添付ファイルのプロパティが変更されるたびにトリガーされます。

onpromotioncategorieschange

このイベントは、プロモーションカテゴリが変更されるたびにトリガーされます。

onparticipatingcustomerschange

このイベントは、プロモーションの参加顧客が変更されるたびにトリガーされます。参加顧客リストは、プッシュプロセスでプロモーションがプッシュされる顧客を決定するときに使用されます。

ontacticconditioncreationdefinitionschange

このイベントは、プロモーション変更値に含まれる戦略の戦略条���作成定義が、戦略条件作成定義 SObject レコードを含む配列である場合に必ずトリガーされます。

oncustomstatechange

このイベントは、カスタム状態が変更されるたびにトリガーされます。カスタム状態は、プロモーション状態の特別なエリアです。ここで顧客は、Salesforce に送信されてプロモーションと同時に処理およびコミットされるカスタム構造を設定できます。

onpromotionproductschange

このイベントは、プロモーション商品が変更されるたびにトリガーされます。

onupliftpredictionavailablechange

このイベントは、上昇予測の可用性が変更されるとトリガーされます。プロモーションに対して機能が有効になっているかどうかを示します。

onupliftpredictionenabledchange

このイベントは、現在のプロモーションに対して上昇予測が実行されるとトリガーされます。上昇予測の実行を妨げるプロモーション状態に関するエラーの可能性を示します。

onupliftpredictionprocessstatuschange

このイベントは、上昇予測プロセスの状態が変更されるとトリガーされます。

可能な値は次のとおりです。

  • RUNNING
  • IDLE

tpm-promotion コンポーネントの参照メソッド

tpm-promotion Component Reference のメソッドは次のとおりです。

generateTactic

このメソッドは、tacticTemplateId を基礎に使用して、戦略レコードを生成します。このメソッドでは、すべての戦略属性が事前設定された Javascript オブジェクトに解決されるプロミスが返されます。生成された戦略は、すべての項目の setTacticField をコールすることにより、プロモーションデータに追加できます。

API バージョン

55

シグネチャー

generateTactic(tacticTemplateId)

実装例

navigateTo

プロモーションの状態プロパティを命令として取得します。

API バージョン

55

シグネチャー

getProperty(target)

実装例

push

プロモーションのプッシュプロセスを開始します。プロモーションの SObject とそれに関連するすべての SObject の現在の状態を保存します。

API バージョン

55

シグネチャー

push()

実装例

reload

プロモーションの SObject とそれに関連するすべてのレコードを再読み込みします。

API バージョン

55

シグネチャー

reload()

実装例

removeCallback

メソッドフローの一部としてコールされる設定済みのコールバック関数を削除します。

API バージョン

55

シグネチャー

removeCallback(event, callback)

実装例

save

プロモーション保存プロセスを開始します。プロモーションの SObject とそれに関連するすべての SObject の現在の状態を保存します。カスタム状態も保存します。保存プロセスでは、コンポーネントでイベントが生成され、処理中に発生する可能性がある各種イベントについての情報がカスタムコンポーネントに通知されます。

API バージョン

55

シグネチャー

save()

実装例

selectTactic

渡された戦略 ID に内部で選択された戦略を設定します。

API バージョン

55

シグネチャー

selectTactic(tacticId)

実装例

setCallback

メソッドフローの一部としてコールされるコールバック関数を設定します。

API バージョン

55

シグネチャー

setCallback(tacticFunds)

実装例

setCustomState

このオブジェクトは、処理およびコミットを行うため、SFDC への保存時にプロモーション情報と共に送信されます。カスタム状態を使用すると、顧客は、プロモーションデータと共に送信する追加のデータを設定できます。プロモーションデータは、プロモーションと同じトランザクションで保存されます。このカスタム状態は、プロモーション保存のカスタマイズを処理するカスタマイズ済み APEX クラスに転送されます。

API バージョン

55

シグネチャー

setCustomState(customState)

実装例

setEditMode

プロモーションを編集モードに設定するか、編集モードを終了します。

API バージョン

55

シグネチャー

setEditMode(value)

実装例

setParticipatingCustomers

参加顧客を含む形式のオブジェクトをリストします。

API バージョン

55

シグネチャー

setParticipatingCustomers(participatingCustomers)

実装例

setPLGridFilterOpen

プロモーション P&L ビューの P&L 検索条件セクションを表示するか、非表示にします。

API バージョン

55

シグネチャー

setPLGridFilterOpen(value)

実装例

setPromotionAttachments

関連するプロモーション添付ファイルをプロモーションに設定します。プロモーション添付ファイルは tpm-promotion コンポーネント API から作成したり、削除したりすることはできません。プロモーション添付ファイルレコードは、プロモーション添付ファイルリンクレコードを使用してプロモーションにリンクする前に作成しておく必要があります。

API バージョン

55

シグネチャー

setPromotionAttachments(attachments)

実装例

setPromotionCategories

プロモーションのカテゴリのリストを設定します。TPM アプリケーションは、再読み込み後のカテゴリの変更のみを検出します。

API バージョン

55

シグネチャー

setPromotionCategories(categories)

実装例

setPromotionField

プロモーションの SObject 項目を設定します。

API バージョン

55

シグネチャー

setPromotionField(field, value)

実装例

setSubAccounts

SubAccounts を含む形式のオブジェクトをリストします。

API バージョン

55

シグネチャー

setSubAccounts(subAccounts)

実装例

setTacticConditionCreationDefinitions

関連する戦略条件作成定義レコードをプロモーションに設定します。

API バージョン

55

シグネチャー

setTacticConditionCreationDefinitions(tacticConditionCreationDefinitions)

実装例

setTacticField

戦略 SObject 項目を設定します。

API バージョン

55

シグネチャー

setTacticField(tacticId, field, value)

実装例

setTacticFunds

関連する戦略資金をプロモーションに設定します。戦略資金レコードを削除するには、IsDeleted 属性を true に設定します。レコードに新規のフラグを設定するには、IsNew 属性を true に設定します。セールス組織が [Fund Autodetermination (資金の自動決定)] を有効にしている場合、TPM アプリケーションは常に、自動決定プロセスで生成されたレコードを使用して、戦略資金を上書きします。

API バージョン

55

シグネチャー

setTacticFunds(tacticFunds)

実装例

getLevelNames

このメソッドは、計算エンジンに現在読み込まれているレベルのリストに解決される Promise を返します。計算状況が有効でない場合、このメソッドはエラーを返します。

API バージョン

58.0

署名

getLevelNames()

実装例

getKPISubsets

このメソッドは、計算エンジンに現在読み込まれている KPI サブセットのリストに解決される Promise を返します。計算状況が有効でない場合、このメソッドはエラーを返します。

API バージョン

58.0

署名

getKPISubsets()

実装例

getKPIs

このメソッドは、計算エンジンに現在読み込まれている KPI のリストに解決される Promise を返します。計算状況が有効でない場合、このメソッドはエラーを返します。

API バージョン

58.0

署名

getKPIs()

実装例

getPeriods

このメソッドは、計算エンジンに現在読み込まれている期間のリストに解決される Promise を返します。計算状況が有効でない場合、このメソッドはエラーを返します。

API バージョン

58.0

署名

getPeriods()

実装例

getPeriodTypes

このメソッドは、計算エンジンに現在読み込まれている期間種別のリストに解決される Promise を返します。計算状況が有効でない場合、このメソッドはエラーを返します。

API バージョン

58.0

署名

getPeriodTypes()

実装例

predictUplift

このメソッドは、プロモーションの上昇予測が完了したときに解決される Promise を返します。上昇予測が無効になっている場合、またはプロモーションが正しい状況でない場合、Promise は拒否され、原因を示すエラーが表示されます。

API バージョン

58.0

署名

predictUplift()

実装例

exportKPIs

このメソッドは、選択されたサブセット、レベル、および期間種別の KPI の値に解決される Promise を返します。

API バージョン

58.0

署名

exportKPIs(options)

プロパティ

名前 説明 必須か省略可能
options.subsets List<String> データを取得するために読み込まれた KPI サブセットのリスト。

getKPISubsets() メソッドを使用して、読み込まれたサブセットのリストを取得できます。

必須
options.levels List<String> データを取得するために読み込まれたレベルのリスト。 

getLevelNames() メソッドを使用して、読み込まれたレベルのリストを取得できます。

省略可能
options.periods List<String> データを取得するために読み込まれた期間種別のリスト。

getPeriodTypes() メソッドを使用して、読み込まれた期間種別のリストを取得できます。

省略可能
options.format List<String> 返される応答の形式。

可能な形式は次のとおりです。

  • JSON: 応答は JavaScript オブジェクトの配列です。
  • シリアライズ済み: 応答は JavaScript オブジェクトの JSON 文字列です。
  • CSV: 応答は CSV 文字列です。

デフォルト形式は JSON です。

省略可能

実装例