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)

検索結果のメタラインに表示されるプロパティを定義します。プロパティ値は、ここで指定された順序で表示されます。プロパティに複数の値が含まれている場合は、次のプロパティの前にすべての値が表示されます。このため、このリスト内の繰り返しプロパティの前に単一のプロパティを指定することをおすすめします。すべてのプロパティで 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 にする必要があります。ブール値、日付、double、整数、タイムスタンプのプロパティでのみサポートされます。
isFacetable

boolean

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

boolean

プロパティをクエリ候補の生成に使用できるようにするかどうかを指定します。
isWildcardSearchable

boolean

ユーザーがこのプロパティのワイルドカード検索を実行できることを示します。Text プロパティでのみサポートされます。このオプションを設定するには、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> が任意の String プロパティの値またはアイテムのコンテンツ フィールド内のテキストと一致するすべてのアイテムが返されます。オペレーター名に使用できるのは、英小文字（a ～ z）のみです。最大 32 文字までです。
lessThanOperatorName

string

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

string

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

DoublePropertyOptions

倍精度浮動小数点数プロパティのオプション。

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

object (DoublePropertyOptions.DoubleOperatorOptions)

設定されている場合、検索演算子として浮動小数点数を使用する方法を指定します。

DoublePropertyOptions.DoubleOperatorOptions

浮動小数点数プロパティの検索演算子を提供するために使用されます。これは省略可能です。query.search 演算子を使用すると、検索対象のアイテムの種類に関連する特定のフィールドにクエリを制限できます。

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

string

並べ替えやファセットとして浮動小数点数プロパティを使用する場合に、クエリで必要な演算子名を示します。オペレーター名に使用できるのは、英小文字（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 が closedbefore で、プロパティの名前が closeDate の場合、closedbefore:<value> のようなクエリでは、closeDate という名前のプロパティの値が <value> より前の場合にのみ結果が表示されます。演算子名には小文字（a-z）のみを使用できます。最大 32 文字までです。
greaterThanOperatorName

string

大なり演算子を使用してタイムスタンプ プロパティを分離するために、クエリで必要な演算子名を示します。たとえば、greaterThanOperatorName が 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> が任意の文字列プロパティの値またはアイテムのコンテンツ フィールド内のテキストと一致するすべてのアイテムが返されます。オペレーター名に使用できるのは、英小文字（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 つの 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 の場合、値が 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> が任意の 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

大なり演算子を使用して日付プロパティを分離するために、クエリで必要な演算子名を示します。たとえば、greaterThanOperatorName が 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-fiction」の場合、クエリ制限「genre:science」と「genre:fiction」はアイテムと一致しませんが、「genre:science-fiction」は一致します。テキスト値の照合では大文字と小文字が区別され、特殊文字は削除されません。false の場合、テキストはトークン化されます。たとえば、値が「science-fiction」の場合、クエリ「genre:science」と「genre:fiction」はアイテムと一致します。

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

PropertyDisplayOptions

宿泊施設の表示オプション。

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

string

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