`updateDataset`

特定の CRM Analytics データセットを ID で更新します。

構文

1import { updateDataset } from 'lightning/analyticsWaveApi';
2updateDataset({ datasetIdOrApiName: string, dataset: DatasetInput }): Promise<Dataset>

CRM Analytics API リソース

1PUT /wave/datasets/${datasetIdOrApiName}

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

パラメータ

datasetIdOrApiName — (必須) データセットの ID または API 名。
dataset — (必須) 更新するデータセット。Dataset Input リソースを使用します。

戻り値

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

使用方法

ユーザは、updateDataset を使用することで、説明や表示ラベルなどを変更できます。次の例では、データセットが含まれるページに更新ボタンを追加します。ページには、データセットの更新に必要な情報についてのフォーム要素が含まれている必要があります。データセットを更新すると、lightning/platformShowToastEvent モジュールを使用して、トーストメッセージが表示されます。

1import { LightningElement, api } from "lwc";
2import { updateDataset } from "lightning/analyticsWaveApi";
3import { ShowToastEvent } from "lightning/platformShowToastEvent";
4
5export default class UpdateDataset extends LightningElement {
6  @api dId; // or fetch the ID of the dataset
7  dataset = {
8    label: "Updated dataset",
9  };
10
11  update(event) {
12    updateDataset({ datasetIdOrApiName: this.dId, dataset: this.dataset })
13      .then(() => {
14        this.dispatchEvent(
15          new ShowToastEvent({
16            title: "Success",
17            message: "Dataset updated",
18            variant: "success",
19          }),
20        );
21      })
22      .catch((error) => {
23        this.dispatchEvent(
24          new ShowToastEvent({
25            title: "Error updating dataset",
26            message: error.body.message,
27            variant: "error",
28          }),
29        );
30      });
31  }
32}

このボタンは、updateDataset() メソッドをコールします。

1<template>
2  <lightning-button
3    label="Update Dataset"
4    icon-name="utility:play"
5    icon-position="right"
6    onclick={update}
7  ></lightning-button>
8</template>

The Japanese Summer '24 guide is now live

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