ドキュメントの検索
karat

+

K

APIリファレンス ↗

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

オブジェクトセットの作成または取得

プラットフォームタブのオブジェクトセットパネルを使って、次の操作を行えます。

  • フィルター処理をしたり、しなかったりして、サービス構成を追加せずにオブジェクトセットを作成します。
  • テンプレートのドット記法({{s_object_set1.data.property1}} など)を使用して、オブジェクトセットのオブジェクトに直接アクセスします。
  • オブジェクトのRIDにアクセスするには、{{s_object_set1.objectRids}} を使用します。

2つのモードがあります。

  • Builder モードは、GUI(グラフィカルユーザーインターフェース)を使ってオブジェクトセットを構築できるモードであり、
  • RID モードは、オブジェクトセットのRID または バージョン付きオブジェクトセットのRID を参照してオブジェクトセットを構築できるモードです。

オブジェクトセットフィルタービルダーモード

オブジェクトセット s_object_set1 を作成するには、基本オブジェクトタイプを選択してから、必要に応じて AND/OR ロジックでフィルターを追加します。フィルターのフィールドは、オブジェクトのプロパティデータタイプを考慮しています。たとえば、数値プロパティは、フィルターとして数値範囲を取ります。さらに、各フィルターレベルで個別の AND/OR フィルターをネストして、オブジェクトを特定の結果に限定できます。

object-set

フィルターフィールドでは、Slate のハンドルバーも使用できるため、動的に変化する入力に基づいてオブジェクトセットをパラメータ化できます。

object-set-parameterized

フィルターフィールドは、複数の用語フィルターやワイルドカードフィルターを使ってテンプレート化にも対応しています。

  • 複数の用語フィルターを使ってテンプレート化するには、複数の用語を直接渡すことができます(例:["value1", "value2"])。
  • 代わりに、複数の用語を出力する関数への直接参照を含む Handlebars テンプレートを渡すこともできます。
    • 例えば、{{f_my_filters}}["value1", "value2"] を返す場合、オブジェクトセットエディタで {{f_my_filters}} を直接使用できます。

オブジェクトセットの結果は、フィールド data の下に表形式で返され、さらにフィールド objectRids にすべてのオブジェクトRIDが含まれます。

object-set-used

オブジェクトセットの結果の制限

オブジェクトセットフィルターでは、返されるオブジェクトの数に上限を設定することもできます。これは、SQLの LIMIT 句に概念的に似ており、より迅速なテストと反復が可能になります。

上限が結果の総数よりも小さい場合、getNextPage および getPreviousPage イベントを使用して結果をページ送りできます。これにより、大量の結果を返す際のパフォーマンスが向上することがあります。

集約

Platform タブのオブジェクトセットエディタを使用して、オブジェクトセットに対して簡単な集約を計算できます。集約を作成するには、Output options の下の Aggregation をオンにし、Add aggregation を選択します。集約は、上記で定義した結果オブジェクトセットに基づいています。

集約は、次の集約タイプのいずれかを使用できます。カウント、平均、合計、最大、最小、またはカーディナリティ。カウント以外の集約を計算する場合、数値プロパティを選択する必要があります。

Add aggregation を選択して、1つのオブジェクトセットに基づいて複数の集約を計算できます。集約を使用する場合、プレビューには集約の結果のみが表示されます。ただし、Functions、Widgets、および Slate の他の部分でオブジェクトセットを参照する際には、詳細なオブジェクトも引き続き利用できます。

多次元集約

オブジェクトセットデータを複数の次元で集約するには(「グループ化」またはセグメントを含むようにするには)、データをグループ化およびセグメント化する前に、メトリックを計算するためのバケットを作成する Function を記述する必要があります。

これらの関数は、Slate がチャートやその他の Slate ウィジェットを構成するために使用される平行リストデータ構造に解析される 集約タイプ を返します。

Slate から Foundry Functions を呼び出す方法に関する ドキュメント には、Slate からのこれらの相互作用の詳細が記載されています。

オブジェクトセットのソート

結果のオブジェクトセットは、任意のパラメーターで昇順または降順にソートできます。複数のプロパティをソートの設定に使用でき、ソートプロパティは上から下に適用されます。制限はソート後にのみ適用されます。

オブジェクトセットRIDモード

オブジェクトセット RID モードでは、Slate のオブジェクトセットパネルは、オブジェクトセットRID および バージョン付きオブジェクトセットRID を受け取り、それを Slate のデータ配列形式に戻すことができます。

これにより、Slate のパラメータ化されたオブジェクトセットビルダーを使用するだけでなく、RID を渡す柔軟性も得られます。