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

Lenses List リソース

Analytics レンズのリストを返す (GET) か、レンズを作成 (POST) します。

リソース URL

1/wave/lenses

形式

JSON

使用可能なバージョン

36.0

HTTP のメソッド

GET と POST

GET の要求パラメータ

パラメータ名	型	説明	必須か省略可能	使用可能なバージョン
`folderId`	ID	特定のフォルダのコンテンツのみが含まれるように結果を絞り込みます。要求ユーザの非公開フォルダの項目のユーザ ID などになります。	省略可能	36.0
`page`	String	生成されたトークン。返されるレンズのビューを示します。	省略可能	36.0
`pageSize`	Int	1 ページで返される項目の数。最小値は 1、最大値は 200、デフォルトは 25 です。	省略可能	36.0
`q`	String	検索語。各用語はスペースで区切られます。ワイルドカードはサポートされていません。たとえば、次の名前のレンズがあるとします。 Opportunities_Created_2010 Opportunities_Created_2011 q = “Opportunities 2010” と設定すると、Opportunities_Created_2010 のみが返されます。	省略可能	36.0
`scope`	Enum	コレクションリソースの表現に適用される範囲の種別 (CreatedByMe、IncludeAllPrivate、または SharedWithMe)		41.0
`sort`	String	結果の並び替え順。値は次のとおりです。 `LastModified` `Mru`: Most recently used (最後に参照した日付) `Name` デフォルトは、`Mru` です。	省略可能	36.0

GET のレスポンスボディ

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`lenses`	Lens[]	現在のユーザが使用できるレンズのリスト。	Small、36.0	36.0
`nextPageUrl`	String	コレクションのコンテンツの次のページを取得する URL。	Small、36.0	36.0
`totalSize`	Integer	コレクションの要素の合計数 (すべてのページを含む)。	Medium、36.0	36.0
`url`	String	コレクションを取得する URL。	Small、36.0	36.0

レスポンスボディの例

1{
2  "lenses" : [ "/* Lenses detail omitted for brevity. */" ],
3  "nextPageUrl" : "/services/data/v36.0/wave/lenses?page=eyJwYWdlU2l6ZSI6MjUsInNv",
4  "totalSize" : 14,
5  "url" : "/services/data/v36.0/wave/lenses"
6}

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

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`dataset`	AssetReferenceInputRepresentation	このレンズの作成に使用されるデータセット。	POST では必須、PATCH では省略可能	36.0
`folder`	AssetReferenceInputRepresentation	このレンズが保存されるフォルダ。	POST では必須、PATCH では省略可能	36.0
`state`	State Input	レンズの状態。	POST では必須、PATCH では省略可能	36.0
`visualizationType`	String	このレンズに使用される視覚化の種別。値は次のとおりです。 `calheatmap`: カレンダーヒートマップ `comparisontable`: 比較テーブル `heatmap`: ヒートマップ `hbar`: 棒 `hbarhdot`: 横方向のドットプロット `matrix`: マトリックス `parallelcoords`: 平行座標 `pie`: ドーナツ `pivottable`: ピボットテーブル `scatter`: 散布図 `stackhbar`: 積み上げ横棒 `stackvbar`: 積み上げ縦棒 `time`: タイムライン `valuestable`: 値テーブル `vbar`: 列 `vdot`: 縦方向のドットプロット	POST では必須、PATCH では省略可能	36.0

AssetReferenceInputRepresentation

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`id`	String	アセットの ID		36.0
`name`	String	アセットの API 参照名		36.0

State Input

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`columns`	Column[]	比較テーブルレンズの列のリスト。	比較テーブルでのみ指定する必要があります。	36.0
`options`	Lens Visualization Options Input	異なるレンズの視覚化の設定オプション。	省略可能	36.0
`query`	QueryInputRepresentation	このレンズの作成に使用される SAQL クエリ。	比較テーブル以外の視覚化の種別を使用する場合は、このプロパティを指定する必要があります。	36.0

QueryInputRepresentation

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`query`	String	SAQL クエリ。		36.0
`version`	Double	SAQL クエリのバージョン。		36.0

Lens Visualization Options Input

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`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 の場合、同じグラフに複数の基準が横並びで表示されることを示します。`false` の場合、各基準は個別のグラフに表示されます。デフォルトは、`false` です。	省略可能	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

POST のレスポンスボディ

Lens

Analytics REST API 開発者ガイド

Lenses List リソース