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

ファイルのサフィックスおよびディレクトリの場所

WaveXmd components コンポーネントのサフィックスは .xmd で、wave フォルダに保存されます。

バージョン

WaveXmd コンポーネントは、API バージョン 39.0 以降で使用できます。

項目

項目名	データ型	説明
dataset	string	この Xmd に関連付けられたデータセットを指定します。
datasetConnector	string	データセットのコネクタソースの名前。
datasetFullyQualifiedName	string	この Xmd に関連付けられたデータセットバージョンの完全修飾名を指定します。
dates	WaveXmdDate	書式情報付きの日付リスト。
dimensions	WaveXmdDimension	書式情報付きのディメンションリスト。
measures	WaveXmdMeasure	書式情報付きの基準リスト。
organizations	WaveXmdOrganization	複数組織をサポートするための組織のリスト。
origin	string	データセットバージョンの発生源。

WaveXmdDate

WaveXmdDate は日付を表します。

項目	データ型	説明
alias	string	日付列の別名。
compact	boolean	日付がコンパクトフォームで表示されるかどうか。
dateFieldDay	string	日項目。
dateFieldEpochDay	string	エポック日項目。
dateFieldEpochSecond	string	エポック秒項目。
dateFieldFiscalMonth	string	会計月項目。
dateFieldFiscalQuarter	string	会計四半期項目。
dateFieldFiscalWeek	string	会計週項目。
dateFieldFiscalYear	string	会計年度項目。
dateFieldFullYear	string	通年項目。
dateFieldHour	string	時間項目。
dateFieldMinute	string	分項目。
dateFieldMonth	string	月項目。
dateFieldQuarter	string	四半期項目。
dateFieldSecond	string	秒項目。
dateFieldWeek	string	週項目。
dateFieldYear	string	年項目。
description	string	日付列の説明。
firstDayOfWeek	int	週の開始曜日を表します。
fiscalMonthOffset	int	カレンダー年に対する会計年度のオフセット (月数)。
isYearEndFiscalYear	boolean	1 年の終わりが会計年度であるかどうか。
label	string	日付列の表示ラベル。
showInExplorer	boolean	日付がエクスプローラで表示されるかどうか。
sortIndex	int	ソートするかどうか。
type	string	日付の種別。値は次のとおりです。 Date — 従来の日付種別。タイムゾーンが有効になっていない場合に使用できます。 DateOnly — 時間が関連付けられていない日付種別。タイムゾーンが有効になっている場合に使用できます。 DateTime — 日付と時間の両方の部分が含まれる日付種別。タイムゾーンが有効になっている場合に使用できます。

WaveXmdDimension

WaveXmdDimension はディメンションを表します。

項目	データ型	説明
customActions	WaveXmdDimensionCustomAction	このディメンションにリンクされているカスタムアクション。
customActionsEnabled	boolean	ディメンションでカスタムアクションが有効になっているかどうかを示します。
dateFormat	string	ディメンションである日付に使用される書式。
description	string	ディメンションの説明。
field	string	ディメンションの項目名 (クエリで使用)。
fullyQualifiedName	string	ディメンションの完全修飾名。
imageTemplate	string	画像テンプレート。
isDerived	boolean	派生ディメンションかどうか。
isMultiValue	boolean	ディメンションが複数値であるかどうかを示します。
label	string	ディメンションの表示ラベル。
linkTemplate	string	リンクの書式設定用テンプレート。
linkTemplateEnabled	boolean	ディメンションでリンクテンプレートが有効になっているかどうかを示します。
linkTooltip	string	リンクに表示されるツールチップ。
members	WaveXmdDimensionMember	ディメンションのメンバーの上書き。
origin	string	このディメンションの発生源。
recordDisplayFields	WaveXmdRecordDisplayLookup	ディメンションの順序付きリスト。このリストは、ユーザインターフェースでディメンションが表示されるデフォルトの順序を定義します。
recordIdField	string	このディメンションのレコード ID。
recordOrganizationIdField	string	このディメンションのレコード組織 ID。
salesforceActions	WaveXmdDimensionSalesforceAction	このディメンションにリンクされている Salesforce アクション。
salesforceActionsEnabled	boolean	ディメンションで Salesforce アクションが有効になっているかどうかを示します。
showDetailsDefaultFieldIndex	int	ユーザインターフェースでディメンションが表示されるデフォルトの順序。
showInExplorer	boolean	ディメンションがエクスプローラで表示されるかどうかを示します。
sortIndex	int	ソートするかどうか。

WaveXmdDimensionCustomAction

WaveXmdDimensionCustomAction はディメンションのカスタムアクションを表します。

項目	データ型	説明
customActionName	string	このカスタムアクションの名前。
enabled	boolean	特定のディメンションに対してアクションが有効になっているかどうかを示します。
icon	string	アクションのアイコン。
method	string	アクションのメソッド。
sortIndex	int	ソートするかどうか。
target	string	アクションのターゲット。
tooltip	string	アクションのツールチップ。
url	string	アクションの URL。

WaveXmdDimensionMember

WaveXmdDimensionMember はディメンションを表します。

項目	データ型	説明
color	string	メンバーの色。
label	string	メンバーの表示ラベル。
member	string	メンバー値。
sortIndex	int	ソートするかどうか。

WaveXmdRecordDisplayLookup

WaveXmdDimensionRecordDisplayLookup はレコード表示項目を表します。

項目	データ型	説明
recordDisplayField	string	表示する項目。

WaveXmdDimensionSalesforceAction

WaveXmdDimensionSalesforceAction はディメンションのアクションを表します。

項目	データ型	説明
enabled	boolean	特定のディメンションに対してアクションが有効になっているかどうかを示します。
salesforceActionName	string	アクションの名前。
sortIndex	int	ソートするかどうか。

WaveXmdMeasure

WaveXmdMeasure は基準を表します。

項目	データ型	説明
dateFormat	string	基準である日付に使用される書式。
description	string	基準の説明。
field	string	基準の項目名 (クエリで使用)。
formatCustomFormat	string	1 つの String 型としての元の形式 (XMD 1.1) の配列。
formatDecimalDigits	int	小数点の後に表示される桁数。
formatIsNegativeParens	boolean	負の数値をマイナス記号ではなく括弧を使用して表示するかどうかを示します。
formatPrefix	string	項目値の前に置かれるプレフィックス。
formatSuffix	string	項目値の後に置かれるサフィックス。
formatUnit	string	基準の単位文字列(「cm」など)。
formatUnitMultiplier	double	単位乗数。
fullyQualifiedName	string	基準の完全修飾名。
isDerived	boolean	派生基準かどうか。
label	string	基準の表示ラベル。
origin	string	基準の発生源。
showDetailsDefaultFieldIndex	int	ユーザインターフェースで基準が表示されるデフォルトの順序。
showInExplorer	boolean	基準がエクスプローラで表示されるかどうかを示します。
sortIndex	int	ソートするかどうか。

WaveXmdOrganization

WaveXmdOrganization は Salesforce 組織を表します。

項目	データ型	説明
instanceUrl	string	組織のインスタンス URL。
label	string	組織の表示ラベル。
organizationIdentifier	string	組織の ID。
sortIndex	int	ソートするかどうか。