Schema

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

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

object (ObjectDefinition)

データソースの最上位オブジェクトのリスト。要素の最大数は 10 です。
operationIds[]

string

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

ObjectDefinition

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

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

string

オブジェクトの名前。これによって型が定義されます。アイテムのインデックス登録リクエストでは、objectType フィールドをこの値に設定する必要があります。たとえば、name が Document の場合、Document 型のアイテムのインデックス登録リクエストでは、objectType を Document に設定する必要があります。各オブジェクト定義は、スキーマ内で一意に名前を付ける必要があります。名前は先頭を英字にする必要があり、英字（A ～ Z、a ～ z）または数字（0 ～ 9）のみを使用できます。最大長は 256 文字です。
options

object (ObjectOptions)

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

object (PropertyDefinition)

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

ObjectOptions

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

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 演算子のみがサポートされています。

注: "objecttype"、"type"および「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 日（秒単位）です。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

ObjectDisplayOptions

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

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

string

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

object (ObjectDisplayOptions.Metaline)

検索結果のメタラインに表示されるプロパティを定義します。プロパティ値はここに示されている順序で表示されます。プロパティが複数の値を保持している場合は、次のプロパティの前にすべての値が表示されます。このため、このリストで繰り返しプロパティを指定する前に、1 つのプロパティを指定することをおすすめします。すべてのプロパティで 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 の場合、サブジェクト フィールドを持つドキュメント アイテムのインデックス登録リクエストでは、そのフィールドの name を subject_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

ユーザーがこのプロパティに対してワイルドカード検索を実行できることを示します。Text プロパティでのみサポートされています。このオプションを設定するには、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)
  },
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
フィールド
orderedRanking

enum (IntegerPropertyOptions.OrderedRanking)

整数の順序付きランキングを指定するために使用されます。isRepeatable が false の場合にのみ使用できます。
minimumValue

string (Int64Value format)

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

string (Int64Value format)

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

object (IntegerPropertyOptions.IntegerOperatorOptions)

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

object (IntegerFacetingOptions)

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

IntegerPropertyOptions.OrderedRanking

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

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

IntegerPropertyOptions.IntegerOperatorOptions

整数プロパティの検索演算子を指定するために使用します。これは省略可能です。query.search 演算子を使用すると、ユーザーは検索対象のアイテムのタイプに関連する特定のフィールドにクエリを制限できます。

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

string

整数プロパティを分離するためにクエリに必要な演算子名を示します。たとえば、operatorName が primary でプロパティ名が primaryVal の場合、Priority:<value> のようなクエリを実行すると、primaryVal という名前のプロパティの値が <value> と一致する結果のみが表示されます。一方、演算子なしで同じ &lt;value&gt; を使用して検索すると、&lt;value&gt; がアイテムの Content フィールド内の文字列プロパティまたはテキストの値と一致するすべてのアイテムが返されます。演算子名に使用できるのは小文字（a ～ z）のみです。最大 32 文字までです。
lessThanOperatorName

string

小なり演算子を使用して整数プロパティを分離するために、クエリに必要な演算子名を指定します。たとえば、 lessThanOperatorName が アクション () で、プロパティの名前が PriorityVal の場合、 <ph type="x-smartling-placeholder"></ph> のようなクエリは、<ph type="x-smartling-void-element"><wbr /></ph><ph type="x-smartling-void-element"><wbr /></ph><演算子名に使用できるのは小文字（a ～ z）のみです。最大 32 文字までです。
greaterThanOperatorName

string

大なり演算子を使用して整数プロパティを分離するために、クエリに必要な演算子名を指定します。たとえば、largeThanOperatorName が アクション優先で、プロパティ名が アクション アンド プロダクション の場合、primary above:<value> のようなクエリを実行すると、primaryVal という名前のプロパティの値が <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

タイムスタンプ プロパティを分離するためにクエリに必要な演算子名を示します。たとえば、operatorName が closedon で、プロパティの名前が closeDate の場合、「closedon:<value>」のようなクエリを実行すると、closeDate という名前のプロパティの値が <value> と一致する結果のみが表示されます。一方、演算子なしで同じ &lt;value&gt; を使用して検索すると、&lt;value&gt; がアイテムの Content フィールド内の文字列プロパティまたはテキストの値と一致するすべてのアイテムが返されます。演算子名に使用できるのは小文字（a ～ z）のみです。最大 32 文字までです。
lessThanOperatorName

string

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

string

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

BooleanPropertyOptions

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

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

object (BooleanPropertyOptions.BooleanOperatorOptions)

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

BooleanPropertyOptions.BooleanOperatorOptions

ブール値プロパティの検索演算子を指定するために使用されます。これは省略可能です。query.search 演算子を使用すると、ユーザーは検索対象のアイテムのタイプに関連する特定のフィールドにクエリを制限できます。

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

string

ブール値のプロパティを分離するためにクエリに必要な演算子名を示します。たとえば、operatorName が closed で、プロパティの名前が isClosed の場合、closed:<value> のようなクエリを実行すると、isClosed という名前のプロパティの値が <value> と一致する結果のみが表示されます。一方、演算子なしで同じ &lt;value&gt; を使用して検索すると、&lt;value&gt; がアイテムの Content フィールド内の文字列プロパティまたはテキストの値と一致するすべてのアイテムが返されます。演算子名に使用できるのは小文字（a ～ z）のみです。最大 32 文字までです。

ObjectPropertyOptions

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

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

object (PropertyDefinition)

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

EnumPropertyOptions

列挙型プロパティのオプションを使用すると、ユーザークエリに一致する一連の限定された文字列を定義し、それらの文字列値のランキングを設定して、それらの文字列とペアにする演算子名を定義できます。これにより、ユーザーは特定の値を持つアイテムのみに検索結果を絞り込むことができます。たとえば、リクエスト追跡システム内のアイテムに優先度情報がある場合、p0 を許容する列挙値として定義し、この列挙型を演算子名 Priority に関連付けることができます。これにより、検索ユーザーはクエリに primary:p0 を追加して、結果を p0 のインデックスが付いたアイテムのみに制限できます。

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

object (EnumPropertyOptions.EnumValuePair)

列挙プロパティの有効な値のリスト。すべての EnumValuePairs に文字列値を指定する必要があります。1 つの EnumValuePair に整数値を指定する場合は、可能性のあるすべての EnumValuePair が整数値を指定する必要があります。文字列値と整数値はどちらも、指定可能なすべての値に対して一意である必要があります。設定可能な値を削除または変更することはできません。順序付けされたランキングを提供し、将来追加の列挙値を挿入する可能性がある場合は、以前に登録された値の間に値を追加できるように、初期整数値にギャップを残します。要素の最大数は 100 です。
orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

可能な EnumValuePairs で指定された整数値を使用して結果のランク付けを行う方法を決定する、列挙型の順序付きランキングを指定するために使用されます。指定する場合は、このプロパティに指定されたすべての EnumValuePair 値に整数値を指定する必要があります。isRepeatable が false の場合にのみ使用できます。
operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

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

EnumPropertyOptions.EnumValuePair

列挙値のペアでは、必須の文字列値とオプションの整数値の 2 つを定義します。この文字列値は、優先度項目の p0 など、その項目を取得するために必要な検索語句を定義します。この整数値によって、同じプロパティの他の列挙値に対する文字列値のランキングが決まります。たとえば、p0 を 0 に関連付けて、別の列挙型ペア（p1 と 1 など）を定義できます。この整数値を ordered ranking と組み合わせて使用し、同じプロパティ名の他の列挙値と比較して特定の値のランキングを設定する必要があります。ここで、優先度プロパティの DESCENDING のランキング順序は、p1 の値でインデックス付けされたアイテムよりも、p0 の値でインデックス付けされたアイテムのランキングが上がります。ランキング順序を指定しなければ、この整数値はアイテムのランキングに影響しません。

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

string

EnumValuePair の文字列値。最大 32 文字までです。
integerValue

integer

EnumValuePair の整数値。負でない値にする必要があります。省略可。

EnumPropertyOptions.OrderedRanking

他の EnumValuePair 整数値に対する相対的な EnumValuePair 整数のランキング方向を指定するために使用されます。プロパティによっては、整数値が低いほど重要度が高く、他のプロパティでは重要度が高いことを示します。

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

EnumPropertyOptions.EnumOperatorOptions

列挙型プロパティの検索演算子を指定するために使用します。これは省略可能です。query.search 演算子を使用すると、ユーザーは検索対象のアイテムのタイプに関連する特定のフィールドにクエリを制限できます。たとえば、指定可能な値 p0 と p1 を持つ Priority 列挙型プロパティに演算子を指定しない場合、p0 という用語を含むクエリでは、primary プロパティの値が p0 であるアイテムと、他のフィールドに文字列 p0 を含むアイテムが返されます。列挙型に演算子名（primary など）を指定すると、検索ユーザーはその演算子を使用して、このプロパティの値として p0 を持つアイテムのみに結果を絞り込めます。その際、クエリを Priority:p0 とします。

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

string

列挙型プロパティを分離するためにクエリに必要な演算子名を示します。たとえば、operatorName が primary でプロパティ名が primaryVal の場合、Priority:<value> のようなクエリを実行すると、primaryVal という名前のプロパティの値が <value> と一致する結果のみが表示されます。一方、演算子なしで同じ &lt;value&gt; を使用して検索すると、&lt;value&gt; がアイテムの Content フィールド内の文字列プロパティまたはテキストの値と一致するすべてのアイテムが返されます。演算子名に使用できるのは小文字（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

date プロパティを分離するためにクエリに必要な実際の文字列を示します。たとえば、問題トラッキング スキーマ オブジェクトに closeDate という名前のプロパティがあり、演算子名が closedon の演算子が指定されているとします。このデータに対して検索する場合、closedon:&lt;value&gt; のようなクエリを使用すると、closedon:&lt;value&gt; プロパティの値が closedon:&lt;value&gt; と一致する結果のみが表示されます。一方、演算子を指定せずに同じ &lt;value&gt; を使用すると、インデックス付きデータソースのコンテンツ フィールド内の文字列プロパティまたはテキストに &lt;value&gt; が一致するすべてのアイテムが返されます。演算子名に使用できるのは小文字（a ～ z）のみです。最大 32 文字までです。
lessThanOperatorName

string

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

string

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

TextPropertyOptions

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

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

object (RetrievalImportance)

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

object (TextPropertyOptions.TextOperatorOptions)

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

RetrievalImportance

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

テキスト プロパティを分離するためにクエリに必要な演算子名を示します。たとえば、operatorName が subject で、プロパティの名前が subjectLine である場合、subject:<value> のようなクエリでは、subjectLine という名前のプロパティの値が <value> と一致する結果のみが表示されます。一方、演算子なしで同じ &lt;value&gt; を使用して検索すると、&lt;value&gt; がアイテムのテキスト プロパティまたはテキストの値と一致するすべてのアイテムが返されます。演算子名に使用できるのは小文字（a ～ z）のみです。最大 32 文字までです。
exactMatchWithOperator

boolean

true の場合、テキスト値は演算子検索とファセット一致で 1 つのアトミック値としてトークン化されます。たとえば演算子名が「genre」の場合値に「science-フィクション」がクエリ制限「genre:science」および「genre:フィクション」アイテムと一致していない「genre:science-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 プロパティを分離するためにクエリに必要な演算子名を指定します。たとえば、operatorName が subject で、プロパティの名前が subjectLine である場合、subject:<value> のようなクエリでは、subjectLine という名前のプロパティの値が <value> と一致する結果のみが表示されます。一方、演算子なしで同じ &lt;value&gt; を使用して検索すると、&lt;value&gt; がアイテムの content フィールド内の HTML プロパティまたはテキストの値と一致するすべてのアイテムが返されます。演算子名に使用できるのは小文字（a ～ z）のみです。最大 32 文字までです。

PropertyDisplayOptions

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

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

string

ObjectDisplayOptions でプロパティを表示するよう指定されている場合に使用されるプロパティのわかりやすいラベル。表示ラベルを指定すると、プロパティがオブジェクト表示オプションに含まれている場合、プロパティ値の前に表示ラベルが表示されます。たとえば、プロパティ値が「1」の場合、値そのものはユーザーにとって有用なコンテキストにはならない可能性があります。表示名が「primary」の場合は、「Priority : 1」と表示されます。検索結果に表示され、検索ユーザーに明確なコンテキストを提供します。これは省略可能です。指定しない場合、プロパティ値のみが表示されます。最大長は 64 文字です。