XMD リソース

1/wave/datasets/<datasetID>/versions/<versionID>/xmds/main

1/wave/datasets/<datasetID>/versions/<versionID>/xmds/system

1/wave/datasets/<datasetID>/versions/<versionID>/xmds/user

XMD についての詳細は、『Analytics 拡張メタデータ (XMD) リファレンス』を参照してください。

• LWC — lightning/analyticsWaveApi getXmd()
• LWC — lightning/analyticsWaveApi updateXmd()

次の JSON は、ユーザ XMD の measures を更新する PUT 要求を示しています。PUT 要求を使用して、システムまたはメイン種別の XMD を更新することはできません。

1{
2  "measures" : [ {
3    "conditionalFormatting" : { },
4    "field" : "LastModifiedDate_day_epoch",
5    "format" : {
6      "delimiters" : { }
7    },
8    "label" : "LastModDate_day_epoch",
9    "showInExplorer" : true
10  }, {
11    "conditionalFormatting" : { },
12    "field" : "LastModifiedDate_sec_epoch",
13    "format" : {
14      "delimiters" : { }
15    },
16    "label" : "LastModDate_sec_epoch",
17    "showInExplorer" : true
18  } ]
19}

Xmd​Date​Representation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
alias	String	日付列の別名。	Small、36.0	36.0
compact	Boolean	日付を短縮形式で表示すべきか否かを示します。	Small、36.0	36.0
description	String	日付列の説明。	Small、36.0	36.0
fields	Xmd​Date​Field​Representation	日付項目の書式情報。	Small、36.0	36.0
first​Day​Of​Week	Integer	週の最初の日を示���ます。	Small、36.0	36.0
fiscal​Month​Offset	Integer	カレンダー年に対する会計年度のオフセット (月数)。	Small、36.0	36.0
format	String	日付項目の書式。	Small、53.0	53.0
fully​Qualified​Name	String	日付の完全修飾名。	Small、39.0	39.0
is​Converted​Date​Time	Boolean	DateTime 型がタイムゾーンの自動変換か否かを示します。	Small、44.0	44.0
is​Year​End​Fiscal​Year	Boolean	1 年の終わりが会計年度であるか否かを示します。	Small、36.0	36.0
label	String	日付列の表示ラベル。	Small、36.0	36.0
show​In​Explorer	Boolean	ダッシュボードやレンズを作成するときに、データセット項目をダッシュボードデザイナまたはエクスプローラから選択可能か否かを示します。showInExplorer が false でも、JSON で手動で項目を追加して Analytics REST API を使用してアクセスすれば、項目を SAQL クエリに使用することができます。	Small、36.0	36.0
type	Connect​Wave​Date​Type	データ型。有効な値は、次のとおりです。 Date DateOnly DateTime	Small、43.0	43.0

Xmd​Date​Field​Representation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
day	String	日付。	Small、36.0	36.0
epoch​Day	String	1970 年 1 月 1 日 (深夜 UTC) からの経過日数。	Small、36.0	36.0
epoch​Second	String	1970 年 1 月 1 日 (深夜 UTC) からの経過秒数。データセットの _sec_epoch に対応します。	Small、36.0	36.0
fiscal​Month	String	会計年度の月番号。データセットの _Month_Fiscal に対応します。	Small、36.0	36.0
fiscal​Quarter	String	会計年度の四半期番号。データセットの _Quarter_Fiscal に対応します。	Small、36.0	36.0
fiscal​Week	String	会計年度の週番号。データセットの _Week_Fiscal に対応します。	Small、36.0	36.0
fiscal​Year	String	会計年度。データセットの _Year_Fiscal に対応します。	Small、36.0	36.0
full​Field	String	完全項目。	Small、36.0	36.0
hour	String	時間数。日付に時間がない場合、値は「0」になります。データセットの _Hour に対応します。	Small、36.0	36.0
minute	String	分数。日付に分がない場合、値は「0」になります。データセットの _Minute に対応します。	Small、36.0	36.0
month	String	カレンダー年の月番号。データセットの _Month に対応します。	Small、36.0	36.0
quarter	String	カレンダー年の四半期番号。データセットの _Quarter に対応します。	Small、36.0	36.0
second	String	秒数。日付に秒がない場合、値は「0」になります。データセットの _Second に対応します。	Small、36.0	36.0
week	String	カレンダー年の週番号。データセットの _Week に対応します。	Small、36.0	36.0
year	String	カレンダー年。データセットの _Year に対応します。	Small、36.0	36.0

Xmd​Dimension​Representation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
conditional​Formatting	Conditional​Formatting​Property​Representation	ディメンションの条件付き書式。	Small、42.0	42.0
custom​Actions	Xmd​Dimension​Custom​Action​Representation	このディメンションにリンクされているカスタムアクション。	Small、36.0	36.0
custom​Actions​Enabled	Boolean	ディメンションのカスタムアクションが有効か否かを示します。	Small、36.0	36.0
default​Action	String	ディメンションのデフォルトアクション。	Small、50.0	50
field	String	ディメンションの項目名 (クエリで使用)。	Small、36.0	36.0
label	String	データセット項目の表示名。40 文字まで入力できます。	Small、36.0	36.0
link​Template	String	ユーザがアクションメニュー内のリンクをクリックしたときに開く URL。デフォルトの URL リンク ("/{{row.recordIdField}}") を上書きします。デフォルトでは、recordIdField XMD パラメータで指定されたレコード ID を使用して Salesforce レコードを検索します。255 文字以下にする必要があります。複数の組織がある環境から Salesforce レコードを開く場合、{{instanceUrl}} と入力すると、XMD の "organizations" セクションに指定された組織 URL が入力されます。例: "/{{row.dimensionNameId}}"。	Small、36.0	36.0
link​Template​Enabled	Boolean	Salesforce レコードまたは URL を開くリンクを表示するか否かを示します。false に設定されているか未設定の場合は、メニューに [レコードを開く] リンクオプションが表示されません。	Small、36.0	36.0
link​Tool​tip	String	ダッシュボード閲覧者が Analytics レンズまたはダッシュボード内のリンクにマウスポインタを置いたときに表示されるツールチップ。	Small、36.0	36.0
members	Xmd​Dimension​Member​Representation[]	データセット項目の特定の値に対するカスタマイズ。たとえば、「Country」項目の表示ラベルを「USA」から「United States」に変更します。さらに、この値のグラフでの色を青に変更します。 表示ラベルを変更すると、新しい表示ラベルはユーザインターフェースにのみ表示されます。クエリ内 (クエリ検索条件など) ではこの表示ラベルを使用できません。この場合のベストプラクティスは、データセットを作成するときに項目値を変更することです。 メモ	Small、36.0	36.0
record​Display​Fields	String []	ディメンションおよび基準の順序付きリスト。これらのデータセット項目は、複数のレコードがアクションと一致する場合に、ダッシュボード閲覧者が Salesforce レコードを識別しやすくするために使用されます。各項目に API 参照名を指定します。一部のインスタンスでは、ディメンション値が複数の ID に関連付けられ、一意ではありません。たとえば、「acme」という名前の商談に複数の商談 ID (およびレコード) がある場合などです。ただし、アクションまたはリンク先に指定できるのは 1 つのレコードのみです。	Small、36.0	36.0
record​Id​Field	String	アクションの対象である Salesforce オブジェクトのレコード ID が含まれるデータセット項目。	Small、36.0	36.0
record​Organization​Id​Field	String	このディメンションのレコード組織 ID。	Small、36.0	36.0
salesforce​Actions	Xmd​Dimension​Salesforce​Action​Representation" []	アクションメニューに表示されるアクション。追加できるのは、対応する Salesforce オブジェクトのページレイアウトで定義されているアクションのみです。空白の場合、すべてのアクションが表示されます。	Small、36.0	36.0
salesforce​Actions​Enabled	Boolean	項目に Salesforce アクションメニューを表示可能か否かを示します。false に設定されているか未設定の場合は、メニューにはアクションが表示されません。	Small、36.0	36.0
show​In​Explorer	Boolean	ダッシュボードやレンズを作成するときに、データセット項目をダッシュボードデザイナまたはエクスプローラから選択可能か否かを示します。showInExplorer が false でも、JSON で手動で項目を追加して Analytics REST API を使用してアクセスすれば、項目を SAQL クエリに使用することができます。	Small、36.0	36.0

Xmd​Dimension​Custom​Action​Representation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
icon	String	カスタムアクションのアイコン。	Small、36.0	36.0
method	String	カスタムアクションのメソッド。	Small、36.0	36.0
target	String	カスタムアクションの対象。	Small、36.0	36.0
tooltip	String	カスタムアクションのツールチップ。	Small、36.0	36.0
url	String	カスタムアクションの URL。	Small、36.0	36.0

Xmd​Dimension​Member​Representation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
color	String	メンバーの色。たとえば、「Blue」に設定します。	Small、36.0	36.0
label	String	メンバーの表示ラベル。たとえば、「United States」に設定します。	Small、36.0	36.0
member	String	メンバー値。たとえば、「USA」に設定します。	Small、36.0	36.0

Xmd​Dimension​Salesforce​Action​Representation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
enabled	Boolean	特定のディメンションに対してアクションが有効になっているかどうかを示します。	Small、36.0	36.0
name	String	アクションの名前。	Small、36.0	36.0

Xmd​Measure​Representation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
conditional​Formatting	Conditional​Formatting​Property​Representation	基準の条件付き書式。	Small、42.0	42.0
field	String	データセット項目の識別子 (API 参照名)。	Small、36.0	36.0
format	Xmd​Measure​Format​Representation	基準の書式詳細。	Small、36.0	36.0
label	String	データセット項目の表示名。40 文字まで入力できます。たとえば、「Sales Amount」に設定します。	Small、36.0	36.0
show​In​Explorer	Boolean	ダッシュボードやレンズを作成するときに、データセット項目をダッシュボードデザイナまたはエクスプローラから選択可能か否かを示します。showInExplorer が false でも、JSON で手動で項目を追加して Analytics REST API を使用してアクセスすれば、項目を SAQL クエリに使用することができます。	Small、36.0	36.0

Xmd​Measure​Format​Representation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
custom​Format	String	表示をカスタマイズするときに、プレフィックス、サフィックス、桁区切り文字、小数点の区切り文字、先頭および末尾のゼロを追加できます。桁数も設定できます。プレフィックスとサフィックスには、マイナス記号や通貨記号など、任意の文字を含めることができます。次の記号を使用して形式を指定できます。 0: 1 桁。先頭または末尾の 0 を追加するために使用します。たとえば、カスタム形式 #,###.00 を 56375 に適用すると、結果は 56,375.00 になります。 #: 0 または 1 桁を追加します。該当する場合に、数字を表示するために使用します。たとえば、カスタム形式 #,###.## を 56375.56 に適用すると、結果は 56,375.56 になります。 .(ピリオド): 小数点の区切り文字として使用される記号。375.56 などの数値に使用されます。Analytics では、現在小数点の区切り文字として小数点記号 (.) のみがサポートされます。 ,(カンマ): 桁区切り文字として使用される記号。56,375 などに使用されます。Analytics では、現在桁区切り文字としてカンマ記号 (,) のみがサポートされます。例: [\"-$#,###.00$\",1]	Small、36.0	36.0
delimiters	Numeric​Separators​Representation	形式の千桁と小数点以下の区切り文字。	Small、48.0	48.0
unit​Multiplier	Double	単位乗数。乗数は項目値を同じ係数によって変更します。たとえば、100 を掛けて小数をパーセントに変換する場合などです。	Small、36.0	36.0

Xmd​Organization​Representation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
id	String	組織の ID。	Small、36.0	36.0
instance​Url	String	組織の [私のドメイン] ログイン URL (形式は https://MyDomainName.my.salesforce.com)。	Small、36.0	36.0
label	String	Salesforce 組織の表示名。40 文字まで入力できます。	Small、36.0	36.0