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 フィールドをこの値に設定する必要があります。たとえば、名前がドキュメントの場合、ドキュメント タイプのアイテムのインデックス登録リクエストでは、ドキュメントと objectType を等しく設定する必要があります。各オブジェクト定義には、スキーマ内で一意の名前を付ける必要があります。名前は先頭を英字にする必要があり、英字（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 演算子のみがサポートされています。

注: 「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 日（秒単位）です。

小数点以下 9 桁までの値で、末尾が「s」の秒数です。例: "3.5s"。

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

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

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

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

プロパティの定義

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

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 である場合、subject フィールドを持つドキュメント アイテムのインデックス登録リクエストでは、そのフィールドの name を subject_line に設定する必要があります。この名前をオブジェクト プロパティの識別子として使用します。この名前をオブジェクトのプロパティとして登録すると、そのオブジェクト内の別のプロパティにこの名前を再利用することはできません。名前は先頭を英字にする必要があり、英字（A ～ Z）、a ～ z）または数字（0 ～ 9）のみを使用できます。最大 256 文字です。
isReturnable

boolean

クエリ 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 にする必要があります。特定のデータソースで、isWildcardSearchable としてマークできるプロパティは最大 5 つです。詳細については、オブジェクト プロパティを定義するをご覧ください。
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 が priority で、プロパティの名前が priorityVal である場合、priority:<value> のようなクエリは、priorityVal というプロパティの値が <value> と一致する場合にのみ結果を表示します。同じ <value> を使用して検索すると、<value> がアイテム内の文字列フィールドまたはテキスト フィールドの値と一致するすべてのアイテムが返されます。演算子名に使用できるのは英小文字（a ～ z）のみです。最大 32 文字までです。
lessThanOperatorName

string

未満演算子を使用して整数プロパティを分離するためにクエリに必要な演算子名を示します。たとえば、lessThanOperatorName が priority under で、プロパティの名前が priorityVal の場合、priority 以下:<value> のようなクエリでは、priorityVal というプロパティの値が <value> より小さい場合の結果のみ表示されます。演算子名に使用できるのは英小文字（a ～ z）のみです。最大 32 文字までです。
greaterThanOperatorName

string

大なり演算子を使用して整数プロパティを分離するためにクエリに必要な演算子名を示します。たとえば、largeThanOperatorName が priority above で、プロパティの名前が priorityVal である場合、priority above:<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

タイムスタンプ プロパティを分離するためにクエリに必要な演算子名を示します。たとえば、operatorName が closedon で、プロパティの名前が closeDate の場合、closedon:<value> のようなクエリでは closeDate というプロパティの値が <value> と一致する結果のみ表示されます。これに対し、同じ <value> を使用して検索すると、<value> がコンテンツ フィールドの値内、一致するフィールドの値を持つすべての項目が返されます。演算子名に使用できるのは英小文字（a ～ z）のみです。最大 32 文字までです。
lessThanOperatorName

string

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

string

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

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

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

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> と一致する場合にのみ結果を表示します。これに対して演算子 <value> を使用しない検索では、アイテム内の String プロパティの値またはテキスト フィールドの値と一致する値がすべて返されます。演算子名に使用できるのは英小文字（a ～ z）のみです。最大 32 文字までです。

ObjectPropertyOptions

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

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

object (PropertyDefinition)

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

EnumPropertyOptions

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

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

object (EnumPropertyOptions.EnumValuePair)

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

enum (EnumPropertyOptions.OrderedRanking)

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

object (EnumPropertyOptions.EnumOperatorOptions)

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

EnumPropertyOptions.EnumValuePair

列挙値のペアは、必須の文字列値とオプションの整数値の 2 つを定義しています。文字列値では、優先アイテムを取得するのに必要な p0 など、そのアイテムを取得するために必要な検索キーワードを定義します。この整数値により、同じプロパティの他の列挙値に対する文字列値のランキングが決まります。たとえば、p0 と 0 を関連付けて、p1 や 1 などの別の列挙型ペアを定義できます。この整数値を 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 演算子を使用すると、検索対象のアイテムのタイプに関連する特定のフィールドにクエリを制限できます。たとえば、可能な値 p0 および p1 を持つ priority 列挙型プロパティに演算子を指定しない場合、p0 という用語を含むクエリは、priority プロパティの値として p0 を含むアイテムと、他のフィールドに文字列 p0 を含むアイテムを返します。列挙型の演算子名（priority など）を指定した場合、検索ユーザーはその演算子を使用して、このプロパティの値として p0 を持つアイテムのみに絞り込むことができます（クエリ: priority:p0）。

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

string

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

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

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

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

object (DatePropertyOptions.DateOperatorOptions)

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

DatePropertyOptions.DateOperatorOptions

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

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

string

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

string

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

string

「より大きい」演算子を使用して日付プロパティを分離するためにクエリに必要な演算子名を示します。たとえば、largeThanOperatorName が closeafter で、プロパティの名前が closeDate である場合、closedafter:<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

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

boolean

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

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

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

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

string

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