`validateWaveTemplate`

CRM Analytics テンプレートを検証し、組織の準備状況を確認します。

構文

1import { validateWaveTemplate } from 'lightning/analyticsWaveApi';
2validateWaveTemplate({ templateIdOrApiName: string, templateValidateParam: TemplateValidateInput }): Promise<TemplateValidate>

CRM Analytics API リソース

1POST /wave/templates/${templateIdOrApiName}/validate

validateWaveTemplate は、この CRM Analytics API リソースを使用します。

パラメータ

templateIdOrApiName — (必須) CRM Analytics テンプレートの ID または API 名。
templateValidateParam — (必須) テンプレートを検証するための入力。Template Validate Input を使用します。

戻り値

TemplateValidate 応答を使用して解決される Promise オブジェクト。

使用方法

validateWaveTemplate を使用することで、ユーザは CRM Analytics アプリケーションテンプレートを検証し、組織の準備状況を確認できます。この例では、検証中にパラメータ値を渡して、テンプレート変数を上書きする方法を示します。読みやすくするために、結果は、JSON から文字列にパースされます。

1import { LightningElement } from "lwc";
2import { validateWaveTemplate } from "lightning/analyticsWaveApi";
3
4export default class ValidateWaveTemplate extends LightningElement {
5  results = "";
6
7  async doValidateWaveTemplate() {
8    this.results = "Loading...";
9    try {
10      const results = await validateWaveTemplate({
11        templateIdOrApiName: "<id or api name here>",
12        templateValidateParam: {
13          // include any variable values to use, which override any template defaults for this call
14          values: {
15            variable1: "foo",
16            variable2: { objectName: "Case" },
17          },
18        },
19      });
20      this.results = "Success:\n" + JSON.stringify(results, undefined, 2);
21    } catch (e) {
22      console.error("validateWaveTemplate error:", e);
23      this.results = "Error:\n" + JSON.stringify(e, undefined, 2);
24    }
25  }
26}

The Japanese Summer '24 guide is now live

日本語の Summer '24 ガイドが公開されました! 「Component Reference (コンポーネントリファレンス)」は、以前と同様にコンポーネントライブラリにあります。