`updateXmd`

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

構文

1import { updateXmd } from 'lightning/analyticsWaveApi';
2updateXmd({ datasetId: string, versionId: string, xmd: XmdInput }): Promise<Xmd>

CRM Analytics API リソース

1PUT /wave/datasets/${datasetId}/versions/${versionId}/xmds/user

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

パラメータ

datasetId — (必須) データセットの ID。
versionId — (必須) データセットバージョンの ID。
xmdType — (必須) XMD の種別。更新で有効な値は user のみです。
xmd — (必須) 更新する XMD。Xmd Input リソースを使用します。

戻り値

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

使用方法

updateXmd を使用することで、ユーザはデータセット内の基準およびディメンションの形式を変更できます。次の例では、データセットが含まれるページに更新ボタンを追加します。ページには、データセットの XMD 更新に必要な情報についてのフォーム要素が含まれている必要があります。XMD を更新すると、lightning/platformShowToastEvent モジュールを使用して、トーストメッセージが表示されます。

1import { LightningElement, api } from "lwc";
2import { updateXmd } from "lightning/analyticsWaveApi";
3import { ShowToastEvent } from "lightning/platformShowToastEvent";
4
5export default class UpdateXmd extends LightningElement {
6  @api dId; // or fetch the ID of the dataset
7  @api dvId; // or fetch the ID of the dataset version
8  xmd = {
9    measures: [
10      {
11        conditionalFormatting: {},
12        field: "LastModifiedDate_day_epoch",
13        format: {
14          delimiters: {},
15        },
16        label: "Last Mod Date",
17        showInExplorer: true,
18      },
19    ],
20  };
21
22  update(event) {
23    updateXmd({ datasetId: this.dId, versionId: this.dvId, xmd: this.xmd, xmdType: "user" })
24      .then(() => {
25        this.dispatchEvent(
26          new ShowToastEvent({
27            title: "Success",
28            message: "Xmd updated",
29            variant: "success",
30          }),
31        );
32      })
33      .catch((error) => {
34        this.dispatchEvent(
35          new ShowToastEvent({
36            title: "Error updating Xmd",
37            message: error.body.message,
38            variant: "error",
39          }),
40        );
41      });
42  }
43}

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

1<template>
2  <lightning-button
3    label="Update Xmd"
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 (コンポーネントリファレンス)」は、以前と同様にコンポーネントライブラリにあります。