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

Templates Configuration リソース

Wave Analytics テンプレートの設定を返します。

リソース URL

1/wave/templates/<templateIdOrApiName>/configuration

形式

JSON

使用可能なバージョン

36.0

HTTP メソッド

GET

GET の要求パラメータ

パラメータ名	型	説明	必須項目/省略可能	使用可能なバージョン
`disableApex`	Boolean	true の場合、Apex インテグレーションフックが無効になります。デフォルトは false です。	省略可能	36.0

GET のレスポンスボディ

TemplateConfigurationRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`ui`	Wave UI Definition	テンプレートのユーザインターフェース定義。	Small、36.0	36.0
`variables`	Map <String, Wave Variable Definition>	テンプレート用の定義された変数セット。	Small、36.0	36.0

Wave UI Definition

UiDefinitionRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`displayMessages`	DisplayMessageRepresentation[]	このテンプレート設定の表示メッセージ。	Small、36.0	36.0
`pages`	Page[]	このテンプレート設定のページコレクション。	Small、36.0	36.0

DisplayMessageRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`location`	String	テキストが表示されるページの名前。	Small、36.0	36.0
`text`	String	表示するテキストコンテンツ。	Small、36.0	36.0

Page

PageRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`condition`	String	ページが表示されるオプション条件。値はクライアント側 EL 表記である必要があります (例: {{Variables.selectedOption}})。	Small、36.0	36.0
`helpUrl`	String	このページのヘルプ Web ページへの URL。	Small、36.0	36.0
`title`	String	ページのタイトル。	Small、36.0	36.0
`variables`	PageVariableRepresentation[]	このテンプレート設定の変数のコレクション。	Small、36.0	36.0

PageVariableRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`name`	String	変数の名前。	Small、36.0	36.0
`visibility`	String	この変数の表示の表記。	Small、36.0	36.0

Wave Variable Definition

VariableDefinitionRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`computedValue`	Object	変数の計算値。この値は、統合された Apex 実装によって設定されます。	Small、38.0	38.0
`defaultValue`	Object	変数のデフォルト値。	Small、36.0	36.0
`description`	String	変数の説明。	Small、36.0	36.0
`excludeSelected`	Boolean	テンプレート内の変数に `excludeSelected` がある場合は `True`。それ以外の場合は、`False`。	Small、36.0	36.0
`excludes`	String []	変数選択から除外する値のリスト。	Small、36.0	36.0
`label`	String	変数の表示ラベル。	Small、36.0	36.0
`mostRecentValue`	Object	最新のアプリケーション作成プロセスで指定された値。	Small、36.0	36.0
`required`	Boolean	テンプレートでこの変数が必須の場合は `True`。それ以外の場合は、`False`。	Small、36.0	36.0
`variableType`	VariableTypeRepresentation	変数の型。	Small、36.0	36.0

VariableTypeRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`type`	VariableTypeEnum	変数の型。 ArraytType: 変数の型はオブジェクトの配列です。 BooleanType: 変数の型はブール型 (true、false) です。 DatasetDateType: 変数の型はデータセット内の日付です。 DatasetDimensionType: 変数の型はデータセット内のディメンションです。 DatasetMeasureType: 変数の型はデータセット内の基準です。 DatasetType: 変数の型はデータセット型であり、組織内のデータセットを参照します。 DateTimeType: 変数の型は日付/時間型です。 NumberType: ユーザ入力を numeric 型の値に制限します。 ObjectType: 変数の型は任意のオブジェクトです。 SobjectFieldType: 変数の型は sObject 項目であるか、sObject 内の項目を参照します。sObject 変数型も参照してください。 SobjectType: 変数の型は sObject 型であるか、組織内の sObject を参照します。 StringType: 変数の型は文字列型です	Small、36.0	36.0

レスポンスボディの例

1{
2    "ui": {
3        "pages": [
4            {
5                "title": "Application Preferences",
6                "variables": [
7                    "lensDashboardName",
8                    "dashboardHeader"
9                ]
10            },
11            {
12                "title": "Other preferences",
13                "variables": [
14                    "emailNotifications",
15                    "emailAddress"
16                ]
17            }
18        ]
19    },
20    "variables": {
21        "numberPicked": {
22            "defaultValue": 3,
23            "description": "A number between 1 and 10.",
24            "excludeSelected": false,
25            "excludes": [],
26            "label": "Please pick a number between 1 and 10?",
27            "required": true,
28            "variableType": {
29                "enums": [],
30                "max": 10,
31                "min": 1,
32                "type": "NumberType"
33            }
34        },
35        "lensDashboardName": {
36            "defaultValue": "My View of Election Data",
37            "description": "The name of the sample lens.",
38            "excludeSelected": false,
39            "excludes": [],
40            "label": "What would you like to name your lens and dashboard?",
41            "required": true,
42            "variableType": {
43                "enums": [],
44                "type": "StringType"
45            }
46        },
47        "dashboardHeader": {
48            "defaultValue": "Wow! Interactive Dashboards are Nice!",
49            "description": "The dashboard header.",
50            "excludeSelected": false,
51            "excludes": [],
52            "label": "What would you like the dashboard header to say?",
53            "required": true,
54            "variableType": {
55                "enums": [],
56                "type": "StringType"
57            }
58        },
59        "emailNotifications": {
60            "defaultValue": "Yes",
61            "description": "Email notifications",
62            "excludeSelected": false,
63            "excludes": [],
64            "label": "Would you like to receive emails for promotions?",
65            "required": false,
66            "variableType": {
67                "enums": [
68                    "Yes",
69                    "No"
70                ],
71                "type": "StringType"
72            }
73        },
74        "emailAddress": {
75            "defaultValue": null,
76            "description": "Your email address.",
77            "excludeSelected": false,
78            "excludes": [],
79            "label": "Please enter your email address?",
80            "required": false,
81            "variableType": {
82                "enums": [],
83                "type": "StringType"
84            }
85        }
86    }
87}

Wave REST API 開発者ガイド

Templates Configuration リソース