ドキュメントの検索
karat

+

K

APIリファレンス ↗

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

Object ExplorerのURLを生成する

Object Viewsを開発したり、Slateアプリケーションや外部システムに統合する際に、特定のオブジェクトにリンクするURLを生成したり、オブジェクトを検索するURLを生成する必要があります。

特定のObject ViewにリンクするURLの作成方法については、Object ViewsのドキュメンテーションのObject ViewsのURLを生成するをご覧ください。

キーワードのみの検索の生成

テキストに特殊文字やスペースが含まれている場合は、それをエンコードする必要があります:

encodeURIComponent("hello world");

URLを作成します:

<BASEURL>/hubble/external/keyword/v0/<MY_ENCODED_TEXT>

探索へのリンク

Object Explorerは、URLで説明されたフィルターを使用して新しい検索、保存された探索、または特定のオブジェクトタイプへのリンクを開くことができます。各タイプのリンクは、デフォルトのExploreビューで開くことができ、集約結果を表示するチャートが表示されます。または、リンクURLの末尾にパラメーターperspectiveId=resultsを追加することで、表形式のResultsビューで開くこともできます。

特定のオブジェクトタイプを探索するためのオープニング

特定のオブジェクトタイプの探索は、objectTypeId URLパラメーターを使用して開くことができます。例えば:

/workspace/hubble/exploration?objectTypeId=aircraft.

Resultsビューで開くには、perspectiveId=resultsパラメーターを追加します:

/workspace/hubble/exploration?objectTypeId=aircraft&perspectiveId=results

保存された探索やオブジェクトセットの読み込み

savedルートを使用して、保存された探索やオブジェクトセットを開きます。

/workspace/hubble/exploration/saved/ri.object-set.main.versioned-object-set.4b117663-06d7-4bd1-a2be-8e1ba20998cb

他のFoundryアプリケーションによって作成されたオブジェクトセットを読み込むには、external/objectSetルートを使用します。

/workspace/hubble/external/objectSet/v0/ri.object-set.main.object-set.f6916120-5b52-4312-8be4-9f5764983907

[高度] 複雑な検索の生成

フィルターセットを以下のように生成します:

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 { "keyword": "", // 検索キーワード "objectTypes": [ "google-reviews" // オブジェクトタイプ ], "filters": [ // フィルター条件 { "type": "propertyFilter", // プロパティフィルター "objectType": "google-reviews", // オブジェクトタイプ "propertyType": "Description", // プロパティタイプ "value": { // 値 "type": "textFilter", // テキストフィルター "text": "hello" // テキスト } }, { "type": "propertyFilter", // プロパティフィルター "objectType": "google-reviews", // オブジェクトタイプ "propertyType": "rating", // プロパティタイプ "value": { // 値 "type": "valuesFilter", // 値フィルター "values": ["3", "4"] // 値 } }, { "type": "propertyFilter", // プロパティフィルター "objectType": "google-reviews", // オブジェクトタイプ "propertyType": "creation-date", // プロパティタイプ "value": { // 値 "type": "dateRangeFilter", // 日付範囲フィルター "dateRangeFilter": { // 日付範囲フィルター "start": "2000-01-10", // 開始日 "end": "2000-01-11" // 終了日 } } }, { "type": "linkFilter", // リンクフィルター "objectType": "google-reviews", // オブジェクトタイプ "linkType": "restaurant-to-review", // リンクタイプ "value": { // 値 "type": "presenceFilter", // 存在フィルター "matchType": "MUST_HAVE" // マッチタイプ } } ] }

このJSONファイルは、Googleレビューのフィルタリング条件を設定するためのものです。それぞれのフィルタリング条件(プロパティフィルター、値フィルター、日付範囲フィルター、存在フィルター)を具体的に設定しています。たとえば、「Description」のテキストに「hello」が含まれているか、「rating」が「3」または「4」であるか、作成日が「2000-01-10」から「2000-01-11」の間であるか、レビューが存在するかどうかなどを判断します。 利用できるフィルターの種類には、以下のものがあります。

  • numberRangeFilter: min(オプションの数値)、max(オプションの数値)
  • relativeDateFilter: sinceDaysAgo(オプションの数値)、untilDaysAgo(オプションの数値)
  • timestampRangeFilter: startMillis(オプションの数値)、endMillis(オプションの数値)
  • relativeTimestampFilter: sinceMillisAgo(オプションの数値)、untilMillisAgo(オプションの数値)

この例は古い可能性があります。以下の手順で最新の形式を確認してください。

値のタイプは、Object Explorer でそのプロパティのデフォルトで表示されるウィジェットのタイプと一致する必要があります。例:ヒストグラムウィジェット用の valuesFilter;テキストボックス用の textFilter

これらのフィルターを生成するおすすめの方法は以下の通りです。

  1. Object Explorer を開き、生成したいすべてのフィルターにサンプル値を選んで例示検索を構築します

  2. Chrome Console を開きます(右クリック -> 要素を検証)。Object Explorer が提供する要素(結果のカウントなど)を検証するようにし、Chrome Console をただ開くだけではないようにします。

  3. コンソールで await hubble_get_current_search() を実行します。

これにより、現在のフィルターセットの JSON が返されます。これを使って正しい形式を把握し、値に対して置換を行います。

PROPERTY フィルターは複数持つことができますが、LINK フィルターは 1 つだけです。

  1. URL エンコードします。

encodeURIComponent(<MY_FILTERS>);

  1. URL を作成します。

<BASEURL>/hubble/external/search/v2/{<ENCODED-URL-FROM-ABOVE>}