REST Resource: settings.searchapplications

リソース: SearchApplication

SearchApplication

JSON 表現 
{
  "name": string,
  "displayName": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "sourceConfig": [
    {
      object (SourceConfig)
    }
  ],
  "scoringConfig": {
    object (ScoringConfig)
  },
  "defaultSortOptions": {
    object (SortOptions)
  },
  "defaultFacetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "returnResultThumbnailUrls": boolean,
  "operationIds": [
    string
  ],
  "enableAuditLog": boolean,
  "queryInterpretationConfig": {
    object (QueryInterpretationConfig)
  }
}
フィールド
name

string

検索アプリケーションの名前。

形式: searchapplications/{applicationId}。
displayName

string

検索アプリケーションの表示名。最大長は 300 文字です。
dataSourceRestrictions[]

object (DataSourceRestriction)

構成に適用される制限。要素の最大数は 10 です。
sourceConfig[]

object (SourceConfig)

dataSourceRestrictions で指定されたソースの構成。
scoringConfig

object (ScoringConfig)

結果をランク付けするための構成。
defaultSortOptions

object (SortOptions)

検索結果の並べ替えに関するデフォルトのオプション
defaultFacetOptions[]

object (FacetOptions)

ファセット結果を返すためのデフォルト フィールド。ここで指定したソースは、上記の dataSourceRestrictions にも含まれています。
returnResultThumbnailUrls

boolean

結果ごとにサムネイルの URI を返す必要があります（該当する場合）。
operationIds[]

string

出力専用。このスキーマで現在実行されている長時間実行オペレーション（LRO）の ID。出力専用フィールド。
enableAuditLog

boolean

クエリ API で検索アプリケーションに対して行われたリクエストに対して監査ロギングが有効か無効かを示します。
queryInterpretationConfig

object (QueryInterpretationConfig)

クエリ解釈のデフォルト オプション

DataSourceRestriction

データソースに関する制限。

JSON 表現 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
フィールド
source

object (Source)

制限のソース。
filterOptions[]

object (FilterOptions)

結果を制限するフィルタ オプション。複数のフィルタが存在する場合は、結合する前にオブジェクト タイプ別にグループ化されます。同じオブジェクト タイプを持つフィルタは連結して結合され、その後、結果の式は分離して結合されます。

要素の最大数は 20 です。

注: Suggestion API で現在サポートされているフィルタは、「objecttype」、「type」のごく一部のみです。「mimetype」を指定します。現時点では、スキーマ固有のフィルタを使用して候補をフィルタすることはできません。

ソース

候補/検索 API のソースを定義します。

JSON 表現 
{

  // Union field source can be only one of the following:
  "name": string,
  "predefinedSource": enum (Source.PredefinedSource)
  // End of list of possible types for union field source.
}
フィールド

共用体フィールド source。

source は次のいずれかになります。
name

string

Indexing API によってインデックスに登録されたコンテンツのソース名。
predefinedSource

enum (Source.PredefinedSource)

Google Apps の事前定義されたコンテンツ ソース。

Source.PredefinedSource

事前定義されたソース:

列挙型
NONE
QUERY_HISTORY ユーザーが過去に発行したクエリを提案します。Suggestion API で使用する場合にのみ有効です。クエリ API で使用する場合は無視されます。
PERSON 組織内のユーザーを示唆する。Suggestion API で使用する場合にのみ有効です。クエリ API で使用すると、エラーが発生します。
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

FilterOptions

クエリに適用するフィルタ オプション。

JSON 表現 
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
フィールド
objectType

string

objectType が設定されている場合、そのタイプのオブジェクトのみが返されます。これは、スキーマの定義内で登録されたオブジェクトの名前に対応している必要があります。最大長は 256 文字です。
filter

object (Filter)

検索を制限する汎用フィルタ（lang:en、site:xyz など）。

フィルタ

クエリでフィルタを表現する一般的な方法で、次の 2 つのアプローチがサポートされています。

1. ValueFilter の設定。名前は、データソースのスキーマで定義されたオペレーター名と一致する必要があります。

2. CompositeFilter の設定。フィルタは論理演算子を使用して評価されます。トップレベル演算子に使用できるのは AND または NOT のいずれかです。かつ、最上位レベルにのみ使用できます。OR は、最上位の AND の下にのみ指定できます。

JSON 表現 
{

  // Union field filter can be only one of the following:
  "valueFilter": {
    object (Filter.ValueFilter)
  },
  "compositeFilter": {
    object (Filter.CompositeFilter)
  }
  // End of list of possible types for union field filter.
}
フィールド

共用体フィールド filter。

filter は次のいずれかになります。
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

JSON 表現 
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
フィールド
operatorName

string

クエリに適用される operatorName（price_greater_than など）。フィルタは、データソースのスキーマで定義されている次の両方のタイプのフィルタに対して機能します。

  1. operatorName。クエリは、値と一致するプロパティで結果をフィルタリングします。

  2. スキーマ内の greaterThanOperatorName または lessThanOperatorName。このクエリでは、クエリで指定された値より大きいまたは小さいプロパティ値で結果をフィルタします。
value

object (Value)

比較対象の値。

値

汎用型での単一の値の定義。

JSON 表現 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "doubleValue": number,
  "timestampValue": string,
  "booleanValue": boolean,
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
フィールド
共用体フィールド value。指定されたプロパティの値。value は次のいずれかになります。
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
booleanValue

boolean
dateValue

object (Date)

Filter.CompositeFilter

JSON 表現 
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
フィールド
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

サブフィルタの論理演算子。
subFilters[]

object (Filter)

サブフィルタ。

Filter.CompositeFilter.LogicOperator

列挙型
AND 論理演算子。サブフィルタにのみ適用できます。
OR
NOT NOT は、1 つのサブフィルタにのみ適用できます。

SourceConfig

query.search リクエストまたは query.suggest リクエストの処理中のソースの構成。

JSON 表現 
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
フィールド
source

object (Source)

この構成を使用するソース。
scoringConfig

object (SourceScoringConfig)

ソースのスコア設定。
crowdingConfig

object (SourceCrowdingConfig)

ソースのクラウディング構成。

SourceScoringConfig

スコアリング構成を設定します。これにより、ソースに対する結果のランキングを変更できます。

JSON 表現 
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
フィールド
sourceImportance

enum (SourceScoringConfig.SourceImportance)

ソースの重要性。

SourceScoringConfig.SourceImportance

あるソースが他のソースよりもランキングで優先されるべきかどうかを示すために使用できるソースの重要度。

列挙型
DEFAULT
LOW
HIGH

SourceCrowdingConfig

検索結果のクラウディングの上限を設定する。クラウディングとは、同じソースまたはホストから複数の結果が「クラウドアウト」する状況です。ユーザーの検索の質が低下します。検索結果における検索の質とソースの多様性を高めるために、ソースごとに繰り返し検索結果を減らす条件を設定できます。

JSON 表現 
{
  "numResults": integer,
  "numSuggestions": integer
}
フィールド
numResults

integer

他のソースからの結果が枯渇しない限り、検索結果ページ内のデータソースから許可される結果の最大数。負の値は指定できません。この値が 0 の場合はデフォルト値が使用されます。クラウディングを無効にするには、100 より大きい値を設定します。
numSuggestions

integer

ソースから許可される候補の最大数。この値が 0 以下の場合、結果に制限は設定されません。

ScoringConfig

query.search または query.suggest リクエストの処理中のソースの構成のスコアリング。

JSON 表現 
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
フィールド
disableFreshness

boolean

鮮度をランキング シグナルとして使用するかどうか。デフォルトでは、鮮度はランキング シグナルとして使用されます。なお、この設定は管理 UI では使用できません。
disablePersonalization

boolean

検索結果をカスタマイズするかどうかを指定します。デフォルトでは、成果を高めるためにパーソナル シグナルが使用されます。

SortOptions

JSON 表現 
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
フィールド
operatorName

string

並べ替えるフィールドに対応する演算子の名前。対応するプロパティを sortable としてマークする必要があります。
sortOrder

enum (SortOptions.SortOrder)

デフォルトの並べ替え順は昇順です。

SortOptions.SortOrder

列挙型
ASCENDING
DESCENDING

FacetOptions

ファセット結果を返す演算子を指定します。sourceName、objectType、operatorName の組み合わせごとに 1 つの FacetResult があります。

JSON 表現 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
フィールド
sourceName

string

ファセットのソース名。形式: datasources/{sourceId}。空の場合、すべてのデータソースが使用されます。
objectType

string

ObjectType が設定されている場合、そのタイプのオブジェクトのみがファセットの計算に使用されます。空の場合、すべてのオブジェクトがファセットの計算に使用されます。
operatorName

string

ファセットに選択された演算子の名前。@cloudsearch.SchemaPropertyOptions をご覧ください
numFacetBuckets

integer

このファセットに対して返されるファセット バケットの最大数。デフォルトは 10 です。最大値は 100 です。
integerFacetingOptions

object (IntegerFacetingOptions)

設定されている場合、指定された整数プロパティの整数ファセット オプションを記述します。スキーマ内の対応する整数プロパティは、isFacetable とマークする必要があります。返されるバケットの数は、こ と numFacetBuckets の最小数になります。

IntegerFacetingOptions

整数ファセット オプションの指定に使用されます。

JSON 表現 
{
  "integerBuckets": [
    string
  ]
}
フィールド
integerBuckets[]

string (Int64Value format)

特定の整数値のバケットは厳密に昇順である必要があります。たとえば、指定された値が (1,5,10,100) の場合、次のファセット バケットは {<1, [1,5), [5-10), [10-100), >=100} という形式になります。

QueryInterpretationConfig

ユーザークエリを解釈するためのデフォルト オプション。

JSON 表現 
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
フィールド
forceVerbatimMode

boolean

このフラグを有効にすると、クエリの自然言語（NL）解釈、補足結果の取得、類義語（カスタム キーワードを含む）の使用など、すべての内部最適化が無効になります。このフラグを True に設定した場合、クエリレベルで設定されたオプションよりも優先されます。デフォルト値が False の場合、クエリレベル フラグにより、逐語モードの正しい解釈が設定されます。
forceDisableSupplementalResults

boolean

このフラグを設定すると、補助的な結果の取得が無効になります。ここでフラグを設定しても、特定の検索アプリケーションに関連付けられたクエリの補助結果は取得されません。このフラグを True に設定した場合、クエリレベルで設定されたオプションよりも優先されます。デフォルト値が False の場合、クエリレベル フラグにより、補足結果の正しい解釈が設定されます。

メソッド

create

 検索アプリケーションを作成します。

delete

 検索アプリケーションを削除します。

get

 指定された検索アプリケーションを取得します。

list

 すべての検索アプリケーションを一覧表示します。

patch

 検索アプリケーションを更新します。

reset

 検索アプリケーションをデフォルト設定にリセットします。

update

 検索アプリケーションを更新します。