`getDatasets`

CRM Analytics データセットのコレクションを取得します。

構文

1import { LightningElement, wire } from "lwc";
2import { getDatasets } from "lightning/analyticsWaveApi";
3
4export default class GetDatasets extends LightningElement {
5  @wire(getDatasets, {
6    datasetTypes: ["Default", "Live"],
7    licenseType: "EinsteinAnalytics",
8  })
9  onGetDatasets({ data, error }) {
10    if (error) {
11      console.log("getDatasets ERROR:", error);
12    } else if (data) {
13      console.log("getDatasets RESPONSE:", data.datasets);
14    }
15  }
16}

CRM Analytics API リソース

1GET /wave/datasets

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

パラメータ

createdAfter — (省略可能) 特定のタイムスタンプの後に作成されたデータセットのみが含まれるようにコレクションを絞り込みます。
createdBefore — (省略可能) 特定のタイムスタンプの前に作成されたデータセットのみが含まれるようにコレクションを絞り込みます。
datasetTypes — (省略可能) 1 つ以上の指定された種別のデータセットのみが含まれるようにコレクションを絞り込みます。
- Default
- Live
- StagedData
- Trended
folderId — (省略可能) 指定されたフォルダのデータセットのみが含まれるようにコレクションを絞り込みます。要求ユーザの非公開フォルダにあるデータセットのユーザ ID などになります。
hasCurrentOnly — (省略可能) 現在のバージョンのデータセットのみが含まれるようにデータセットのコレクションを絞り込みます。デフォルトは false です。
ids — (省略可能) 指定された ID のデータセットのみが含まれるようにコレクションを絞り込みます。
includeCurrentVersion — (省略可能) コレクションに現在のデータセットバージョンのメタデータを含めます。デフォルトは false です。
lastQueriedAfter — (省略可能) 特定のタイムスタンプの後で、最後に照会されたデータセットのみが含まれるようにコレクションを絞り込みます。
lastQueriedBefore — (省略可能) 特定のタイムスタンプの前で、最後に照会されたデータセットのみが含まれるようにコレクションを絞り込みます。
licenseType — (省略可能) 応答には、このライセンスタイプのデータフロージョブが含まれます。デフォルトは EinsteinAnalytics です。
- Cdp (Data Cloud)
- DataPipelinesQuery (データパイプラインクエリ)
- EinsteinAnalytics (CRM Analytics)
- IntelligentApps (インテリジェントアプリケーション)
- MulesoftDataPath (Mulesoft Data Path)
- Sonic (Salesforce データパイプライン)
order — (省略可能) コレクションの結果に適用される順序。
- Ascending
- Descending
page — (省略可能) 返されるデータセットのビューを示す生成されたトークン。
pageSize — (省略可能) 1 ページで返される項目の数。最小値は 1、最大値は 200、デフォルトは 25 です。
q — (省略可能) 検索語。各用語はスペースで区切られます。ワイルドカードは、クエリ文字列の最後のトークンに自動的に付加されます。ユーザの検索クエリに疑問符またはワイルドカードが含まれている場合、それらの記号は URL で他の特殊文字と同様にクエリ文字列から自動的に削除されます。
scope — (省略可能) コレクションの結果に適用される範囲種別。
- CreatedByMe
- Mru (最後に使用)
- SharedWithMe
sort — (省略可能) コレクションの結果に適用される並び替え順。
- CreatedBy
- CreatedDate
- LastModified
- LastQueried
- LastRefreshed
- Mru (Most Recently Used、最後に参照した日付)
- Name
- TotalRows
supportsNewDates — (省略可能) 新しい日付をサポートするデータセットだけをコレクションに含めるか (true)、否か (false) を指定します。デフォルトは false です。

戻り値

data — Dataset Collection
error — FetchResponse

The Japanese Summer '24 guide is now live

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