この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Analytics REST API 開発者ガイド

Analytics REST API の使用
Analytics REST API リファレンス
Analytics REST API リソースの概要
Wave リソース
Annotations List リソース
Annotation リソース
Charts Geodata List リソース
Charts Geodata リソース
Charts Geodata File List リソース
Charts Maps List リソース
Charts Maps リソース
Dashboards List リソース
Dashboard リソース
Dashboard Image リソース
Dashboard Saved Views List リソース
Dashboard Saved Views リソース
Dashboard Saved Views Initial リソース
Data Connector リソース
Data Connectors List リソース
Data Connector Ingest List リソース
Data Connector Source Objects List リソース
Data Connector Source Object リソース
Data Connector Source Object Data リソース
Data Connector Source Object Data Preview リソース
Data Connector Source Object Fields リソース
Data Connector Types リソース
Dataflow Jobs List リソース
Dataflow Jobs リソース
Dataflows List リソース
Dataflows リソース
Datasets List リソース
Dataset リソース
Dependencies リソース
Features Configuration リソース
File リソース
Folders List リソース
Folder リソース
Lenses List リソース
Lens リソース
Lens File リソース
Lens File Metadata リソース
Query リソース
Recipes List リソース
Recipe リソース
Recipe File リソース
Replicated Datasets リソース
Replicated Datasets List リソース
Replicated Dataset Fields リソース
Security Coverage Dataset Version リソース
Security Coverage Object リソース
Templates List リソース
Templates リソース
Templates Configuration リソース
Template Release Notes リソース
Trended Reports List リソース
Trended Reports リソース
Dataset Versions List リソース
Dataset Version リソース
XMD List リソース
XMD リソース
PDF

Dashboard リソース

指定された ID または API 参照名を持つダッシュボードを返したり更新したりします。
リソース URL
1/wave/dashboards/<dashboard ID or API name>
形式
JSON
使用可能なバージョン
36.0
HTTP のメソッド
GET DELETE PATCH

POST メソッドは /wave/dashboards でサポートされています。

下記の「PATCH および POST のリクエストボディ (DashboardInputRepresentation)。POST メソッドは /wave/dashboards でサポートされています。」を参照してください。

GET および PATCH のレスポンスボディ (DashboardRepresentation)
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
allowPreview Boolean このダッシュボードがプレビューで使用できるかどうかを示します。 Small、36.0 36.0
assetSharingUrl String このアセットを Analytics Builder で開くための URL。ディープリンクの形式です。サーバは、urlType、assetId、orgId、loginHost を含む可能性があるリンクパラメータ、およびその他の省略可能パラメータを調べて、必要に応じて変換して対象クライアントで正しい結果を生成します。たとえば、Analytics ダッシュボードがデスクトップクライアントで開き、モバイル OS を使用している場合はモバイルで開きます。たとえば、次のような共有 URL があるとします。
1http://{host}/​analytics/​application/​005xx000001SvSwAAK?​urlType=sharing&​orgId=00DT0000000Dpvc&​loginHost=​https%3A%2F%2F​test.my.salesforce.com
この場合は、次のような Web URL が生成されます。
1http://{host}/​insights/​web/​explore.apexp#​application/​005xx000001SvSwAAK
iOS では、次のような URL が生成されることがあります。
1com.salesforce.kona://​application/​005xx000001SvSwAAK&​orgId=00DT0000000Dpvc&​loginHost=​https%3A%2F%2F​test.my.salesforce.com
 Small、36.0 36.0
createdBy Wave User ダッシュボードを作成したユーザ。 Small、36.0 36.0
createdDate Date ダッシュボードが作成された時刻。 Small、36.0 36.0
datasets Asset​Reference​Representation[] このダッシュボードの作成に使用されたデータセットのリスト。 Small、36.0 36.0
description String ダッシュボードの説明。 Small、36.0 36.0
files Lens File[] このダッシュボードの作成に使用されたファイルのリスト。 Medium、36.0 36.0
filesUrl String ダッシュボードに関連付けられたファイルの URL。 Small、36.0 36.0
folder Asset​Reference​Representation[] このダッシュボードを含むフォルダ。 Small、36.0 36.0
id String 18 文字のダッシュボード ID。 Small、36.0 36.0
label String ダッシュボードの表示ラベル。 Small、36.0 36.0
lastAccessedDate Date ダッシュボードが��後にアクセスされた時刻 (ISO8601 日付形式)。 Small、36.0 36.0
lastModifiedBy Wave User ダッシュボードを最後に更新したユーザ。 Small、36.0 36.0
lastModifiedDate Date ダッシュボードが最後に変更された時刻 (ISO8601 日付形式)。 Small、36.0 36.0
mobileDisabled Boolean ダッシュボードがモバイルで無効になっているかどうか。 Small、41.0 41.0
name String ダッシュボードの名前。 Small、36.0 36.0
namespace String ダッシュボードの名前空間。 Small、36.0 36.0
permissions Permissions 現在のユーザの権限。 Small、36.0 36.0
refreshDate Date ダッシュボードで使用された最新のデータセットの日付 (ISO8601 日付形式)。 Small、36.0 36.0
state Dashboard State ダッシュボードの状態。 Big、36.0 36.0
type String アセットタイプ。ダッシュボードの場合、値は dashboard です。 Small、36.0 36.0
url String ダッシュボードのリソースへの URL。 Small、36.0 36.0
Dashboard State
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
dataSourceLinks Dashboard​Data​Source​Link​Representation[] ダッシュボードのすべてのデータ取得元リンクのリスト。 Small、39.0 39.0
filters Filter​Item​Representation[] このダッシュボードで適用されるデータソース検索条件のリスト。 Small、41.0 41.0
gridLayoutStyle Grid​Layout​Style​Representation グリッドレイアウトのスタイル設定。gridLayouts プロパティとペアになり、「layouts」プロパティに置き換わります。 Small、36.0 36.0 (最大 37.0)
gridLayouts Grid​Layout​Representation[] このダッシュボードのすべてのグリッドレイアウトのリスト。このプロパティは「layouts」プロパティに置き換わり、この 2 つは相互に排他的です。 Small、36.0 36.0
layouts Layout[] このダッシュボードのレイアウトのリスト。このリストは、gridLayouts に置き換えられます。 Small、36.0 36.0
steps Map<String, Step> このダッシュボードの作成に使用されたステップのリスト。キー文字列はステップ名です。 Small、36.0 36.0
widgetStyle Grid​Layout​Widget​Style​Representation このダッシュボードのウィジェットに適用されるデフォルトのスタイル設定。 Small、37.0 37.0
widgets Map<String, Dashboard Widget> このダッシュボードの作成に使用されたウィジェットのリスト。キー文字列はウィジェット名です。 Small、36.0 36.0
DashboardDataSourceLinkRepresentation
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
fields Dashboard​Data​Source​Field​Representation[] データソースリンクの項目のリスト Small、39.0 39.0
label String データソースリンクの表示ラベル Small、39.0 39.0
name String データソースリンクの名前 Small、39.0 39.0
DashboardDataSourceFieldRepresentation
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
dataSourceName String データソースの API 参照名。 Small、39.0 39.0
data​Source​Namespace String データセット名を修飾する名前空間 Small、39.0 39.0
dataSourceType Connect​Wave​Data​Source​Type​Enum データソースの種類 (Saql または Static)。 Small、39.0 39.0
fieldName String データソースの項目の名前 Small、39.0 39.0
FilterItemRepresentation
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
dataset Asset​Reference​Representation 検索条件が適用されるデータソース。 Small、41.0 41.0
fields String [] 検索条件の項目のリスト。 Small、41.0 41.0
hidden Boolean プレビューモードで検索条件が非表示かどうかを示す項目。 Small、41.0 41.0
label String 検索条件の表示ラベル。 Small、41.0 41.0
locked Boolean 検索条件がロックされているかどうかを示す項目。 Small、41.0 41.0
operator String 検索条件の演算子。 Small、41.0 41.0
value String 検索条件の値。 Small、41.0 41.0
GridLayoutStyleRepresentation
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
background​Color String レイアウトの背景色。 Small、37.0 37.0
cellSpacingX Integer グリッドセル間の横方向の間隔。 Small、37.0 37.0
cellSpacingY Integer グリッドセル間の縦方向の間隔。 Small、37.0 37.0
gutterColor String レイアウトの余白の色。 Small、39.0 39.0
image Asset​Reference​Representation 名前と名前空間を含む画像表示。 Small、39.0 39.0
widgetStyle Grid​Layout​Widget​Style​Representation すべてのレイアウトのウィジェットに適用されるデフォルトのスタイル設定。 Small、36.0 36.0 ～ 36.0
GridLayoutWidgetStyleRepresentation
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
background​Color String ウィジェットの背景色。6 文字の 16 進文字列です。例: #012345。 Small、36.0 36.0
borderColor String ウィジェットの境界線の色。6 文字の 16 進文字列です。例: #012345。 Small、36.0 36.0
borderEdges Connect​Wave​Border​Edge​Type​Enum[] 境界線を表示する辺 (All、Bottom、Left、Right、または Top)。 Small、36.0 36.0
borderRadius Object ウィジェットの境界線の半径。 Small、36.0 36.0
borderWidth Object ウィジェットの境界線の幅。 Small、36.0 36.0
bottomPadding Integer モバイルクライアントに表示される場合のウィジェットの下パディングの量。 Small、36.0 36.0
leftPadding Integer モバイルクライアントに表示される場合のウィジェットの左パディングの量。 Small、36.0 36.0
rightPadding Integer モバイルクライアントに表示される場合のウィジェットの右パディングの量。 Small、36.0 36.0
topPadding Integer モバイルクライアントに表示される場合のウィジェットの上パディングの量。 Small、36.0 36.0
GridLayoutRepresentation
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
maxWidth Integer ダッシュボードを拡大可能な最大幅をユーザが指定できるようにします。 Small、38.0 38.0
name String このレイアウトの名前。 Small、36.0 36.0
numColumns Integer カスタマイズ可能なダッシュボードグリッドレイアウトの列数を追加します。 Small、38.0 38.0
pages Grid​Layout​Page​Representation[] レイアウト内のウィジェットのページのリスト。 Small、36.0 36.0
rowHeight Connect​Wave​Row​Height​Enum グリッドセルの行の高さ (Fine または Normal)。 Small、39.0 39.0
selectors String [] このレイアウトが適用されるセレクタのリスト。 Small、36.0 36.0
style Grid​Layout​Style​Representation レイアウトのスタイル設定。 Small、37.0 37.0
version Double このレイアウトのバージョン。 Small、36.0 36.0
widgetStyle Grid​Layout​Widget​Style​Representation レイアウト内のウィジェットに適用されるデフォルトのスタイル設定。 Small、36.0 36.0 ～ 37.0
GridLayoutPageRepresentation
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
widgets Grid​Layout​Widget​Representation[] ページ内のウィジェット。 Small、36.0 36.0
GridLayoutWidgetRepresentation
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
background​Image String ウィジェットの背景画像。 Small、36.0 36.0
colspan Integer このウィジェットがまたがるグリッドレイアウト列数。 Small、36.0 36.0
column Integer このウィジェットが配置される列。 Small、36.0 36.0
name String ウィジェットの名前。 Small、36.0 36.0
row Integer このウィジェットが配置される行。 Small、36.0 36.0
rowspan Integer このウィジェットがまたがるグリッドレイアウト行数。 Small、36.0 36.0
widgetStyle Grid​Layout​Widget​Style​Representation ウィジェットのスタイル。 Small、36.0 36.0
Layout
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
device String このダッシュボードを表示するデバイス。値は次のとおりです。
  • Applewatch
  • Default
  • External
  • Ipad
  • Iphone
 Small、36.0 36.0
orientation String このダッシュボードのレイアウトの方向。値は次のとおりです。
  • Landscape
  • Portrait
 Small、36.0 36.0
pages Layout Page[] ダッシュボードで使用できるレイアウトページのリスト。 Small、36.0 36.0
version Double ダッシュボードのレイアウトのバージョン。 Small、36.0 36.0
Layout Page
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
rows String [] レイアウトページに関連付けられた行。 Small、36.0 36.0
Step

ステップの異なるタイプの表現。使用可能なプロパティは、ステップのタイプによって異なります。

ステップタイプ 有効なプロパティ
複数クエリステップ columns, datasets, globalQuery, isFacet, isGlobal, label, selectMode, start, type, useGlobal, and visualizationParameters
クエリステップ datasets, isFacet, isGlobal, label, query, selectMode, start, type, useGlobal, and visualizationParameters
SAQL ステップ datasets, groups, isFacet, isGlobal, label, numbers, query, selectMode, start, strings, type, useGlobal, and visualizationParameters
SOQL ステップ groups, isFacet, label, numbers, query, selectMode, start, strings, type, useGlobal
静的 Flex ステップ datasets, dimensions, groups, isFacet, isGlobal, label, selectMode, start, strings, type, useGlobal, values
静的ステップ datasets, dimensions, isFacet, isGlobal, label, selectMode, start, type, useGlobal, values, and visualizationParameters
ステップのプロパティ
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
columns Column[] このステップで実行するクエリ。 Small、36.0 36.0
datasets Asset​Reference​Representation[] このステップで使用されたデータセットのリスト。 Small、36.0 36.0
dimensions String [] 静的ステップのディメンションのリスト。 Small、36.0 36.0
globalQuery >Query すべての列に対するクエリの上書き。 Small、36.0 36.0
isFacet Boolean このステップが他のステップにファセットされているかどうかを示します。 Small、36.0 36.0
isGlobal Boolean このステップがダッシュボードの他のステップまたはウィジェットにファセットされることが可能なグローバル検索条件であるかどうかを示します。 Small、36.0 36.0
groups String [] 射影された列の名前のリストであり、結果はステップのためにグループ化されます。 Small、39.0 39.0
label String ステップの表示ラベル。 Small、39.0 39.0
numbers String [] ステップの射影された列名のリスト。 Small、39.0 39.0
query Query このステップで実行するクエリ。 Small、36.0 36.0
selectMode String ステップの作成に使用された選択モード (multi、multirequired、none、single、または singlerequired)。 Small、36.0 36.0
start String ステップの開始値。 Small、36.0 36.0
strings String [] ステップの射影された列名のリスト。 Small、39.0 39.0
type String ダッシュボードステップのタイプ。値は次のとおりです。
  • Aggregate
  • AggregateFlex
  • Grain
  • Multi
  • Saql
  • Soql
  • Static
  • StaticFlex
 Small、36.0 36.0
useGlobal Boolean true の場合、ステップはグローバルステップに関連付けられます。 Small、39.0 39.0
values String [] 静的ステップの値のリスト。 Small、36.0 36.0
visualization​Parameters Step Visualization Parameters ステップの視覚化のパラメータ。 Small、36.0 36.0
Step Visualization Parameters
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
options Lens Visualization Options 異なるステップの視覚化の設定オプション。 Small、36.0 36.0
parameters Object 有効なウィジェットパラメータ (ウィジェットのタイプに基づく)。 Small、40.0 40.0
type Connect​Wave​Widget​Type​Enum ウィジェットのタイプ。値は次のとおりです。
  • Box
  • Chart
  • CompareTable
  • Container
  • DateSelector
  • GlobalFilters
  • Image
  • Link
  • ListSelector
  • Number
  • PillBox
  • RangeSelector
  • Table
  • Text
  • Url
  • ValuesTable
 Small、40.0 40.0
visualizationType String 視覚化の種別。値は次のとおりです。
  • calheatmap: カレンダーヒートマップ
  • comparisontable: 比較テーブル
  • heatmap: ヒートマップ
  • hbar: 棒
  • hbarhdot: 横方向のドットプロット
  • matrix: マトリックス
  • parallelcoords: 平行座標
  • pie: ドーナツ
  • pivottable: ピボットテーブル
  • scatter: 散布図
  • stackhbar: 積み上げ横棒
  • stackvbar: 積み上げ縦棒
  • time: タイムライン
  • valuestable: 値テーブル
  • vbar: 列
  • vdot: 縦方向のドットプロット
 Small、36.0 36.0
Dashboard Widget
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
parameters ウィジェットのパラメータ 有効なウィジェットパラメータ (ウィジェットのタイプに基づく)。 Small、36.0 36.0
position Widget Position ウィジェットの位置情報。 Small、36.0 36.0
type String ウィジェットのタイプ。値は次のとおりです。
  • Box
  • Chart
  • CompareTable
  • Container
  • DateSelector
  • GlobalFilters
  • Image
  • Link
  • ListSelector
  • Number
  • PillBox
  • RangeSelector
  • Table
  • Text
  • Url
  • ValuesTable
 Small、36.0 36.0
ウィジェットのパラメータ

ウィジェットの有効なパラメータ。使用可能なプロパティは、ウィジェットのタイプによって異なります。

ウィジェットタイプ 有効なプロパティ
ボックス backgroundColor, borderColor, imageUrl, selectModeOverride, and stretch
比較テーブル exploreLink, maxColumnWidth, minColumnWidth, selectModeOverride, step, and totals
コンテナ alignmentX, alignmentY, documentId, fit, image, exploreLink, maxColumnWidth, minColumnWidth, selectModeOverride, step, and totals
日付セレクタ calendarTypeSwitchingAllowed, defaultAbsoluteMode, defaultFiscalMode, expanded, instant, modeSwitchingAllowed, selectModeOverride, step, and title
グローバル検索条件 step and selectModeOverride
画像 alignmentX, alignmentY, documentId, fit, image, step and selectModeOverride
リンク destination, destinationLink, destinationType, fontSize, includeState, selectModeOverride, text, textAlignment, textColor, and visualizationType
リストセレクタ compact, displayTemplate, expanded, exploreLink, instant, measureField, selectModeOverride, step, and title
数値 compact, exploreLink, fontSize, measureField, numberColor, numberSize, selectModeOverride, step, textAlignment, textColor, title, titleColor, titleSize
ピルボックス compact, displayTemplate, exploreLink, measureField, selectModeOverride, step, and title
範囲セレクタ instant, selectModeOverride, step, and title
テキスト fontSize, selectModeOverride, text, textAlignment, and textColor
テーブル customBulkActions, exploreLink, fixedColumnWidth, maxColumnWidth, minColumnWidth, mode, pivoted, selectModeOverride, step, totals
Url selectModeOverride, type, url, and videoSize
値テーブル exploreLink, hideHeaderColumn, maxColumnWidth, minColumnWidth, selectModeOverride, step, and totals
ウィジェットのプロパティ

使用可能なプロパティは、ウィジェットのタイプによって異なります。

プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
alignmentX Connect​Wave​Horizontal​Alignment​Enum 画像の横方向の配置。有効な値は、Left、Center、Right です。 Small、37.0 37.0
alignmentY Connect​Wave​Vertical​Alignment​Enum 画像の縦方向の配置。有効な値は、Top、Center、Bottom です。 Small、37.0 37.0
backgroundColor String ウィジェットの背景色。 Small、36.0 36.0
borderColor String ウィジェットの境界線の色。 Small、36.0 36.0
calendar​Type​Switching​Allowed Boolean ウィジェットでカレンダーの種別を切り替えられるかどうかを示します。 Small、39.0 39.0
compact Boolean ウィジェットがコンパクトであるかどうかを示します。 Small、36.0 36.0
customBulkActions Custom​Bulk​Action​Representation このウィジェットのカスタム一括アクション。 Small、39.0 39.0
default​Absolute​Mode Boolean デフォルトの日付モードを示します。 Small、39.0 39.0
default​Fiscal​Mode Boolean デフォルトのカレンダー種別を示します。 Small、39.0 39.0
destination String リンク先。 Small、36.0 36.0
destinationLink Asset​Reference​Representation このリンクの対象 (ダッシュボード、レンズ、ステップ) の参照。 Small、39.0 39.0
destinationType String リンクが参照するアセットタイプ。値は次のとおりです。
  • Dashboard
  • Explore
  • Lens
  • Url
 Small、36.0 36.0
displayTemplate String ウィジェットレベル射影の表示テンプレート。 Small、39.0 39.0
documentId String 画像 (Salesforce のドキュメント API を使用してアップロードした画像) のドキュメント ID. Small、37.0 37.0
expanded Boolean ウィジェットが展開済みであるかどうかを示します。 Small、36.0 36.0
exploreLink Boolean exploreLink がオンであるかどうかを示します。 Small、36.0 36.0
fit Connect​Wave​Image​Fit​Type​Enum このウィジェット内での画像の適合。有効な値は、Original、Tile、Cover、Strech です。 Small、37.0 37.0
fixedColumnWidth Integer このテーブルウィジェットの固定列幅。 Small、40.0 40.0
fontSize Integer ウィジェットのフォントサイズ。 Small、36.0 36.0
hideHeaderColumn Boolean 凡例を非表示にするかどうかを示します。 Small、36.0 36.0
image Asset​Reference​Representation 名前と名前空間を含む画像表示。 Small、39.0 39.0
imageUrl String 15 文字または 18 文字の Salesforce ドキュメント ID。 Small、36.0 36.0
includeState Boolean 状態を含めるかどうかを示します。 Small、36.0 36.0
instant Boolean リストセレクタがインスタントであるかどうかを示します。 Small、36.0 36.0
legend Boolean 凡例を表示するかどうかを示します。 Small、36.0 36.0
legendHideHeader Boolean 凡例のヘッダーを非表示にするかどうかを示します。 Small、36.0 36.0
legendWidth Integer 凡例の幅。 Small、36.0 36.0
maxColumnWidth Integer ヘッダー列の最大幅。 Small、36.0 36.0
measureField String このウィジェットに関連付けられた基準項目。 Small、36.0 36.0
minColumnWidth Integer ヘッダー列の最小幅。 Small、36.0 36.0
miniBars Integer true の場合、バーの幅は動的であり、バーのテキストとヘッダーの表示ラベルは表示されません。 Small、36.0 36.0
mode Connect​Wave​Table​Mode​Enum このウィジェットのテーブルモード (FitToContainer、Fixed、Variable のいずれか)。 Small、40.0 40.0
mode​Switching​Allowed Boolean ウィジェットで 2 つの日付モード間を切り替えることができるかどうかを示します。 Small、39.0 39.0
multiMetrics Boolean true の場合、同じグラフに複数の基準が横並びで表示されます。false (トレリス) の場合、すべての基準が個別のグラフになります。デフォルトは false です。 Small、36.0 36.0
normalize Boolean そのカテゴリの割合に比例するようにデータ図形の位置とサイズを調整するかどうかを示します。 Small、36.0 36.0
numberColor String このウィジェット内の数値の色。 Small、36.0 36.0
numberSize Object 数字のサイズ。 Small、36.0 36.0
pivoted Boolean テーブルをピボットとして表示するかどうかを示す値。 Small、39.0 39.0
select​Mode​Override String ステップの作成に使用された選択モード (multi、multirequired、none、single、singlerequired)。 Small、36.0 36.0
splitAxis Boolean true の場合、各基準で 1 つの軸が使用されます。false の場合、すべての基準で同じ軸が使用されます。 Small、36.0 36.0
sqrt Boolean 横軸と縦軸に平方根スケールを使用するかどうかを示します。 Small、36.0 36.0
step String このウィジェットに関連付けられたステップ名。 Small、36.0 36.0
stretch Boolean ウィジェットを引き伸ばすかどうかを示します。 Small、36.0 36.0
text String テキストの値。 Small、36.0 36.0
textAlignment String テキストの配置。値は次のとおりです。
  • Center
  • Left
  • Right
 Small、36.0 36.0
textColor String ウィジェットのテキストの色。 Small、36.0 36.0
title String ウィジェットのタイトル。 Small、36.0 36.0
titleColor String このウィジェット内のタイトルの色。 Small、36.0 36.0
titleSize Object タイトルテキストのサイズ。 Small、36.0 36.0
totals Boolean 合計を使用するかどうかを示します。 Small、36.0 36.0
trellis Boolean true の場合、最後のグループがトレリスのディメンションとして処理されます。ディメンションのすべての個別値がグラフになります。 Small、36.0 36.0
type String ウィジェットの Analytics URL のタイプ。値は次のとおりです。
  • Youtube
 Small、36.0 36.0
url String ウィジェットの接続 URI。 Small、36.0 36.0
videoSize String この URL が指し示す動画のサイズ。 Small、36.0 36.0
visualizationType String このウィジェットで使用された視覚化の種別。値は次のとおりです。
  • calheatmap: カレンダーヒートマップ
  • comparisontable: 比較テーブル
  • heatmap: ヒートマップ
  • hbar: 棒
  • hbarhdot: 横方向のドットプロット
  • matrix: マトリックス
  • parallelcoords: 平行座標
  • pie: ドーナツ
  • pivottable: ピボットテーブル
  • scatter: 散布図
  • stackhbar: 積み上げ横棒
  • stackvbar: 積み上げ縦棒
  • time: タイムライン
  • valuestable: 値テーブル
  • vbar: 列
  • vdot: 縦方向のドットプロット
 Small、36.0 36.0
Widget Position
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
h String ウィジェットの高さ。 Small、36.0 36.0
w String ウィジェットの幅。 Small、36.0 36.0
x Integer ウィジェットの x インデックス。 Small、36.0 36.0
y Integer ウィジェットの y インデックス。 Small、36.0 36.0
zIndex Integer ウィジェットの z インデックス。 Small、36.0 36.0
PATCH および POST のリクエストボディ (DashboardInputRepresentation)。POST メソッドは /wave/dashboards でサポートされています。
DashboardInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
state Dashboard​State​Input​Representation ダッシュボードの状態。 PATCH では省略可能、POST では必須 36.0
folder Asset​Reference​Input​Representation このダッシュボードが保存されているフォルダ。 PATCH では省略可能、POST では必須 36.0
description String アセットの簡単な説明。 省略可能 36.0
label String アセットの表示ラベル。 PATCH では省略可能、POST では必須 36.0
mobileDisabled Boolean ダッシュボードがモバイルで無効になっているかどうか。 41.0
name String アセットの名前。 省略可能 36.0
DashboardStateInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
data​Source​Links Dashboard​Data​Source​Link​Input​Representation[] このダッシュボードの一部として使用されたデータソースリンクのリスト。 39.0
filters Filter​Item​Input​Representation[] このダッシュボードで適用されるデータソース検索条件のリスト。 41.0
grid​Layout​Style Grid​Layout​Style​Input​Representation このダッシュボードの一部として使用された GridLayouts の全体的なスタイル設定。 省略可能 36.0 ～ 37.0
gridLayouts List (Grid​Layout​Input​Representation[]) このダッシュボードの一部として使用された Grid​Layout​Inpu​tRepresentation オブジェクトのリスト。存在する場合、「layouts」は設定できません。 省略可能 36.0
layouts List (Layout​Input​Representation[]) このダッシュボードの一部として使用された Layout​Input​Representation オブジェクトのリスト。 省略可能 36.0
steps Map (String 型のキー) ( Aggregate​Flex​Query​Step​Input​Representation、Aggregate​Query​Step​Input​Representation、Grain​Query​Step​Input​Representation、Multi​Query​Step​Input​Representation、Saql​Step​Input​Representation、Soql​Step​Input​Representation) Static​Flex​Step​Input​Representation、Static​Step​Input​Representation その名前のキー付きでこのダッシュボードの作成に使用されたすべてのステップの対応付け。 省略可能 36.0
widget​Style Grid​Layout​Widget​Style​Input​Representation このダッシュボードのウィジェットに適用されるデフォルトのスタイル設定。 省略可能 37.0
widgets Map (String 型のキー) (Dashboard​Widget​Input​Representation) その名前のキー付きでこのダッシュボードの作成に使用されたすべての Dashboard​Widget​Input​Representation オブジェクトの対応付け。 省略可能 36.0
DashboardDataSourceLinkInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
fields Dashboard​Data​Source​Field​Input​Representation[] データソースリンクで接続されている項目のリスト 39.0
label String データソースリンクの表示ラベル 39.0
name String データソースリンクの名前 39.0
DashboardDataSourceFieldInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
data​Source​Name String データソースの API 参照名。 39.0
data​Source​Namespace String データセットのアセット名を修飾する名前空間 39.0
data​Source​Type Connect​Wave​Data​Source​Type​Enum データソースの種類 (Saql または Static)。 39.0
fieldName String データソースの項目の名前 39.0
FilterItemInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
dataset Asset​Reference​Input​Representation 検索条件が適用されるデータソース 41.0
fields String [] 検索条件の項目のリスト 41.0
hidden Boolean プレビューモードで検索条件が非表示かどうかを示す項目 41.0
label String 検索条件の表示ラベル 41.0
locked Boolean 検索条件がロックされているかどうかを示す項目 41.0
operator String 検索条件の演算子 41.0
value String 検索条件の値 41.0
AssetReferenceInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
id String アセットの ID。 省略可能 * 36.0
name String アセットの API 参照名。 省略可能 * 36.0
namespace String アセット名を修飾する名前空間。デフォルトは、現在の組織の名前空間です。名前空間が設定されている Developer Edition 組織以外のすべての組織では、これは「空の名前空間」になります。そのため、インストール済み管理パッケージのデータセットを参照する場合にのみ名前空間を設定します。 コンテキストによって異なる 37.0

* ダッシュボードステップのデータセットで使用する場合は、名前を指定する必要があります。アセットに名前空間がある場合は、その名前空間も指定する必要があります。この場合、ID は無視されるため指定しないでください。その他のすべての場合は、名前や名前空間ではなく ID を指定する必要があります。

GridLayoutStyleInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
background​Color String レイアウトの背景色。 37.0
cell​SpacingX Integer グリッドセル間の横方向の間隔。 37.0
cell​SpacingY Integer グリッドセル間の縦方向の間隔。 37.0
gutterColor String レイアウトの余白の色。 39.0
image Asset​Reference​Representation 名前と名前空間を含む画像表示。 Small、39.0 39.0
widgetStyle Grid​Layout​Widget​Style​Input​Representation すべてのレイアウトのウィジェットに適用されるデフォルトのスタイル設定。 省略可能 36.0
AggregateFlexQueryStepInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
query Query​Input​Representation このステップの作成に使用された SAQL。 PATCH では省略可能、POST では必須 36.0
datasets Asset​Reference​Input​Representation[] このステップで使用されたすべてのデータセット別名のリスト。 省略可能 36.0
isFacet Boolean このステップが他のステップに関連付け/ファセットされているかどうかを判断します。 省略可能 36.0
isGlobal Boolean true の場合、このステップはダッシュボードの他のステップ/ウィジェットにファセットされることが可能なグローバル検索条件です。 省略可能 36.0
label String ステップの表示ラベル。 39.0
selectMode Connect​Wave​Select​Mode​Enum 使用された選択モード (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
start String ステップの開始値。 省略可能 36.0
type Connect​Wave​Dashboard​Step​Type​Enum ダッシュボードステップのタイプ (Aggregate、AggregateFlex、Grain、Multi、Saql、Soql、Static、または StaticFlex)。 PATCH では省略可能、POST では必須 36.0
useGlobal Boolean true の場合、ステップはグローバルステップに関連付けられます。 省略可能 36.0
visualization​Parameters Step​Visualization​Parameters​Input​Representation ダッシュボードステップの視覚化パラメータ。 省略可能 36.0
AggregateQueryStepInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
query Query​Input​Representation このステップの作成に使用された SAQL。 PATCH では省略可能、POST では必須 36.0
datasets Asset​Reference​Input​Representation[] このステップで使用されたすべてのデータセット別名のリスト。 省略可能 36.0
isFacet Boolean このステップが他のステップに関連付け/ファセットされているかどうかを判断します。 省略可能 36.0
isGlobal Boolean true の場合、このステップはダッシュボードの他のステップ/ウィジェットにファセットされることが可能なグローバル検索条件です。 省略可能 36.0
label String ステップの表示ラベル。 39.0
selectMode Connect​Wave​Select​Mode​Enum 使用された選択モード (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
start String ステップの開始値。 省略可能 36.0
type Connect​Wave​Dashboard​Step​Type​Enum ダッシュボードステップのタイプ (Aggregate、AggregateFlex、Grain、Multi、Saql、Soql、Static、または StaticFlex)。 PATCH では省略可能、POST では必須 36.0
useGlobal Boolean true の場合、ステップはグローバルステップに関連付けられます。 省略可能 36.0
visualization​Parameters Step​Visualization​Parameters​Input​Representation ダッシュボードステップの視覚化パラメータ。 省略可能 36.0
GrainQueryStepInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
query Query​Input​Representation このステップで実行する SAQL クエリ。 PATCH では省略可能、POST では必須 36.0
datasets Asset​Reference​Input​Representation[] このステップで使用されたすべてのデータセットのリスト。 省略可能 36.0
isFacet Boolean このステップが他のステップに関連付け/ファセットされているかどうかを判断します。 省略可能 36.0
isGlobal Boolean true の場合、このステップはダッシュボードの他のステップ/ウィジェットにファセットされることが可能なグローバル検索条件です。 省略可能 36.0
label String ステップの表示ラベル。 39.0
selectMode Connect​Wave​Select​Mode​Enum 使用された選択モード (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
start String ステップの開始値。 省略可能 36.0
type Connect​Wave​Dashboard​Step​Type​Enum ダッシュボードステップのタイプ (Aggregate、AggregateFlex、Grain、Multi、Saql、Soql、Static、または StaticFlex)。 PATCH では省略可能、POST では必須 36.0
useGlobal Boolean true の場合、ステップはグローバルステップに関連付けられます。 省略可能 36.0
visualization​Parameters Step​Visualization​Parameters​Input​Representation ダッシュボードステップの視覚化パラメータ。 省略可能 36.0
MultiQueryStepInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
columns Column​Input​Representation[] 比較テーブルの列のリスト。 省略可能 36.0
globalQuery Query​Input​Representation すべての列に対するクエリの上書き。 省略可能 36.0
datasets Asset​Reference​Input​Representation[] このステップで使用されたすべてのデータセット別名のリスト。 省略可能 36.0
isFacet Boolean このステップが他のステップに関連付け/ファセットされているかどうかを判断します。 省略可能 36.0
isGlobal Boolean true の場合、このステップはダッシュボードの他のステップ/ウィジェットにファセットされることが可能なグローバル検索条件です。 省略可能 36.0
label String ステップの表示ラベル。 39.0
selectMode Connect​Wave​Select​Mode​Enum 使用された選択モード (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
start String ステップの開始値。 省略可能 36.0
type Connect​Wave​Dashboard​Step​Type​Enum ダッシュボードステップのタイプ (Aggregate、AggregateFlex、Grain、Multi、Saql、Soql、Static、または StaticFlex)。 PATCH では省略可能、POST では必須 36.0
useGlobal Boolean true の場合、ステップはグローバルステップに関連付けられます。 省略可能 36.0
visualization​Parameters Step​Visualization​Parameters​Input​Representation ダッシュボードステップの視覚化パラメータ。 省略可能 36.0
SaqlStepInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
broadcast​Facet Boolean ステップでファセットをブロードキャストすべきかどうか。 41.0
isFacet Boolean このステップが他のステップに関連付け/ファセットされているかどうかを判断します。 36.0 ～ 40.0
receive​Facet Boolean ステップでファセットを受信すべきかどうか。 41.0
SoqlStepInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
groups String [] 射影された列の名前であり、結果はステップのためにグループ化されます。 39.0
label String ステップの表示ラベル。 39.0
numbers String [] ステップの射影された列名 39.0
query String このステップの作成に使用した SOQL 39.0
selectMode Connect​Wave​Select​Mode​Enum 使用された選択モード (Multi、MultiRequired、None、Single、または SingleRequired)。 39.0
start String ステップの開始値。 39.0
strings String [] ステップの射影された列名 39.0
type Connect​Wave​Dashboard​Step​Type​Enum ダッシュボードステップのタイプ (Aggregate、AggregateFlex、Grain、Multi、Saql、Soql、Static、または StaticFlex)。 36.0
useGlobal Boolean true の場合、ステップはグローバルステップに関連付けられます。 39.0
visualization​Parameters Step​Visualization​Parameters​Input​Representation ダッシュボードステップの視覚化パラメータ。 36.0
StaticFlexStepInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
datasets Asset​Reference​Input​Representation[] このステップで使用されたすべてのデータセット別名のリスト。 省略可能 36.0
dimensions String [] 静的ステップのディメンションのリスト。 省略可能 36.0
groups String [] 射影された列の名前であり、結果はステップのためにグループ化されます。 39.0
isFacet Boolean このステップが他のステップに関連付け/ファセットされているかどうかを判断します。 省略可能 38.0
isGlobal Boolean true の場合、このステップはダッシュボードの他のステップ/ウィジェットにファセットされることが可能なグローバル検索条件です。 省略可能 38.0
label String ステップの表示ラベル。 39.0
numbers String [] ステップの射影された列名 39.0
selectMode Connect​Wave​Select​Mode​Enum 使用された選択モード (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 38.0
start String ステップの開始値。 省略可能 38.0
strings String [] ステップの射影された列名 39.0
type Connect​Wave​Dashboard​Step​Type​Enum ダッシュボードステップのタイプ (Aggregate、AggregateFlex、Grain、Multi、Saql、Soql、Static、または StaticFlex)。 PATCH では省略可能、POST では必須 36.0
useGlobal Boolean true の場合、ステップはグローバルステップに関連付けられます。 省略可能 38.0
values String [] このステップの値のリスト。 省略可能 36.0
visualization​Parameters Step​Visualization​Parameters​Input​Representation ダッシュボードステップの視覚化パラメータ。 省略可能 38.0
StaticStepInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
datasets Asset​Reference​Input​Representation[] このステップで使用されたすべてのデータセット別名のリスト。 省略可能 36.0
dimensions String [] 静的ステップのディメンションのリスト。 省略可能 36.0
isFacet Boolean このステップが他のステップに関連付け/ファセットされているかどうかを判断します。 省略可能 36.0
isGlobal Boolean true の場合、このステップはダッシュボードの他のステップ/ウィジェットにファセットされることが可能なグローバル検索条件です。 省略可能 36.0
label String ステップの表示ラベル。 39.0
selectMode Connect​Wave​Select​Mode​Enum 使用された選択モード (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
start String ステップの開始値。 省略可能 36.0
type Connect​Wave​Dashboard​Step​Type​Enum ダッシュボードステップのタイプ (Aggregate、AggregateFlex、Grain、Multi、Saql、Soql、Static、または StaticFlex)。 PATCH では省略可能、POST では必須 36.0
useGlobal Boolean true の場合、ステップはグローバルステップに関連付けられます。 省略可能 36.0
values String [] このステップの値のリスト。 省略可能 36.0
visualization​Parameters Step​Visualization​Parameters​Input​Representation ダッシュボードステップの視覚化パラメータ。 省略可能 36.0
ColumnInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
format Connect​Wave​Column​Format​Enum この列の形式 (CurrencyCents、CurrencyDollars、または Percentage)。 省略可能 36.0
header String この列のヘッダーテキスト。 省略可能 36.0
hidden Boolean この列が非表示かどうか。 省略可能 36.0
query Query​Input​Representation この比較表の作成に使用された SAQL。 省略可能 36.0
showBars Boolean この列のバーを表示するかどうか。 省略可能 36.0
sort Connect​Wave​Column​Sort​Enum この列の並び替え順 (Ascending、Descending、InnerAscending、InnerDescending、または None)。 省略可能 36.0
QueryInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
query String SAQL クエリ。 PATCH では省略可能、POST では必須 36.0
version Double このクエリ言語構成要素が属するバージョン。 PATCH では省略可能、POST では必須 36.0
StepVisualizationParametersInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
options Lens​Visualization​Options​Input​Representation このステップと関連付けられた視覚化オプション。 省略可能 36.0
parameters Object 有効なウィジェットパラメータ (ウィジェットのタイプに基づく)。 40.0
type Connect​Wave​Widget​Type​Enum ウィジェットのタイプ。値は次のとおりです。
  • Box
  • Chart
  • CompareTable
  • Container
  • DateSelector
  • GlobalFilters
  • Image
  • Link
  • ListSelector
  • Number
  • PillBox
  • RangeSelector
  • Table
  • Text
  • Url
  • ValuesTable
 40.0
visualization​Type String 視覚化の種別 (Calendar​Heat​Map、Combo、Comparison​Table、Heat​Map、Horizontal​Bar、Horizontal​Dot、Matrix、Parallel​Coordinates、Pie、Pivot​Table、Scatter、Stack​Waterfall、Stacked​Horizontal​Bar、Stacked​Horizontal​Bar、Time、Values​Table、Vertical​Bar、Vertical​Dot、または Waterfall)。 省略可能 36.0
LensVisualizationOptionsInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
fit Boolean そのカテゴリの割合に比例するようにデータ図形の位置とサイズを調整します。 省略可能 36.0
hideHeaderColumn Boolean ヘッダー列を表示するか否かを示す値。 省略可能 36.0
legend Boolean 凡例を表示するか否かを示す値。 省略可能 36.0
legendHideHeader Boolean 凡例を非表示にするかどうかを示す値。 省略可能 36.0
legendWidth Integer 凡例の幅。 省略可能 36.0
maxColumnWidth Integer ヘッダー列の最大幅。 省略可能 36.0
minColumnWidth Integer ヘッダー列の最小幅。 省略可能 36.0
miniBars Integer ミニバーの幅 (使用されている場合)。 省略可能 36.0
multiMetrics Boolean true の場合、トレリス (デフォルト) とは異なり、同じグラフに複数の基準が横並びで表示されます。トレリスの場合、すべての基準が個別のグラフになります。 省略可能 36.0
normalize Boolean そのカテゴリの割合に比例するようにデータ図形の位置とサイズを調整します。 省略可能 36.0
splitAxis Boolean true の場合、各基準で 1 つの軸が使用されます。false の場合は、すべての基準で同じ軸が使用されます。 省略可能 36.0
sqrt Boolean 横/縦軸が平方根スケールであることを示す値。 省略可能 36.0
totals Boolean テーブルに合計を表示するか否かを示す値。 省略可能 36.0
trellis Boolean true の場合、最後のグループがトレリスのディメンションとして処理されます。ディメンションのすべての個別値がグラフになります。 省略可能 36.0
GridLayoutInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
maxWidth Integer ダッシュボードを拡大可能な最大幅。 省略可能 38.0
name String このレイアウトの名前。 必須 36.0
numColumns Integer カスタマイズ可能なダッシュボードグリッドレイアウトの列数。 省略可能 38.0
pages Grid​Layout​Page​Input​Representation[] レイアウト内のウィジェットのページのリスト。 省略可能 36.0
rowHeight Connect​Wave​Row​Height​Enum グリッドレイアウトのセルの行の高さ (Fine または Normal)。 39.0
selectors String [] このレイアウトが適用されるセレクタのリスト。 省略可能 36.0
style Grid​Layout​Style​Input​Representation レイアウトのスタイル設定。 省略可能 37.0
version Double このレイアウトのバージョン。 必須 36.0
widgetStyle Grid​Layout​Widget​Style​Input​Representation レイアウト内のウィジェットに適用されるデフォルトのスタイル設定。 省略可能 36.0 ～ 37.0
GridLayoutPageInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
widgets Grid​Layout​Widget​Input​Representation[] ページ内のウィジェットのリスト。 必須 36.0
GridLayoutWidgetInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
background​Image String ウィジェットの背景画像。 省略可能 36.0
colspan Integer このウィジェットがまたがるグリッドレイアウト列数。 必須 36.0
column Integer このウィジェットが配置される列。 必須 36.0
name String ウィジェットの名前。 必須 36.0
row Integer このウィジェットが配置される行。 必須 36.0
rowspan Integer このウィジェットがまたがるグリッドレイアウト行数。 必須 36.0
widgetStyle Grid​Layout​Widget​Style​Input​Representation ウィジェットのスタイル。 必須 36.0
GridLayoutWidgetStyleInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
background​Color String ウィジェットの背景色。6 文字の 16 進文字列です。例: #012345。 必須 36.0
border​Color String ウィジェットの境界線の色。6 文字の 16 進文字列です。例: #012345。 必須 36.0
border​Edges Connect​Wave​Border​Edge​Type​Enum[] 境界線を表示する辺のリスト (All、Bottom、Left、Right、または Top)。 必須 36.0
border​Radius Integer ウィジェットの境界線の半径。 省略可能 36.0
border​Width Integer ウィジェットの境界線の幅。 必須 36.0
bottom​Padding Integer モバイルクライアントに表示される場合のウィジェットの下パディングの量。 省略可能 36.0
left​Padding Integer モバイルクライアントに表示される場合のウィジェットの左パディングの量。 省略可能 36.0
right​Padding Integer モバイルクライアントに表示される場合のウィジェットの右パディングの量。 省略可能 36.0
top​Padding Integer モバイルクライアントに表示される場合のウィジェットの上パディングの量。 省略可能 36.0
LayoutInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
device Connect​Wave​Layout​Device​Type​Enum このダッシュボードを表示するデバイス (Applewatch、Default、External、Ipad、Iphone)。 省略可能 36.0
orientation Connect​Wave​Layout​Orientation​Type​Enum このダッシュボードのレイアウトの方向 (Landscape または Portrait)。 省略可能 36.0
pages Layout​Page​Input​Representation[] ダッシュボードで使用できる Layout​Page​Input​Representation オブジェクトのリスト。 省略可能 36.0
version Double ダッシュボードのレイアウト表現のバージョン。 省略可能 36.0
LayoutPageInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
rows String [] レイアウトページに関連付けられた行を取得します。 省略可能 36.0
DashboardWidgetInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
parameters Object

Box​Widget​Parameters​Input​Representation、Compare​Table​Widget​Parameters​Input​Representation、Container​Widget​Parameters​Input​Representation、Date​Selector​Widget​Parameters​Input​Representation、Global​Filters​Widget​Parameters​Input​Representation、Image​Widget​Parameters​Input​Representation、Link​Widget​Parameters​Input​Representation、List​Selector​Widget​Parameters​Input​Representation、Number​Widget​Parameters​Input​Representation、Pill​Box​Widget​Parameters​Input​Representation、Range​Selector​Widget​Parameters​Input​Representation、Table​Widget​Parameters​Input​Representation、Text​Widget​Parameters​Input​Representation、Url​Widget​Parameters​Input​Representation、または Values​Table​Widget​Parameters​Input​Representation

 有効なウィジェットパラメータ (ウィジェットのタイプに基づく)。 PATCH では省略可能、POST では必須 36.0
position Widget​Position​Input​Representation ダッシュボード上のウィジェットの位置情報。 PATCH では省略可能、POST では必須 36.0
type Connect​Wave​Widget​Type​Enum ウィジェットのタイプ。値は次のとおりです。
  • Box
  • Chart
  • CompareTable
  • Container
  • DateSelector
  • GlobalFilters
  • Image
  • Link
  • ListSelector
  • Number
  • PillBox
  • RangeSelector
  • Table
  • Text
  • Url
  • ValuesTable
 PATCH では省略可能、POST では必須 36.0
BoxWidgetParametersInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
background​Color String ボックスウィジェットで使用される背景色。 省略可能 36.0
border​Color String ボックスウィジェットで使用される境界線の色。 省略可能 36.0
image​Url String ボックスウィジェットで使用される画像の DocumentId。 省略可能 36.0
stretch Boolean ボックスウィジェットを引き伸ばすか否かを示す値。 省略可能 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum 選択モードの上書き (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
CompareTableWidgetParametersInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
explore​Link Boolean exploreLink を表示するか否かを示す値。 省略可能 36.0
max​Column​Width Integer ヘッダー列の最大幅。 省略可能 36.0
min​Column​Width Integer ヘッダー列の最小幅。 省略可能 36.0
step String このウィジェットに関連付けられたステップ名。 省略可能 36.0
totals Boolean 合計列が表示されるか否かを示す値。 省略可能 36.0
selectMode​Override Connect​Wave​Select​Mode​Enum 選択モードの上書き (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
ContainerWidgetParametersInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
alignmentX Connect​Wave​Horizontal​Alignment​Enum 画像の横方向の配置 (Left、Center、Right)。 37.0
alignmentY Connect​Wave​Vertical​Alignment​Enum 縦方向の配置 (Bottom、Center、Top)。 37.0
contained​Widgets String [] このウィジェット内に含まれるウィジェットのリスト (名前別)。 省略可能 36.0 ～ 37.0
documentId String 画像のドキュメント ID。 37.0
fit Connect​Wave​Image​Fit​Type​Enum 画像の適合 (FitHeight、FitWidth、Original、Stretch、Tile)。 37.0
image Asset​Reference​Input​Representation 名前と名前空間を含む画像表示。 Small、39.0 39.0
image​Url String コンテナウィジェットで使用される画像の URI。 省略可能 36.0 ～ 36.0
stretch​Image Boolean コンテナウィジェットの背景画像を引き伸ばすかどうかを示す値。 省略可能 36.0 ～ 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum 選択モードの上書き (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
DateSelectorWidgetParametersInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
calendar​Type​Switching​Allowed Boolean ウィジェットでカレンダーの種別を切り替えられるかどうかを示します。 39.0
default​Absolute​Mode Boolean デフォルトの日付モードを示します。 39.0
default​Fiscal​Mode Boolean デフォルトのカレンダー種別を示します。 39.0
expanded Boolean 日付セレクタが展開済みか否かを示す値。 省略可能 36.0
instant Boolean リストセレクタがインスタントか否かを示す値。 省略可能 36.0
mode​Switching​Allowed Boolean ウィジェットで 2 つの日付モード間を切り替えることができるかどうかを示します。 39.0
select​Mode​Override Connect​Wave​Select​Mode​Enum 選択モードの上書き (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
step String このウィジェットに関連付けられたステップ名。 省略可能 36.0
title String リストセレクタウィジェットのタイトル。 省略可能 36.0
GlobalFiltersWidgetParametersInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
step String このウィジェットに関連付けられたステップ名。 省略可能 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum 選択モードの上書き (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
ImageWidgetParametersInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
alignmentX Connect​Wave​Horizontal​Alignment​Enum 画像の横方向の配置 (Left、Center、Right)。 37.0
alignmentY Connect​Wave​Vertical​Alignment​Enum 縦方向の配置 (Bottom、Center、Top)。 37.0
documentId String 画像のドキュメント ID 37.0
fit Connect​Wave​Image​Fit​Type​Enum 画像の適合 (FitHeight、FitWidth、Original、Stretch、Tile)。 37.0
image Asset​Reference​Input​Representation 名前と名前空間を含む画像表示 39.0
LinkWidgetParametersInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
destination String このリンク先。 省略可能 36.0
destinationLink Asset​Reference​Input​Representation このリンクの対象、ダッシュボード、レンズ、ステップへの参照。
destination​Type Connect​Wave​Link​Widget​Dest​Type​Enum このリンクが参照するアセットタイプ (Dashboard、Explore、Lens、または Url)。 必須 36.0
font​Size Integer このリンクウィジェットで使用されるフォントサイズ。 省略可能 36.0
include​State Boolean 状態を含めるかどうか。 省略可能 36.0
text String テキストの値。 省略可能 36.0
text​Alignment Connect​Wave​Horizontal​Alignment​Enum このウィジェットのテキストの配置 (Center、Left、Right)。 39.0
text​Color String このリンクウィジェットのテキストで使用される色。 省略可能 36.0
visualization​Type String 視覚化の種別 (Calendar​Heat​Map、Combo、Comparison​Table、Heat​Map、Horizontal​Bar、Horizontal​Dot、Matrix、Parallel​Coordinates、Pie、Pivot​Table、Scatter、Stack​Waterfall、Stacked​Horizontal​Bar、Stacked​Horizontal​Bar、Time、Values​Table、Vertical​Bar、Vertical​Dot、または Waterfall)。 省略可能 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum 選択モードの上書き (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
ListSelectorWidgetParametersInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
compact Boolean リストセレクタがコンパクトか否かを示す値。 省略可能 36.0
displayTemplate String ウィジェットレベル射影の表示テンプレート。 39.0
expanded Boolean リストセレクタが展開済みか否かを示す値。 省略可能 36.0
explore​Link Boolean リストセレクタに「explore」リンクが含まれるか否かを示す値。 省略可能 36.0
instant Boolean リストセレクタがインスタントか否かを示す値。 省略可能 36.0
measure​Field String このウィジェットが適用される基準項目。 省略可能 36.0
step String このウィジェットに関連付けられたステップ名。 省略可能 36.0
title String リストセレクタウィジェットのタイトル。 省略可能 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum 選択モードの上書き (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
NumberWidgetParametersInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
compact Boolean ウィジェットがコンパクトであるかどうか。 省略可能 36.0
explore​Link Boolean ウィジェットに「explore」リンクが含まれるかどうか。 省略可能 36.0
font​Size Object テキストのフォントサイズ。 省略可能 36.0
measure​Field String この数値が計算される基準項目。 省略可能 36.0
number​Color String このウィジェット内の数値の色。 省略可能 36.0
numberSize Object 数字のサイズ。 省略可能 36.0
step String このウィジェットに関連付けられたステップ名。 省略可能 36.0
text​Alignment Connect​Wave​Horizontal​Alignment​Enum テキストの配置 (左、中央、または右)。 省略可能 36.0
text​Color String このウィジェット内のテキストの色。 省略可能 36.0
title String ウィジェットのタイトル。 省略可能 36.0
title​Color String このウィジェット内のタイトルの色。 省略可能 36.0
title​Size Object タイトルテキストのサイズ。 省略可能 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum 選択モードの上書き (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
PillBoxWidgetParametersInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
compact Boolean リストセレクタがコンパクトか否かを示す値。 省略可能 36.0
displayTemplate String ウィジェットレベル射影の表示テンプレート。 39.0
explore​Link Boolean このウィジェットの作成に使用された explore リンク。 省略可能 36.0
measure​Field String このウィジェットを構成する基準項目。 省略可能 36.0
step String このウィジェットに関連付けられたステップ名。 省略可能 36.0
title String このウィジェットのタイトル。 省略可能 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum 選択モードの上書き (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
RangeSelectorWidgetParametersInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
instant Boolean リストセレクタがインスタントか否かを示す値。 省略可能 36.0
step String このウィジェットに関連付けられたステップ名。 省略可能 36.0
title String リストセレクタウィジェットのタイトル。 省略可能 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum 選択モードの上書き (Multi、MultiRequired、None、Single、また��� SingleRequired)。 省略可能 36.0
TableWidgetParametersInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
custom​Bulk​Actions Custom​Bulk​Action​Input​Representation このウィジェットのカスタム一括アクション。 39.0
exploreLink Boolean exploreLink を表示するか否かを示す値。 38.0
fixed​Column​Width Integer このテーブルウィジェットの固定列幅 40.0
max​Column​Width Integer このテーブルウィジェットの最大列幅 40.0
min​Column​Width Integer このテーブルウィジェットの最小列幅 40.0
select​Mode​Override Connect​Wave​Select​Mode​Enum 選択モードの上書き (Multi、MultiRequired、None、Single、または SingleRequired)。 36.0
pivoted Boolean テーブルをピボットとして表示するかどうかを示す値 39.0
step String このウィジェットに関連付けられたステップ名。 38.0
totals Boolean 合計行を表示するか否かを示す値 40.0
TextWidgetParametersInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
font​Size Object テキストのフォントサイズ。 省略可能 36.0
text String このウィジェット内のテキストの値。 省略可能 36.0
text​Alignment Connect​Wave​Horizontal​AlignmentEnum テキストの配置 (左、中央、または右)。 省略可能 36.0
text​Color String テキストの色。 省略可能 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum 選択モードの上書き (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
UrlWidgetParametersInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
type Connect​Wave​Url​Widget​Type URL ウィジェットタイプ列挙 (YouTube)。 省略可能 36.0
url String ウィジェットの接続 URI。 省略可能 36.0
video​Size String この URL が指し示す動画のサイズ。 省略可能 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum 選択モードの上書き (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
ValuesTableWidgetParametersInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
explore​Link Boolean explore リンクが表示されるか否かを示す値。 省略可能 36.0
hide​Header​Column Boolean このウィジェットのヘッダー列を非表示にするか表示するかを示す Boolean 値。 省略可能 36.0
max​Column​Width Integer ヘッダー列の最大幅。 省略可能 36.0
min​Column​Width Integer ヘッダー列の最小幅。 省略可能 36.0
step String このウィジェットに関連付けられたステップ名。 省略可能 36.0
totals Boolean 合計列が表示されるか否かを示す値。 省略可能 36.0
select​Mode​Override Connect​Wave​Select​Mode​Enum 選択モードの上書き (Multi、MultiRequired、None、Single、または SingleRequired)。 省略可能 36.0
WidgetPositionInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
h String ウィジェットの高さ。 省略可能 36.0
w String ウィジェットの幅。 省略可能 36.0
x Integer ウィジェットの x インデックス。 PATCH では省略可能、POST では必須 36.0
y Integer ウィジェットの y インデックス。 PATCH では省略可能、POST では必須 36.0
zIndex Integer ウィジェットの Z インデックス。 省略可能 36.0
CustomBulkActionInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン
label String カスタムアクションの表示ラベル 39.0
visualforce Asset​Reference​Input​Representation カスタムアクションのために起動する Visualforce ページ 39.0
CustomBulkActionRepresentation
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
label String カスタムアクションの表示ラベル Small、39.0 39.0
visualforce Asset​Reference​Representation カスタムアクションのために起動する Visualforce ページ。 Small、39.0 39.0