Schema

データソースのスキーマ定義です。

JSON 表現
{
  "objectDefinitions": [
    {
      object (ObjectDefinition)
    }
  ],
  "operationIds": [
    string
  ]
}
フィールド
objectDefinitions[]

object (ObjectDefinition)

データソースのトップレベル オブジェクトのリスト。要素の最大数は 10 です。

operationIds[]

string

このスキーマで現在実行されている長時間実行オペレーション(LRO)の ID。スキーマを変更したら、オペレーションが完了するのを待ってから、追加のコンテンツをインデックスに登録します。

オブジェクト定義

データソース内のオブジェクトの定義。

JSON 表現
{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}
フィールド
name

string

オブジェクトの名前(タイプを定義します)。アイテムのインデックス登録リクエストでは、objectType フィールドをこの値と等しく設定する必要があります。たとえば、name が Document の場合、Document タイプのインデックス登録リクエストには、Document と等しくなる必要があります。各オブジェクト定義には、スキーマ内で一意の名前を付ける必要があります。名前の先頭は英字にしてください。その後には、英字(A ~ Z、a ~ z)または数字(0 ~ 9)のみを使用できます。最大文字数は 256 文字です。

options

object (ObjectOptions)

オプションのオブジェクト固有のオプション。

propertyDefinitions[]

object (PropertyDefinition)

オブジェクトのプロパティ定義です。要素の最大数は 1,000 個です。

オブジェクト オプション

オブジェクトのオプション。

JSON 表現
{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}
フィールド
freshnessOptions

object (ObjectOptions.FreshnessOptions)

オブジェクトの鮮度オプション。

displayOptions

object (ObjectDisplayOptions)

Cloud Search の検索結果ページでのオブジェクトの表示方法を決定するオプション。

suggestionFilteringOperators[]

string

候補のフィルタリングに使用できる演算子。query.suggest API の場合、ここで説明している演算子のみが FilterOptions で使用されます。TEXT 演算子と ENUM 演算子のみがサポートされています。

注: 「オブジェクト タイプ」と「mimetype」は、すでにサポートされています。このプロパティは、スキーマ固有の演算子を構成します。

これは配列ですが、指定できる演算子は 1 つのみです。これは将来の拡張のための配列です。

同じオブジェクト内の複数のプロパティにマッピングする演算子はサポートされていません。演算子が複数のオブジェクト タイプにまたがっている場合、このオプションをオブジェクト定義ごとに 1 回設定する必要があります。

ObjectOptions.FreshnessOptions

商品アイテムの検索ランキングを調整するときに使用する更新頻度プロパティを指定します。日付が新しいほど日付が長くなります。データに最適な鮮度オプション プロパティを使用します。ファイル共有のドキュメントの場合、最終更新日時が最も重要です。カレンダーの予定のデータの場合、更新のタイミングはより適切な更新頻度の指標となります。このようにして、検索クエリの近くで発生したカレンダーの予定は品質が高いと見なされ、それに応じてランク付けされます。

JSON 表現
{
  "freshnessProperty": string,
  "freshnessDuration": string
}
フィールド
freshnessProperty

string

このプロパティは、インデックス内のオブジェクトの鮮度レベルを示します。設定する場合、このプロパティは property definitions 内の最上位のプロパティである必要があり、timestamp type または date type である必要があります。それ以外の場合、Indexing API は鮮度インジケーターとして updateTime を使用します。最大文字数は 256 文字です。

鮮度の計算にプロパティが使用される場合、値はデフォルトで現在時刻から 2 年後に設定されます。

freshnessDuration

string (Duration format)

オブジェクトが古くなったとみなされるまでの時間。デフォルト値は 180 日(秒単位)です。

小数点以下 9 桁まで、「s」で終わる秒単位の期間(例: "3.5s")。

ObjectDisplayOptions

オブジェクトの表示オプションです。

JSON 表現
{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}
フィールド
objectDisplayLabel

string

検索結果に表示されるアイテムのタイプを示す、ユーザー フレンドリーなラベル。これはオプションです。指定しない場合、オブジェクトのラベルは検索結果のコンテキスト ラインに表示されません。最大文字数は 64 文字です。

metalines[]

object (ObjectDisplayOptions.Metaline)

検索結果のメタラインに表示されるプロパティを定義します。プロパティ値は、次に示す順序で表示されます。プロパティに複数の値がある場合は、すべての値が次のプロパティの前に表示されます。このため、このリストで反復プロパティの前に単一プロパティを指定することをおすすめします。すべてのプロパティは isReturnable を true に設定する必要があります。メタラインの最大数は 3 です。

ObjectDisplayOptions.Metaline

メタラインは、検索結果と一緒に表示されるプロパティのリストで、コンテキストを提供します。

JSON 表現
{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}
フィールド
properties[]

object (ObjectDisplayOptions.DisplayedProperty)

メタラインに表示するプロパティのリスト。プロパティの最大数は 5 個です。

ObjectDisplayOptions.DisplayedProperty

検索結果に表示される、オブジェクト内のトップレベル プロパティへの参照。選択したプロパティの値は、そのプロパティの display label とともに検索結果に表示されます。ディスプレイ ラベルが指定されていない場合は、値のみが表示されます。

JSON 表現
{
  "propertyName": string
}
フィールド
propertyName

string

オブジェクトのプロパティ定義で定義されているトップレベルのプロパティの名前。名前がスキーマの定義済みプロパティでない場合、スキーマを更新しようとするとエラーが発生します。

PropertyDefinition

オブジェクト内のプロパティの定義。

JSON 表現
{
  "name": string,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isSuggestable": boolean,
  "isWildcardSearchable": boolean,
  "displayOptions": {
    object (PropertyDisplayOptions)
  },

  // Union field property_options can be only one of the following:
  "integerPropertyOptions": {
    object (IntegerPropertyOptions)
  },
  "doublePropertyOptions": {
    object (DoublePropertyOptions)
  },
  "timestampPropertyOptions": {
    object (TimestampPropertyOptions)
  },
  "booleanPropertyOptions": {
    object (BooleanPropertyOptions)
  },
  "objectPropertyOptions": {
    object (ObjectPropertyOptions)
  },
  "enumPropertyOptions": {
    object (EnumPropertyOptions)
  },
  "datePropertyOptions": {
    object (DatePropertyOptions)
  },
  "textPropertyOptions": {
    object (TextPropertyOptions)
  },
  "htmlPropertyOptions": {
    object (HtmlPropertyOptions)
  }
  // End of list of possible types for union field property_options.
}
フィールド
name

string

宿泊施設の名前。Indexing API に送信されるアイテムのインデックス登録リクエストでは、property name をこの値に設定する必要があります。たとえば、名前が subject_line の場合は、件名フィールドを含むドキュメント アイテムのインデックス リクエストで、そのフィールドの namesubject_line と同じにする必要があります。この名前をオブジェクト プロパティの識別子として使用します。この名前をオブジェクトのプロパティとして登録すると、そのオブジェクトの別のプロパティにこの名前を再利用することはできません。名前の先頭は英字にしてください。その後には、英字(A ~ Z、a ~ z)または数字(0 ~ 9)のみを使用できます。最大文字数は 256 文字です。

isReturnable

boolean

プロパティは、Query API を介して検索結果に返すデータを識別します。true に設定されている場合は、Query API のユーザーが結果で一致するプロパティ フィールドを使用できることを示します。ただし、フィールドを保存すると、より多くのスペースが割り当てられ、検索クエリで使用する帯域幅が増えるため、大規模なデータセットでのパフォーマンスに影響します。検索結果でこのフィールドが必要な場合にのみ、true に設定します。タイプがオブジェクトであるプロパティには true にすることはできません。

isRepeatable

boolean

宿泊施設に複数の値が許可されていることを示します。たとえば、ドキュメントには 1 つの説明のみを含めることができ、複数のコメントを含めることができます。タイプがブール値であるプロパティには true を指定できません。false に設定すると、複数の値を含むプロパティはアイテムのインデックス処理リクエストを拒否します。

isSortable

boolean

並べ替えにプロパティを使用できることを示します。反復可能なプロパティには true を指定できません。タイプがオブジェクトであるプロパティに対して true にすることはできません。このオプションを設定するには、IsReturnable を true にする必要があります。ブール値、日付、倍精度、整数、タイムスタンプのプロパティでのみサポートされます。

isFacetable

boolean

プロパティをファセットの生成に使用できることを示します。タイプがオブジェクトであるプロパティに対して true にすることはできません。このオプションを設定するには、IsReturnable を true にする必要があります。ブール値、列挙型、テキストのプロパティでのみサポートされています。

isSuggestable

boolean

このプロパティがクエリの候補の生成に使用できることを示します。

isWildcardSearchable

boolean

ユーザーがこのプロパティでワイルドカード検索を実行できることを示します。テキスト プロパティでのみサポートされています。このオプションを設定するには、IsReturnable を true にする必要があります。1 つのデータソースで最大 5 つのプロパティを isWildcardSearchable としてマークできます。

displayOptions

object (PropertyDisplayOptions)

オブジェクトの display options に表示するよう指定されている場合に Cloud Search 検索結果にページをどのように表示するかを指定するオプションです。

共用体フィールド property_options。プロパティのインデックス登録方法と使用方法を決定するタイプ固有のオプション。オプションをあるタイプのデフォルトのオプションにする必要がある場合でも、このフィールドはいずれかの型に設定する必要があります。このフィールドが設定されていない場合、スキーマの更新は拒否されます。property_options は次のいずれかになります。
integerPropertyOptions

object (IntegerPropertyOptions)

doublePropertyOptions

object (DoublePropertyOptions)

timestampPropertyOptions

object (TimestampPropertyOptions)

booleanPropertyOptions

object (BooleanPropertyOptions)

objectPropertyOptions

object (ObjectPropertyOptions)

enumPropertyOptions

object (EnumPropertyOptions)

datePropertyOptions

object (DatePropertyOptions)

textPropertyOptions

object (TextPropertyOptions)

htmlPropertyOptions

object (HtmlPropertyOptions)

IntegerPropertyOptions

整数のプロパティのオプション。

JSON 表現
{
  "orderedRanking": enum (IntegerPropertyOptions.OrderedRanking),
  "minimumValue": string,
  "maximumValue": string,
  "operatorOptions": {
    object (IntegerPropertyOptions.IntegerOperatorOptions)
  }
}
フィールド
orderedRanking

enum (IntegerPropertyOptions.OrderedRanking)

整数のランク付けの順序を指定するために使用します。isRepeatable が false の場合にのみ使用できます。

minimumValue

string (Int64Value format)

プロパティの最小値。プロパティの最小値と最大値は、ordered ranking に基づいて結果をランク付けするために使用されます。最小値未満のインデックス リクエストは受け入れられ、最小値でインデックス登録されたアイテムと同じ重みでランク付けされます。

maximumValue

string (Int64Value format)

プロパティの最大値。プロパティの最小値と最大値は、ordered ranking に基づいて結果をランク付けするために使用されます。値が最大値より大きいインデックス登録リクエストは受け入れられ、最大値でインデックス登録された商品アイテムと同じ重みでランク付けされます。

operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

設定した場合、整数を検索演算子として使用する方法を記述します。

IntegerPropertyOptions.OrderedRanking

他の値と比較した整数値のランク付け方法を指定するために使用します。優先順位の高い整数ほど、重要度が高くなります。たとえば、データソースによっては優先度が低いほど重要度が高く、優先度が高いほど重要度が高くなることを示します。

列挙型
NO_ORDER この宿泊施設にランク付けの順番はありません。結果は、このプロパティの値で調整されません。
ASCENDING このプロパティは昇順でランク付けされています。値が小さいほどランキングが低くなります。
DESCENDING このプロパティは降順でランク付けされています。値が小さいほどランキングが高くなります。

IntegerPropertyOptions.IntegerOperatorOptions

整数型のプロパティを検索演算子として使用するために使用されます。これはオプションです。query.search 演算子を使用すると、検索対象の項目のタイプに関連する特定のフィールドにクエリを限定できます。

JSON 表現
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
フィールド
operatorName

string

整数のプロパティを分離するためにクエリに必要な演算子名を示します。たとえば、& というクエリの場合、演算子名に使用できるのは小文字(a ~ z)のみです。最大文字数は 32 文字です。

lessThanOperatorName

string

クエリより小さい演算子を使用して整数プロパティを分離するためにクエリに必要な演算子名を示します。たとえば、lessThanOperatorName が優先度で、プロパティ名が priorityVal の場合、priorityVal:<value> のようなクエリでも、priorityVal という名前のプロパティ値が <value> より小さい場合のみ結果が表示されます。演算子名に使用できるのは小文字(a ~ z)のみです。最大文字数は 32 文字です。

greaterThanOperatorName

string

大なり演算子を使用して整数プロパティを分離するために、クエリで必要な演算子名を示します。たとえば、greatThanOperatorName が priority above で、プロパティの名前が priorityVal である場合、priorityabove:<value> のようなクエリでは、priorityVal という名前のプロパティ値が <value> より大きい結果のみが表示されます。演算子名に使用できるのは小文字(a ~ z)のみです。最大文字数は 32 文字です。

DoublePropertyOptions

double プロパティのオプション。

JSON 表現
{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}
フィールド
operatorOptions

object (DoublePropertyOptions.DoubleOperatorOptions)

設定されている場合、double を検索演算子として使用する方法を記述します。

DoublePropertyOptions.DoubleOperatorOptions

Double プロパティの検索演算子を提供するために使用されます。これはオプションです。query.search 演算子を使用すると、検索対象の項目のタイプに関連する特定のフィールドにクエリを限定できます。

JSON 表現
{
  "operatorName": string
}
フィールド
operatorName

string

並べ替えまたはファセットとして double プロパティを使用するためにクエリに必要な演算子名を示します。演算子名に使用できるのは小文字(a ~ z)のみです。最大文字数は 32 文字です。

TimestampPropertyOptions

タイムスタンプ プロパティのオプション。

JSON 表現
{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}
フィールド
operatorOptions

object (TimestampPropertyOptions.TimestampOperatorOptions)

設定した場合、タイムスタンプを検索演算子として使用する方法を記述します。

TimestampPropertyOptions.TimestampOperatorOptions

タイムスタンプ プロパティの検索演算子を提供するために使用されます。これはオプションです。query.search 演算子を使用すると、検索対象の項目のタイプに関連する特定のフィールドにクエリを限定できます。

JSON 表現
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
フィールド
operatorName

string

タイムスタンプ プロパティを分離するためにクエリに必要な演算子名を示します。たとえば、close では、close演算子名に使用できるのは小文字(a ~ z)のみです。最大文字数は 32 文字です。

lessThanOperatorName

string

クエリを使用して演算子を指定し、タイムスタンプ プロパティを小なり演算子を使用して分離します。たとえば、lessThanOperatorName が closebefore で、プロパティの名前が closeDate である場合、closebefore:<value> のようなクエリでは、closeDate にあるプロパティの値が <value> よりも前の結果のみが表示されます。演算子名に使用できるのは小文字(a ~ z)のみです。最大文字数は 32 文字です。

greaterThanOperatorName

string

クエリより大きい演算子を使用してタイムスタンプ プロパティを分離するためにクエリに必要な演算子名を示します。たとえば、greatThanOperatorName が closeafter で、プロパティの名前が closeDate である場合、closeafter:<value> のようなクエリでは、closeDate というプロパティの値が <value> より後の結果のみが表示されます。演算子名に使用できるのは小文字(a ~ z)のみです。最大文字数は 32 文字です。

ブール値のプロパティ オプション

ブール値のプロパティのオプション。

JSON 表現
{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}
フィールド
operatorOptions

object (BooleanPropertyOptions.BooleanOperatorOptions)

設定した場合、ブール値を検索演算子として使用する方法を記述します。

BooleanPropertyOptions.BooleanOperatorOptions

ブール値のプロパティの検索演算子を提供するために使用されます。これはオプションです。query.search 演算子を使用すると、検索対象の項目のタイプに関連する特定のフィールドにクエリを限定できます。

JSON 表現
{
  "operatorName": string
}
フィールド
operatorName

string

ブール値のプロパティを分離するためにクエリに必要な演算子名を示します。たとえば、is を含む演算子名に使用できるのは小文字(a ~ z)のみです。最大文字数は 32 文字です。

ObjectPropertyOptions

オブジェクト プロパティのオプション。

JSON 表現
{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}
フィールド
subobjectProperties[]

object (PropertyDefinition)

サブオブジェクトのプロパティ。これらのプロパティは、ネストされたオブジェクトを表します。たとえば、このプロパティが住所を表す場合、subobjectProperties は streetcitystate などの名前で指定できます。要素の最大数は 1,000 個です。

EnumPropertyOptions

ユーザー クエリに一致する制限された文字列セットを定義し、それらの文字列値のランキングを設定し、それらの文字列とペアになる演算子名を定義して、ユーザーが特定の値を持つ項目だけに結果を絞り込むことができる列挙型プロパティのオプション。たとえば、優先度情報を含むリクエスト トラッキング システムのアイテムでは、有効な enum 値として p0 を定義し、この列挙型を演算子名 priority に結び付けることで、検索のユーザーがクエリに priority:p0 を追加し、結果セットを値 p0 のアイテムのみに制限することができます。

JSON 表現
{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}
フィールド
possibleValues[]

object (EnumPropertyOptions.EnumValuePair)

列挙型プロパティの有効な値のリスト。すべての EnumValuePairs で文字列を指定する必要があります。1 つの EnumValuePair に整数値を指定する場合、可能性のあるすべての EnumValuePairs が整数値を提供する必要があります。文字列値と整数値の両方が、すべての有効な値に対して一意である必要があります。設定した値は、削除や変更はできません。順序付けされたランキングを指定して、今後さらに多くの列挙値を挿入する可能性がある場合は、初期の整数値に空白を残して、登録済みの数値間に値を追加できるようにします。要素の最大数は 100 です。

orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

列挙値の順序付きランキングを指定するために使用され、可能性のある EnumValuePairs で指定された整数値がどのように結果をランク付けするかを決定します。指定すると、このプロパティに与えられるすべての EnumValuePair 値に対して整数値を指定する必要があります。isRepeatable が false の場合にのみ使用できます。

operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

設定されている場合、列挙型を検索演算子として使用する方法を記述します。

EnumPropertyOptions.EnumValuePair

列挙値ペアでは、必須の文字列値とオプションの整数値の 2 つが定義されます。文字列値では、その項目を取得するために必要なクエリ用語(優先順位の項目の p0 など)を定義します。整数値は、その文字列値の、同じプロパティの他の列挙値に対するランキングを決定します。たとえば、p00 を関連付けて、p11 などの別の列挙型を定義できます。同じ値を他のプロパティ値に対して指定した場合、その値を別の値に並べるには、この整数値を ordered ranking と組み合わせて使用する必要があります。ここでは、優先度のプロパティを降順(降順)にすることで、値が p0 のインデックスを付けたアイテムと p1 のインデックスを付けたアイテムを比較できます。ランク付けの順序が指定されていない場合、整数値はアイテムのランキングに影響しません。

JSON 表現
{
  "stringValue": string,
  "integerValue": integer
}
フィールド
stringValue

string

EnumValuePair の文字列値。最大文字数は 32 文字です。

integerValue

integer

EnumValuePair の整数値。負の数にすることはできません。(省略可)

EnumPropertyOptions.OrderedRanking

他の EnumValuePair 整数値に対する EnumValuePair 整数のランキング方向を指定するために使用されます。プロパティの中には、値が小さいほど重要度が高いことを示し、値が大きいほど重要度が高いことを示します。

列挙型
NO_ORDER この宿泊施設にランク付けの順番はありません。結果はこのプロパティの値によって調整されません。
ASCENDING このプロパティは昇順でランク付けされています。値が小さいほどランキングが低くなります。
DESCENDING このプロパティは降順でランク付けされています。値が小さいほどランキングが高くなります。

EnumPropertyOptions.EnumOperatorOptions

列挙型プロパティの検索演算子を提供するために使用されます。これはオプションです。query.search 演算子を使用すると、検索対象の項目のタイプに関連する特定のフィールドにクエリを限定できます。たとえば、可能な値 p0p1 を持つ priority 列挙型プロパティに演算子を指定しなかった場合、キーワード p0 を含むクエリは、priority プロパティの値として p0 を持つアイテムと他のフィールドに文字列 p0 を含むアイテムを返します。列挙型に演算子(priority など)を指定した場合、検索ユーザーは、演算子を使用して、このプロパティの値として p0 が指定されているアイテムのみに検索結果を絞り込めます。クエリには priority:p0 を指定します。

JSON 表現
{
  "operatorName": string
}
フィールド
operatorName

string

enum プロパティを分離するためにクエリに必要な演算子名を示します。たとえば、& というクエリの場合、演算子名に使用できるのは小文字(a ~ z)のみです。最大文字数は 32 文字です。

DatePropertyOptions

日付のプロパティのオプション。

JSON 表現
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
フィールド
operatorOptions

object (DatePropertyOptions.DateOperatorOptions)

設定した場合、日付を検索演算子として使用する方法を記述します。

DatePropertyOptions.DateOperatorOptions

省略可。日付プロパティの検索演算子を提供します。query.search 演算子を使用すると、検索対象の項目のタイプに関連する特定のフィールドにクエリを限定できます。

JSON 表現
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
フィールド
operatorName

string

日付プロパティを分離するために、クエリで実際に必要となる文字列を示します。たとえば、問題追跡スキーマ オブジェクトには、closeDate という名前のプロパティがあり、OperatorName に closedon が指定されているとします。そのデータを検索する場合、closedon:<value> などのクエリでは closeDate プロパティの値が <value> と一致する場合のみ結果が表示されます。これに対して演算子と同じ <value> を使用しない検索では、コンテンツ フィールドの値としてインデックス登録されている文字列フィールドの値やテキスト フィールドの値が、<value> となっているものをすべて返します。演算子名に使用できるのは小文字(a ~ z)のみです。最大文字数は 32 文字です。

lessThanOperatorName

string

クエリを演算子といい、演算子を使用して日付プロパティを分離するために指定する演算子名を指定します。たとえば、lessThanOperatorName が closebefore で、プロパティの名前が closeDate である場合、closebefore:<value> のようなクエリでは、closeDate にあるプロパティの値が <value> よりも前の結果のみが表示されます。演算子名に使用できるのは小文字(a ~ z)のみです。最大文字数は 32 文字です。

greaterThanOperatorName

string

大なり演算子を使用して日付プロパティを分離するためにクエリに必要な演算子名を示します。たとえば、greatThanOperatorName が closeafter で、プロパティの名前が closeDate である場合、closeafter:<value> のようなクエリでは、closeDate というプロパティの値が <value> より後の結果のみが表示されます。演算子名に使用できるのは小文字(a ~ z)のみです。最大文字数は 32 文字です。

テキスト プロパティ オプション

テキスト プロパティのオプション。

JSON 表現
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}
フィールド
retrievalImportance

object (RetrievalImportance)

取得に使用されたときのフィールド内のトークンの検索品質の重要度を示します。

operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

設定されている場合、プロパティを検索演算子として使用する方法を記述します。

取得の重要度

JSON 表現
{
  "importance": enum (RetrievalImportance.Importance)
}
フィールド
importance

enum (RetrievalImportance.Importance)

取得中に照合された宿泊施設のランキングの重要度を示します。一度設定したトークンの重要度は変更できません。

RetrievalImportance.Importance(インポートのインポートとインポート)

列挙型
DEFAULT 一致は本文テキストの一致として扱われます。
HIGHEST 一致するアイテムはタイトルとの照合として扱われます。
HIGH 本文テキストよりも重要度が高くなるようにします。
LOW 本文テキストよりも重要度が低いテキストと照合します。
NONE 取得中はこのフィールドと照合しないでください。このプロパティは、演算子の一致、ファセット、提案(必要に応じて)にも使用できます。

TextPropertyOptions.TextOperatorOptions

テキスト プロパティの検索演算子を提供するために使用されます。これはオプションです。query.search 演算子を使用すると、検索対象の項目のタイプに関連する特定のフィールドにクエリを限定できます。

JSON 表現
{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}
フィールド
operatorName

string

テキスト プロパティを分離するためにクエリに必要な演算子名を示します。たとえば、subject:演算子名に使用できるのは小文字(a ~ z)のみです。最大文字数は 32 文字です。

exactMatchWithOperator

boolean

true の場合、テキスト検索と演算子の一致で 1 つのアトミック値としてテキスト値がトークン化されます。たとえば、演算子名が「science-フィクション」であり、値が「science-フィクション」であり、クエリ制限が「genre:science"」および「genre:science"」がアイテムと一致しない場合。テキスト値の照合では大文字と小文字が区別され、特殊文字は削除されません。false の場合、テキストはトークン化されます。たとえば、値が「science-フィクション」の場合、検索語句が「genre:science"」および「genre:フィクション"」で一致することを確認します。

HTMLPropertyOptions

HTML プロパティのオプションです。

JSON 表現
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}
フィールド
retrievalImportance

object (RetrievalImportance)

取得に使用されたときのフィールド内のトークンの検索品質の重要度を示します。DEFAULT または NONE にのみ設定できます。

operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

設定されている場合、プロパティを検索演算子として使用する方法を記述します。

HtmlPropertyOptions.HtmlOperatorOptions

HTML プロパティの検索演算子を提供するために使用されます。これはオプションです。query.search 演算子を使用すると、検索対象の項目のタイプに関連する特定のフィールドにクエリを限定できます。

JSON 表現
{
  "operatorName": string
}
フィールド
operatorName

string

html プロパティを分離するためにクエリに必要な演算子名を示します。たとえば、subject:演算子名に使用できるのは小文字(a ~ z)のみです。最大文字数は 32 文字です。

PropertyDisplayOptions

プロパティの表示オプション。

JSON 表現
{
  "displayLabel": string
}
フィールド
displayLabel

string

プロパティのユーザー フレンドリーなラベル。プロパティが ObjectDisplayOptions に表示されるよう指定されている場合に使用されます。指定した場合、そのプロパティがオブジェクト表示オプションの一部である場合に、表示値がプロパティ値の前に表示されます。たとえばプロパティ値が '1' の場合、値はユーザーにとって有用なコンテキストとは限りません。指定された表示名が「優先度」の場合は、ユーザーには優先値 1&#39 が表示されます。これにより、検索ユーザーに明確なコンテキストが提供されます。省略可能です。指定しない場合はプロパティ値のみが表示されます。最大文字数は 64 文字です。