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 フィールドを設定する必要があります。たとえば、名前が 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)

検索結果のメタラインに表示されるプロパティを定義します。プロパティ値はここで指定された順序で表示されます。プロパティに複数の値がある場合は、すべての値が次のプロパティの前に表示されます。このため、このリストでは、繰り返しプロパティの前に単一プロパティを指定することをおすすめします。すべてのプロパティで 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 の場合、subject フィールドを持つドキュメント アイテムに対するインデックス登録リクエストでは、そのフィールドの 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 にする必要があります。boolean、date、double、integer、timestamp のプロパティでのみサポートされます。
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)
  },
  "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> が content フィールド内の String プロパティまたはテキストの値と一致するすべての項目が返されます。演算子名に使用できるのは小文字（a ～ z）のみです。最大 32 文字までです。
lessThanOperatorName

string

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

string

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

DoublePropertyOptions

倍精度プロパティのオプション。

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

object (DoublePropertyOptions.DoubleOperatorOptions)

設定されている場合は、倍精度文字を検索演算子として使用する方法を記述します。

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> が、content フィールド内の文字列プロパティまたはテキストの値と一致する項目がすべて返されます。演算子名に使用できるのは小文字（a ～ z）のみです。最大 32 文字までです。
lessThanOperatorName

string

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

string

大なり演算子を使用してタイムスタンプ プロパティを分離するために、クエリに必要な演算子名を示します。たとえば、より大きい ThanOperatorName が 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> に一致する場合のみ結果を表示します。一方、同じ <value> を演算子なしで検索すると、<value> が content フィールド内の 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)

列挙プロパティの有効な値のリスト。すべての EnumValuePair は文字列値を指定する必要があります。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 と組み合わせて使用し、同じプロパティ名の他の列挙値に対する特定の値のランキングを設定する必要があります。ここでは、priority プロパティのランキング順が 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 を含むクエリは priority プロパティの値として p0 を持つアイテムと、他のフィールドに文字列 p0 を含むアイテムを返します。列挙型の演算子名（priority など）を指定した場合、検索ユーザーはその演算子を使用して、priority:p0 というクエリで、このプロパティの値として p0 を持つアイテムのみに検索結果を絞り込むことができます。

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

string

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

string

大なり演算子を使用して日付プロパティを分離するために、クエリで必要な演算子名を示します。たとえば、より大きい ThanOperatorName が 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> に一致する場合のみ結果を表示します。これとは対照的に、同じ <value> を演算子なしで使用する検索では、<value> が項目のテキスト プロパティまたはテキストの値と一致するすべての項目が返されます。演算子名に使用できるのは小文字（a ～ z）のみです。最大 32 文字までです。
exactMatchWithOperator

boolean

true の場合、演算子検索とファセット照合では、テキスト値が 1 つのアトミック値としてトークン化されます。たとえば、演算子名が「genre」で、値が「science-finance」の場合、クエリ制限「genre:science」と「genre:finance」はアイテムに一致しません。「genre:science-finance」は一致します。テキスト値の一致では大文字と小文字が区別され、特殊文字は削除されません。false の場合、テキストはトークン化されます。たとえば、値が「science-finance」の場合、「genre:science」と「genre:finance」というクエリはアイテムに一致します。

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> がアイテムの content フィールド内の html プロパティまたはテキストの値と一致するすべての項目が返されます。演算子名に使用できるのは小文字（a ～ z）のみです。最大 32 文字までです。

PropertyDisplayOptions

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

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

string

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