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

Lens リソース

指定された ID を持つ Wave Analytics レンズの構造が記述されている JSON ファイルを返す (GET) か、レンズを削除 (DELETE) するか、レンズを更新 (PATCH) します。

リソース URL

1/wave/lenses/<lens ID>

形式

JSON

使用可能なバージョン

36.0

HTTP メソッド

GET、DELETE、PATCH

PATCH のリクエストボディ

リクエストボディ (POST および /wave/lenses/<レンズ ID> PATCH)

レンズを更新するときに、1 つのプロパティのみを指定することも、プロパティの組み合わせを指定することもできます。

型が比較テーブルに、または比較テーブルから変更されている場合、state プロパティと visualizationType プロパティにパッチを適用する必要があります。

メモ

GET および PATCH のレスポンスボディ

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`allowPreview`	Boolean	ユーザがレンズをプレビューできるかどうかを示します。	Small、36.0	36.0
`assetSharingUrl`	String	レンズの共有 URL。	Small、36.0	36.0
`createdBy`	Wave User	レンズの作成者。	Small、36.0	36.0
`createdDate`	Data	レンズが作成された時刻 (ISO8601 日付形式)。	Small、36.0	36.0
`dataset`	Dataset Reference	このレンズの作成に使用されるデータセットへの参照。	Small、36.0	36.0
`files`	Lens File[]	ユーザインターフェースにレンズを表示するために使用されるアイコンに関する情報。	Medium、36.0	36.0
`filesUrl`	String	レンズファイルへの URL。	Small、36.0	36.0
`folder`	AssetReferenceRepresentation	このレンズが保存されているフォルダへの参照。	Small、36.0	36.0
`id`	ID	18 文字のレンズ ID。	Small、36.0	36.0
`label`	String	レンズの表示ラベル。	Small、36.0	36.0
`lastAccessedDate`	Data	レンズが最後にアクセスされた時刻 (ISO8601 日付形式)。	Small、36.0	36.0
`lastModifiedBy`	Wave User	レンズを最後に更新したユーザ。	Small、36.0	36.0
`lastModifiedDate`	Data	レンズが最後に変更された時刻 (ISO8601 日付形式)。	Small、36.0	36.0
`name`	String	レンズの名前。	Small、36.0	36.0
`permissions`	Permissions	現在のユーザの権限。	Small、36.0	36.0
`refreshDate`	Data	レンズで使用されている最新のデータセットの日付 (ISO8601 日付形式)。	Small、36.0	36.0
`state`	Lens State	レンズの状態。	Big、36.0	36.0
`type`	String	アセットタイプ。レンズの場合、値は `lens` です。	Small、36.0	36.0
`url`	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

Lens File

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`contentType`	String	ファイルのコンテンツタイプ。	Small、36.0	36.0
`fileLength`	Integer	ファイルのサイズ (KB)。	Small、36.0	36.0
`fileName`	String	ファイルの名前。	Small、36.0	36.0
`id`	ID	18 文字のレンズファイル ID。	Small、36.0	36.0
`lastModifiedDate`	Data	ファイルの最終更新日 (ISO8601 日付形式)。	Small、36.0	36.0

Lens State

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`columns`	Column[]	比較テーブルレンズの列のリスト。視覚化の種別が比較テーブルの場合にのみ返されます。	Small、36.0	36.0
`options`	Lens Visualization Options	異なるレンズの視覚化の設定オプション。	Small、36.0	36.0
`query`	Query	このレンズの作成に使用される SAQL クエリ。比較テーブルを除くすべての視覚化の種別で返されます。	Small、36.0	36.0

Column

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`header`	String	この列のヘッダーテキスト。	Small、36.0	36.0
`hidden`	Boolean	この列が非表示かどうかを示します。	Small、36.0	36.0
`query`	Query	この列の作成に使用される SAQL クエリ。	Small、36.0	36.0
`showBars`	Boolean	この列のバーを表示するかどうかを示します。	Small、36.0	36.0
`sort`	String	この列の並び替え順。値は次のとおりです。 `Ascending`: 昇順での並び替え `Descending`: 降順での並び替え `InnerAscending`: グループ内の昇順での並び替え `InnerDescending`: グループ内の降順での並び替え `None`: 並び替えなし	Small、36.0	36.0

Lens Visualization Options

視覚化の有効な設定オプション。使用可能なプロパティは、視覚化のタイプによって異なります。

視覚化のタイプ	有効なプロパティ
棒グラフ	`legend, legendHideHeader, legendWidth, maxColumnWidth, minColumnWidth, miniBars, multiMetrics, splitAxis, sqrt, and trellis`
比較テーブル	`maxColumnWidth and minColumnWidth`
ドーナツ	`legend, legendHideHeader, and legendWidth`
ドットプロット	`fit, legend, legendHideHeader, legendWidth, and sqrt`
ヒートマップ	`legend, legendHideHeader, and legendWidth`
マトリックス	`legend, legendHideHeader, and legendWidth`
平行座標	`fit, legend, legendHideHeader, legendWidth, and sqrt`
ピボットテーブル	`maxColumnWidth, minColumnWidth, and totals`
散布図	`fit, legend, legendHideHeader, legendWidth, and sqrt`
積み上げ棒/縦棒	`legend, legendHideHeader, legendWidth, maxColumnWidth, minColumnWidth, miniBars, normalize, and sqrt`
スケジュール	`fit, legend, legendHideHeader, legendWidth, and sqrt`
値テーブル	`hideHeaderColumn, maxColumnWidth, and minColumnWidth`

視覚化のプロパティ

使用可能なプロパティは、視覚化のタイプによって異なります。

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`fit`	Boolean	そのカテゴリの割合に比例するようにデータ図形の位置とサイズを調整するかどうかを示します。	Small、36.0	36.0
`hideHeaderColumn`	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
`minColumnWidth`	Integer	ヘッダー列の最小幅。	Small、36.0	36.0
`miniBars`	Integer	ミニバーの幅 (使用されている場合)。	Small、36.0	36.0
`multiMetrics`	Boolean	true の場合、同じグラフに複数の基準が横並びで表示されることを示します。false の場合、各基準は個別のグラフに表示されます。デフォルト値は false です。	Small、36.0	36.0
`normalize`	Boolean	そのカテゴリの割合に比例するようにデータ図形の位置とサイズを調整します。	Small、36.0	36.0
`splitAxis`	Boolean	true の場合、各基準で 1 つの軸が使用されます。false の場合、すべての基準で同じ軸が使用されます。	Small、36.0	36.0
`sqrt`	Boolean	横軸と縦軸で平方根スケールが使用されることを示します。	Small、36.0	36.0
`trellis`	Boolean	true の場合、最後のグループがトレリスのディメンションとして処理されます。ディメンションのすべての個別値がグラフになります。	Small、36.0	36.0
`totals`	Boolean	テーブルに合計を表示するかどうかを示します。	Small、36.0	36.0

Query

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`query`	String	SAQL クエリテキスト。	Small、36.0	36.0
`saqlVersion`	Double	このクエリの SAQL バージョン。	Small、36.0	36.0

レスポンスボディの例

1{
2  "allowPreview" : true,
3  "assetSharingUrl" : "https://yourInstance.salesforce.com/
4      analytics/wave/lens?assetId=0FKD00000004CVjOAM&orgId=00DD00000007dBq&loginHost=
5      yourInstance.salesforce.com&urlType=sharing",
6  "createdBy" : {
7    "id" : "005D00000018LSoIAM",
8    "name" : "User Name",
9    "profilePhotoUrl" : "https://yourInstance.salesforce.com/profilephoto/005/T"
10  },
11  "createdDate" : "2015-02-06T17:40:28.000Z",
12  "dataset" : {
13    "id" : "0FbD000000000ExKAI",
14    "url" : "/services/data/v36.0/wave/datasets/0FbD000000000ExKAI"
15  },
16  "files" : [ {
17    "contentType" : "image/png",
18    "fileLength" : 3105,
19    "fileName" : "assetPreviewThumb",
20    "id" : "0FJD00000004CEiOAM",
21    "lastModifiedDate" : "2015-02-06T17:40:29.000Z"
22  } ],
23  "folderId" : "00lD0000000w3y6IAA",
24  "id" : "0FKD00000004CVjOAM",
25  "label" : "UsersWithRoles Lens",
26  "lastAccessedDate" : "2015-04-02T23:02:12.000Z",
27  "lastModifiedBy" : {
28    "id" : "005D00000018LSoIAM",
29    "name" : "User Name",
30    "profilePhotoUrl" : "https://yourInstance.salesforce.com/profilephoto/005/T"
31  },
32  "lastModifiedDate" : "2015-02-06T17:40:28.000Z",
33  "name" : "UsersWithRoles_Lens",
34  "permissions" : {
35    "modify" : true,
36    "view" : true
37  },
38  "refreshDate" : "2015-02-20T17:42:50.000Z",
39  "state" : {
40    "options" : {
41      "sqrt" : true
42    },
43    "query" : {
44      "query" : "{&quot;values&quot;:[&quot;Name&quot;,&quot;CommunityNickname&quot;,&quot;Alias&quot;]}",
45      "saqlVersion" : -1.0
46    }
47  },
48  "type" : "lens",
49  "url" : "/services/data/v36.0/wave/lenses/0FKD00000004CVjOAM",
50  "visualizationType" : "valuestable"
51}

Wave REST API 開発者ガイド

Lens リソース