DiscoveryStory | メタデータ API 開発者ガイド

ストーリーでは、Einstein Discovery がインサイトを生成して予測モデルを構築するために使用するデータおよび分析設定を定義します。ストーリー設定には、結果変数、結果変数を最大化するか最小化するか、CRM Analytics データセット内で分析するデータ、および他の設定が含まれます。ストーリー設定では、分析の実施方法とその結果の伝達方法を Einstein Discovery に指示します。パッケージマネージャでは、この種別は [Discovery ストーリー] として表示されます。

通常、DiscoveryStory オブジェクトの書き込み操作はサポートされません。

メモ

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所

DiscoveryStory は、discovery フォルダに保存されます。DiscoveryStory には、次の 2 つのファイルがあります。

サフィックスが .story であるファイルには、ストーリーの実際のデータが含まれます。
ModelName.story-meta.xml という名前のファイルには、ストーリーのメタデータが含まれます。

次に、サンプルの package.xml ファイルを示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>Subscriber_Changes</members>
5        <name>DiscoveryStory</name>
6    </types>
7    <version>55.0</version>
8</Package>

バージョン

DiscoveryStorys は、API バージョン 54.0 以降で使用できます。

項目

項目名	項目の型	説明
application	string	必須。ストーリーが関連付けられた CRM Analytics アプリケーション。
autopilot	DiscoveryStoryAutopilotStatus	省略可能。ストーリーの autopilot の状況。次のいずれかの文字列になります。 Enabled Disabled
classificationThreshold	double	省略可能。ストーリーの分類の予測のしきい値。
label	string	必須。ストーリーの表示ラベル。ストーリーをパッケージ化した場合、この表示ラベルは、パッケージマネージャに表示されます。
outcome	DiscoveryStoryOutcome	必須。ストーリーの選択済みの結果。
sourceContainer	string	必須。ストーリーの取得元 ID。
sourceType	DiscoveryStorySourceType	必須。ストーリーの取得元種別。次のいずれかの文字列になります。 AnalyticsDataset LiveDataset Report
validationContainder	string	省略可能。ストーリーの検証 ID。

DiscoveryStoryOutcome

生成されたストーリーの選択済みの結果を表します。

項目名	項目の型	説明
failureValue	string	省略可能。ストーリーが失敗した場合の値。
field	string	必須。ストーリーの項目設定。
goal	DiscoveryStoryOutcomeGoal	必須。ストーリーの結果の目標。次のいずれかの文字列になります。 Maximize Minimize None
label	string	必須。ストーリーの結果の表示ラベル。
successValue	string	省略可能。ストーリーが成功した場合の値。
type	DiscoveryStoryOutcomeType	必須。ストーリーの結果の種別。次のいずれかの文字列になります。 Categorical Count Number Text

宣言的なメタデータの定義のサンプル

DiscoveryStory のサンプルを次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<DiscoverStory xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3    <application>MyStoryApp</application>
4    <autopilot>Enabled</autopilot>
5    <classificationThreshold>0.7383</classificationThreshold>
6    <label>SubscriberChanges</label>
7    <outcome>
8        <field>Subscriber</field>
9        <goal>Minimize</goal>
10        <label>SubscriberChangeOutcome</label>
11        <successValue>Success</successValue>
12        <type>Numerical</type>
13    </outcome>
14    <sourceContainer>01X00000000xxxx1AB</sourceContainer>
15    <sourceType>AnalyticsDataset</sourceType>
16</DiscoveryStory>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。