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

Lenses List リソース

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

リソース URL

1/wave/lenses

形式

JSON

使用可能なバージョン

36.0

使用可能なコンポーネント

Apex �� Wave.Lenses.getLenses()
Aura — <wave:sdk> listLenses()

HTTP のメソッド

GET POST

GET の要求パラメーター

パラメーター名	型	説明	必須か省略可能	使用可能なバージョン
`folderId`	ID	特定のフォルダーの内容のみが含まれるように結果を絞り込みます。要求ユーザーの非公開フォルダーにある項目のユーザー ID などになります。	省略可能	36.0
`page`	String	生成されたトークン。返されるレンズのビューを示します。	省略可能	36.0
`pageSize`	Integer	1 ページで返される項目の数。最小値は 1、最大値は 200、デフォルトは 25 です。	省略可能	36.0
`q`	String	検索語。各用語はスペースで区切られます。ワイルドカードは、クエリ文字列の最後のトークンに自動的に付加されます。ユーザーの検索クエリに疑問符またはワイルドカードが含まれている場合、それらの記号は URI で他の特殊文字と同様にクエリ文字列から自動的に削除されます。	省略可能	36.0
`scope`	ConnectWaveScopeTypeEnum	返されたコレクションに適用される範囲の種別。有効な値は、次のとおりです。 `CreatedByMe` `Mru` (最近使用) `SharedWithMe`	省略可能	38.0
`sort`	ConnectWaveSortOrderTypeEnum	返されたコレクションに適用される並び替え順の種別。有効な値は、次のとおりです。 `App` `CreatedBy` `CreatedDate` `LastModified` `LastModifiedBy` `Mru` (Most Recently Used、最後に参照した日付) `Name` `Type`	省略可能	38.0

GET のレスポンスボディ

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`lenses`	LensRepresentation[]	現在のユーザーが使用できるレンズのリスト。	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

POST リクエストボディ (LensInputRepresentation)

LensInputRepresentation は、抽象 BaseAssetInputRepresentation からプロパティを継承します。これらの基本プロパティは、LensInputRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`datasets`	AssetReferenceInputRepresentation[]	このレンズの作成に使用されたデータセットのリスト。	POST では必須、PATCH では省略可能	43.0
`folder`	AssetReferenceInputRepresentation	このレンズが保存されているフォルダー。	POST では必須、PATCH では省略可能	36.0
`historylabel`	String	保存されるレンズバージョンの履歴の表示ラベル。	省略可能	46.0
`state`	LensStateInputRepresentation	レンズの状態。	POST では必須、PATCH では省略可能	36.0
`visibility`	ConnectWaveAssetVisibilityType	アセットが参照アクセス権を持つユーザーに対して非表示になるかどうかを示します。有効な値は、次のとおりです。 `All` (すべてのアセットを表示) `Limited` (参照アクセス権を持つ閲覧者にアセットを非表示)	省略可能	51.0
`visualizationType`	ConnectWaveVisualizationTypeEnum	レンズの視覚化のタイプ。有効な値は、次のとおりです。 `Bullet` `CalendarHeatMap` `Combo` `ComparisonTable` `Flatgauge` `Gauge` `HeatMap` `HorizontalBar` `HorizontalDot` `Line` `Matrix` `ParallelCoordinates` `Pie` `PivotTable` `Polargauge` `Pyramid` `Rating` `Scatter` `StackWaterfall` `StackedHorizontalBar` `StackedVerticalBar` `Time` `TimeBar` `TimeCombo` `ValuesTable` `VerticalBar` `VerticalDot` `Waterfall`	POST では必須、PATCH では省略可能	36.0
`xmd`	XmdInputRepresentation	レンズのアセット XMD。	省略可能	43.0

POST レスポンスボディ (LensRepresentation)

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`allowPreview`	Boolean	ユーザーがレンズをプレビューできるかどうかを示します。	Small、36.0	36.0
`dataset`	AssetReferenceRepresentation	廃止このレンズの作成に使用されるデータセットへの参照。	Small、36.0	36.0 ～ 42.0
`datasets`	AssetReferenceRepresentation[]	レンズで使用されるデータセットのリスト。	Small、43.0	43.0
`dateVersion`	Integer	レンズが使用する日付のバージョン。有効な値は、次のとおりです。 `1` `2`	Small、44.0	44.0
`files`	LensFileRepresentation[]	レンズファイルのリスト。	Medium、36.0	36.0
`filesUrl`	String	レンズファイルの URL。	Small、36.0	36.0
`folder`	AssetReferenceRepresentation	このレンズが保存されているフォルダーへの参照。	Small、36.0	36.0
`historiesUrl`	String	このレンズに関連付けられたレンズ履歴の URL。	Small、44.0	44.0
`refreshDate`	Date	レンズで使用されている最新のデータセットの日付 (ISO8601 日付形式)。	Small、36.0	36.0
`state`	LensStateRepresentation	レンズの状態。	Big、36.0	36.0
`visibility`	ConnectWaveAssetVisibilityType	アセットが参照アクセス権を持つユーザーに対して非表示になるかどうかを示します。有効な値は、次のとおりです。 `All` (すべてのアセットを表示) `Limited` (参照アクセス権を持つ閲覧者にアセットを非表示)	Small、51.0	51.0
`visualizationType`	String	このレンズに使用される視覚化のタイプ。有効な値は次のとおりです。 `Bullet` `CalendarHeatMap` `Combo` `ComparisonTable` `Flatgauge` `Gauge` `HeatMap` `HorizontalBar` `HorizontalDot` `Line` `Matrix` `ParallelCoordinates` `Pie` `PivotTable` `Polargauge` `Pyramid` `Rating` `Scatter` `StackWaterfall` `StackedHorizontalBar` `StackedVerticalBar` `Time` `TimeBar` `TimeCombo` `ValuesTable` `VerticalBar` `VerticalDot` `Waterfall`	Small、36.0	36.0

LensStateInputRepresentation

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

QueryInputRepresentation

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`aggregateFilters`	Object	クエリの短縮形式の集計検索条件。	省略可能	48.0
`columnGroups`	Object	クエリの列グループ。	省略可能	56.0
`columnTotals`	Object	クエリの列の合計。	省略可能	56.0
`limit`	Object	クエリ制限。	省略可能	48.0
`orders`	Object	クエリ順序。	省略可能	48.0
`query`	String	SAQL クエリ。	PATCH では省略可能、POST では必須	36.0
`rowTotals`	Object	クエリの行の合計。	省略可能	56.0
`sourceFilters`	Map<String,CompactFormFilterInputRepresentation>	クエリの短縮形式のソース検索条件の対応付け。	省略可能	48.0
`sources`	CompactFormSourceInputRepresentation[]	クエリの短縮形式の取得元のリスト。	省略可能	48.0
`timezone`	String	クエリ要求のタイムゾーン。	省略可能	43.0
`version`	Double	このクエリ言語構成要��が属するバージョン。	PATCH では省略可能、POST では必須	36.0

CompactFormFilterInputRepresentation

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`booleanFilterLogic`	String	Boolean 検索条件ロジック。	省略可能	49.0
`filters`	Object	短縮形式の検索条件。	必須	48.0

CompactFormSourceInputRepresentation

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`cogroupType`	ConnectWaveCompactFormCogroupTypeEnum	短縮形式の取得元共通グループ種別。有効な値は、次のとおりです。 Full Inner Left Right	必須	48.0
`columns`	CompactFormColumnRepresentation[]	短縮形式の取得元列のリスト。	必須	48.0
`groups`	Object	短縮形式の取得元グループ。	必須	48.0
`filters`	Object	短縮形式の取得元列の検索条件。	必須	48.0
`name`	String	短縮形式の取得元名。	必須	52.0

LensVisualizationOptionsInputRepresentation

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`columnTotals`	Boolean	テーブルに列の合計を表示するか (`true`)、否か (`false`) を示します。	省略可能	55.0
`fit`	Boolean	カテゴリの割合に比例するようにデータ図形の位置やサイズを調整するか (`true`)、否か (`false`) を示します。	省略可能	36.0
`hideHeaderColumn`	Boolean	ヘッダー列を表示するか (`true`)、否か (`false`) を示します。	省略可能	36.0
`legend`	Boolean	凡例を表示するか (`true`)、否か (`false`) を示します。	省略可能	36.0
`legendHideHeader`	Boolean	凡例を隠すか (`true`)、否か (`false`) を示します。	省略可能	36.0
`legendWidth`	Integer	凡例の幅。	省略可能	36.0
`maxColumnWidth`	Integer	ヘッダー列の最大幅。	省略可能	36.0
`minColumnWidth`	Integer	ヘッダー列の最小幅。	省略可能	36.0
`miniBars`	Integer	ミニバーの幅 (存在する場合)。	省略可能	36.0
`multiMetrics`	Boolean	複数の基準を同じグラフに横並びで表示するか (`true`)、基準ごとに独自のグラフにするか (`false`) を示します。	省略可能	36.0
`normalize`	Boolean	カテゴリの割合に比例するようにデータ図形の位置やサイズを調整するか (`true`)、否か (`false`) を示します。	省略可能	36.0
`rowTotals`	Boolean	テーブルに行の合計を表示するか (`true`)、否か (`false`) を示します。	省略可能	55.0
`splitAxis`	Boolean	各基準を 1 つの軸に表示するか (`true`)、すべての基準が軸を共有するか (`false`) を示します。	省略可能	36.0
`sqrt`	Boolean	軸が平方根スケールか (`true`)、否か (`false`) を示します。	省略可能	36.0
`subtotals`	Boolean	テーブルに小計を表示するか (`true`)、否か (`false`) を示します。	省略可能	48.0
`totals`	Boolean	テーブルに合計を表示するか (`true`)、否か (`false`) を示します。	省略可能	36.0
`trellis`	Boolean	最後のグループがトレリスのディメンションとして処理されるか (`true`)、否か (`false`) を示します。ディメンションのすべての個別値がグラフになります。	省略可能	36.0

CRM Analytics REST API 開発者ガイド

Lenses List リソース