`ingestDataConnector`

データ同期を実行する CRM Analytics データコネクタをトリガします。この呼び出しは、CRM Analytics データマネージャ UI で [今すぐ実行] をクリックする操作に相当します。

構文

1import { ingestDataConnector } from 'lightning/analyticsWaveApi';
2ingestDataConnector({ connectorIdOrApiName: string }): Promise<RestoreDatasetVersion>

CRM Analytics API リソース

1POST /wave/dataConnectors/${connectorIdOrApiName}/ingest

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

パラメータ

connectorIdOrApiName — データコネクタの ID または開発者名。

戻り値

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

使用方法

ingestDataConnector は、CRM Analytics コネクタのデータ同期をトリガするために使用します。たとえば、データコネクタのリストを表示し、リストの各コネクタに対してデータの同期を有効にできます。データコネクタを実行すると、lightning/platformShowToastEvent モジュールを使用して、トーストメッセージが表示されます。

1import { LightningElement, api } from 'lwc';
2import { ingestDataConnector } from 'lightning/analyticsWaveApi';
3import { ShowToastEvent } from 'lightning/platformShowToastEvent';
4
5export default class IngestDataConnector extends LightningElement {
6  @api idOrApiName;
7
8  ingest(event) {
9    ingestDataConnector({ connectorIdOrApiName : this.idOrApiName } })
10      .then(() => {
11        this.dispatchEvent(
12          new ShowToastEvent({
13            title: 'Success',
14            message: 'Data Connector Ingested',
15            variant: 'success'
16          })
17        );
18      })
19    .catch(error => {
20      this.dispatchEvent(
21        new ShowToastEvent({
22          title: 'Error ingesting data connector',
23          message: error.body.message,
24          variant: 'error'
25        })
26      );
27    });
28  }
29}

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

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

The Japanese Summer '24 guide is now live

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