Schema

{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}

string

El nombre del objeto, que luego define su tipo. Las solicitudes de indexación de elementos deben establecer el campo objectType igual a este valor. Por ejemplo, si name es Document, las solicitudes de indexación para elementos del tipo Document deben establecer objectType como Document. Cada definición de objeto debe tener un nombre único dentro de un esquema. El nombre debe comenzar con una letra y solo puede contener letras (A-Z, a-z) o números (0-9). La longitud máxima es de 256 caracteres.

object (ObjectOptions)

Las opciones opcionales específicas del objeto.

object (PropertyDefinition)

Las definiciones de propiedad para el objeto. La cantidad máxima de elementos es 1,000.

{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}

object (ObjectOptions.FreshnessOptions)

Las opciones de actualización de un objeto.

object (ObjectDisplayOptions)

Las opciones que determinan cómo se muestra el objeto en la página de resultados de Cloud Search.

string

Son operadores que se pueden usar para filtrar sugerencias. Para la API de query.suggest, solo los operadores mencionados aquí se respetarán en el FilterOptions. Solo se admiten los operadores TEXT y ENUM.

NOTA: “tipo de objeto”, “tipo” y "tipo de MIME" ya son compatibles. Esta propiedad sirve para configurar operadores específicos de esquema.

Aunque se trate de un array, solo se puede especificar un operador. Este es un array para extensibilidad futura.

No se admiten los operadores que se asignan a varias propiedades dentro del mismo objeto. Si el operador abarca diferentes tipos de objetos, esta opción se debe establecer una vez para cada definición de objeto.

{
  "freshnessProperty": string,
  "freshnessDuration": string
}

string

Esta propiedad indica el nivel de actualidad del objeto en el índice. Si se establece, esta propiedad debe ser de nivel superior dentro de property definitions y debe ser timestamp type o date type. De lo contrario, la API de indexación usa updateTime como indicador de actualización. La longitud máxima es de 256 caracteres.

Cuando se usa una propiedad para calcular la actualidad, el valor se establece de forma predeterminada en 2 años a partir de la hora actual.

string (Duration format)

El tiempo después del cual un objeto debe considerarse inactivo. El valor predeterminado es 180 días (en segundos).

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".

{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}

string

Es la etiqueta fácil de usar que se mostrará en el resultado de la búsqueda para indicar el tipo del elemento. Esto es OPCIONAL; Si no se proporciona, no se muestra una etiqueta de objeto en la línea de contexto de los resultados de la búsqueda. La longitud máxima es de 64 caracteres.

object (ObjectDisplayOptions.Metaline)

Define las propiedades que se muestran en las metalíneas de los resultados de la búsqueda. Los valores de las propiedades se muestran en el orden indicado aquí. Si una propiedad tiene varios valores, todos estos se muestran antes de las siguientes propiedades. Por este motivo, es una buena práctica especificar propiedades singulares antes de las propiedades repetidas en esta lista. Todas las propiedades deben establecer isReturnable como verdadero. La cantidad máxima de metalíneas es 3.

{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}

object (ObjectDisplayOptions.DisplayedProperty)

Es la lista de propiedades que se muestran para la metalínea. La cantidad máxima de propiedades es 5.

{
  "propertyName": string
}

string

Es el nombre de la propiedad de nivel superior, como se define en una definición de propiedad para el objeto. Si el nombre no es una propiedad definida en el esquema, se genera un error cuando se intenta actualizar el esquema.

{
  "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.
}

string

Es el nombre de la propiedad. Las solicitudes de indexación de elementos que se envían a la API de indexación deben establecer el property name igual a este valor. Por ejemplo, si el nombre es subject_line, las solicitudes de indexación para elementos de documentos con campos de asunto deben establecer que name para ese campo sea igual a subject_line. Usa el nombre como identificador de la propiedad del objeto. Una vez registrado como propiedad de un objeto, no puedes volver a usar este nombre en otra propiedad dentro de ese objeto. El nombre debe comenzar con una letra y solo puede contener letras (A-Z, a-z) o números (0-9). La longitud máxima es de 256 caracteres.

boolean

Indica que la propiedad identifica datos que se deben mostrar en los resultados de la búsqueda a través de la API de consulta. Si se configura como true, indica que los usuarios de la API de consulta pueden usar campos de propiedad coincidentes en los resultados. Sin embargo, el almacenamiento de campos requiere más asignación de espacio y usa más ancho de banda para las búsquedas, lo que afecta el rendimiento en conjuntos de datos grandes. Se establece como true solo si el campo es necesario para los resultados de la búsqueda. No se puede usar con propiedades cuyo tipo sea un objeto.

boolean

Indica que se permiten múltiples valores para la propiedad. Por ejemplo, un documento solo tiene una descripción, pero puede tener varios comentarios. No es "true" para propiedades cuyo tipo es booleano. Si se configura como falsa, las propiedades que contienen más de un valor hacen que se rechace la solicitud de indexación de ese elemento.

boolean

Indica que la propiedad se puede usar para el ordenamiento. No se puede establecer en el caso de propiedades repetibles. No se puede usar con propiedades cuyo tipo sea objeto. El valor de IsReturnable debe ser verdadero para configurar esta opción. Solo es compatible con propiedades booleanas, de fecha, doble, de número entero y de marca de tiempo.

boolean

Indica que la propiedad se puede usar para generar facetas. No se puede usar con propiedades cuyo tipo sea objeto. El valor de IsReturnable debe ser verdadero para configurar esta opción. Solo es compatible con propiedades booleanas, de enumeración, de números enteros y de texto.

boolean

Indica que la propiedad se puede usar para generar sugerencias de consulta.

boolean

Indica que los usuarios pueden realizar una búsqueda con comodines para esta propiedad. Solo es compatible con propiedades de texto. El valor de IsReturnable debe ser verdadero para configurar esta opción. En una fuente de datos determinada, se puede marcar un máximo de 5 propiedades como isWildcardSearchable. Para obtener más detalles, consulta Define las propiedades de los objetos.

object (PropertyDisplayOptions)

Son las opciones que determinan cómo se muestra la propiedad en la página de resultados de Cloud Search si se especifica que se muestre en el display options del objeto.

object (IntegerPropertyOptions)

object (DoublePropertyOptions)

object (TimestampPropertyOptions)

object (BooleanPropertyOptions)

object (ObjectPropertyOptions)

object (EnumPropertyOptions)

object (DatePropertyOptions)

object (TextPropertyOptions)

object (HtmlPropertyOptions)

{
  "orderedRanking": enum (IntegerPropertyOptions.OrderedRanking),
  "minimumValue": string,
  "maximumValue": string,
  "operatorOptions": {
    object (IntegerPropertyOptions.IntegerOperatorOptions)
  },
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}

enum (IntegerPropertyOptions.OrderedRanking)

Se usa para especificar la clasificación ordenada del número entero. Solo se puede usar si isRepeatable es falso.

string (Int64Value format)

Es el valor mínimo de la propiedad. Los valores mínimo y máximo de la propiedad se usan para clasificar los resultados de acuerdo con el ordered ranking. Las solicitudes de indexación con valores inferiores al mínimo se aceptan y se clasifican con el mismo peso que los elementos indexados con el valor mínimo.

string (Int64Value format)

Es el valor máximo de la propiedad. Los valores mínimo y máximo de la propiedad se usan para clasificar los resultados de acuerdo con el ordered ranking. Las solicitudes de indexación con valores superiores al valor máximo se aceptan y se clasifican con el mismo peso que los elementos indexados con el valor máximo.

object (IntegerPropertyOptions.IntegerOperatorOptions)

Si se establece, describe cómo se debe usar el número entero como operador de búsqueda.

object (IntegerFacetingOptions)

Si se establece, describe las opciones de faceta de números enteros para la propiedad de número entero determinada. La propiedad de número entero correspondiente debe estar marcada como isFacetable.

{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de número entero. Por ejemplo, sioperatorName es priority y el nombre de la propiedad es priorityVal, las consultas como priority:<value> muestran resultados solo en los que el valor de la propiedad llamada priorityVal coincide con <value>. Por el contrario, una búsqueda que usa el mismo &lt;value&gt; sin un operador muestra todos los elementos en los que &lt;value&gt; coincide con el valor de cualquier propiedad de string o texto dentro del campo de contenido del elemento. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de número entero con el operador menor que. Por ejemplo, si lessThanOperatorName es prioritybajo y el nombre de la propiedad es priorityVal, entonces las consultas como priority Console:<value> mostrarán resultados solo en los que el valor de la propiedad llamada priorityVal sea menor que <value>. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de número entero con el operador mayor que. Por ejemplo, si mayorThanOperatorName es priorityVal y el nombre de la propiedad es priorityVal, entonces las consultas como priorityoverride:<value> solo mostrarán resultados en los que el valor de la propiedad llamada priorityVal sea mayor que <value>. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}

object (DoublePropertyOptions.DoubleOperatorOptions)

Si se establece, describe cómo se debe usar el doble como operador de búsqueda.

{
  "operatorName": string
}

string

Indica el nombre del operador requerido en la consulta para usar la propiedad doble en el ordenamiento o como una faceta. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}

object (TimestampPropertyOptions.TimestampOperatorOptions)

Si se configura, describe cómo se debe usar la marca de tiempo como operador de búsqueda.

{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de marca de tiempo. Por ejemplo, sioperatorName es closedon y el nombre de la propiedad es closeDate, las consultas como closedon:<value> muestran resultados solo en los que el valor de la propiedad llamada closeDate coincide con <value>. Por el contrario, una búsqueda que usa el mismo &lt;value&gt; sin un operador muestra todos los elementos en los que &lt;value&gt; coincide con el valor de cualquier propiedad de string o texto dentro del campo de contenido del elemento. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de la marca de tiempo con el operador menor que. Por ejemplo, si lessThanOperatorName es closedbefore y el nombre de la propiedad es closeDate, entonces las consultas como closedbefore:<value> mostrarán resultados solo en los que el valor de la propiedad llamada closeDate sea anterior a <value>. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de la marca de tiempo con el operador mayor que. Por ejemplo, si largeThanOperatorName es closedafter y el nombre de la propiedad es closeDate, entonces las consultas como closedafter:<value> muestran resultados solo en los que el valor de la propiedad llamada closeDate es posterior a <value>. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}

object (BooleanPropertyOptions.BooleanOperatorOptions)

Si se establece, describe cómo se debe usar el valor booleano como operador de búsqueda.

{
  "operatorName": string
}

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad booleana. Por ejemplo, siOperatorName es closed y el nombre de la propiedad es isClosed, las consultas como closed:<value> solo mostrarán resultados en los que el valor de la propiedad llamada isClosed coincida con <value>. Por el contrario, una búsqueda que usa el mismo &lt;value&gt; sin un operador muestra todos los elementos en los que &lt;value&gt; coincide con el valor de cualquier propiedad de string o texto dentro del campo de contenido del elemento. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}

object (PropertyDefinition)

Las propiedades del subobjeto. Estas propiedades representan un objeto anidado. Por ejemplo, si esta propiedad representa una dirección postal, las subobjectProperties podrían llamarse street, city y state. La cantidad máxima de elementos es 1,000.

{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}

object (EnumPropertyOptions.EnumValuePair)

Es la lista de valores posibles para la propiedad de enumeración. Todos los EnumValuePairs deben proporcionar un valor de cadena. Si especificas un valor de número entero para un EnumValuePair, todos los EnumValuePairs posibles deben proporcionar un valor de número entero. Tanto el valor de cadena como el de número entero deben ser únicos entre todos los valores posibles. Una vez establecidos, los valores posibles no se pueden quitar ni modificar. Si proporcionas una clasificación ordenada y crees que podrías insertar valores de enumeración adicionales en el futuro, deja espacios vacíos en los valores enteros iniciales para permitir agregar un valor entre los valores registrados previamente. La cantidad máxima de elementos es 100.

enum (EnumPropertyOptions.OrderedRanking)

Se usa para especificar la clasificación ordenada de la enumeración que determina cómo se usan los valores de número entero proporcionados en los posibles EnumValuePairs para clasificar los resultados. Si se especifica, se deben proporcionar números enteros para todos los valores EnumValuePair posibles que se proporcionaron en esta propiedad. Solo se puede usar si isRepeatable es falso.

object (EnumPropertyOptions.EnumOperatorOptions)

Si se establece, describe cómo se debe usar la enumeración como operador de búsqueda.

{
  "stringValue": string,
  "integerValue": integer
}

string

El valor de string del EnumValuePair. La longitud máxima es de 32 caracteres.

integer

El valor entero de EnumValuePair que no debe ser negativo. Opcional.

{
  "operatorName": string
}

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad enum. Por ejemplo, sioperatorName es priority y el nombre de la propiedad es priorityVal, las consultas como priority:<value> muestran resultados solo en los que el valor de la propiedad llamada priorityVal coincide con <value>. Por el contrario, una búsqueda que usa el mismo &lt;value&gt; sin un operador muestra todos los elementos en los que &lt;value&gt; coincide con el valor de cualquier propiedad de string o texto dentro del campo de contenido del elemento. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}

object (DatePropertyOptions.DateOperatorOptions)

Si se establece, describe cómo se debe usar la fecha como operador de búsqueda.

{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}

string

Indica la cadena real que se requiere en la consulta para aislar la propiedad de fecha. Por ejemplo, imagina que un objeto de esquema de seguimiento de problemas tiene una propiedad llamada closeDate que especifica un operador con unOperatorName de closedon. En las búsquedas de esos datos, las consultas como closedon:&lt;value&gt; muestran resultados solo en los que el valor de la propiedad closedon:&lt;value&gt; coincide con closedon:&lt;value&gt;. Por el contrario, una búsqueda que usa el mismo &lt;value&gt; sin un operador muestra todos los elementos en los que &lt;value&gt; coincide con el valor de cualquier propiedad de string o texto dentro del campo de contenido de la fuente de datos indexada. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de fecha mediante el operador menor que. Por ejemplo, si lessThanOperatorName es closedbefore y el nombre de la propiedad es closeDate, entonces las consultas como closedbefore:<value> mostrarán resultados solo en los que el valor de la propiedad llamada closeDate sea anterior a <value>. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de fecha mediante el operador mayor que. Por ejemplo, si largeThanOperatorName es closedafter y el nombre de la propiedad es closeDate, entonces las consultas como closedafter:<value> muestran resultados solo en los que el valor de la propiedad llamada closeDate es posterior a <value>. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}

object (RetrievalImportance)

Indica la importancia de la calidad de búsqueda de los tokens dentro del campo cuando se usan para recuperación.

object (TextPropertyOptions.TextOperatorOptions)

Si se establece, describe cómo se debe usar la propiedad como operador de búsqueda.

{
  "importance": enum (RetrievalImportance.Importance)
}

enum (RetrievalImportance.Importance)

Indica la importancia de clasificación otorgada a la propiedad cuando se detecta una coincidencia durante la recuperación. Una vez que se establece, no se puede cambiar la importancia del token de una propiedad.

{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de texto. Por ejemplo, siOperatorName es subject y el nombre de la propiedad es subjectLine, las consultas como subject:<value> muestran resultados solo donde el valor de la propiedad llamada subjectLine coincide con <value>. Por el contrario, una búsqueda que usa el mismo &lt;value&gt; sin un operador muestra todos los elementos en los que &lt;value&gt; coincide con el valor de cualquier propiedad de texto o texto dentro del campo de contenido del elemento. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

boolean

Si es verdadero, se asigna un token al valor de texto como un valor atómico en las búsquedas de operadores y las coincidencias de facetas. Por ejemplo, si el nombre del operador es "género" y el valor es "ciencia ficción" las restricciones de consulta “genre:science” y "genre:fiction" no coincide con el elemento; "género:ciencia-ficción" hace. La coincidencia de valores de texto distingue mayúsculas de minúsculas y no quita los caracteres especiales. Si es falso, se asigna un token al texto. Por ejemplo, si el valor es "ciencia ficción" las consultas "genre:science" y "genre:fiction" coincide con el elemento.

{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}

object (RetrievalImportance)

Indica la importancia de la calidad de búsqueda de los tokens dentro del campo cuando se usan para recuperación. Solo se puede establecer en DEFAULT o NONE.

object (HtmlPropertyOptions.HtmlOperatorOptions)

Si se establece, describe cómo se debe usar la propiedad como operador de búsqueda.

{
  "operatorName": string
}

string

Indica el nombre de operador requerido en la consulta para aislar la propiedad HTML. Por ejemplo, siOperatorName es subject y el nombre de la propiedad es subjectLine, las consultas como subject:<value> muestran resultados solo donde el valor de la propiedad llamada subjectLine coincide con <value>. Por el contrario, una búsqueda que usa el mismo &lt;value&gt; sin operador muestra todos los elementos en los que &lt;value&gt; coincide con el valor de cualquier propiedad HTML o texto dentro del campo de contenido del elemento. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

{
  "displayLabel": string
}

string

Es la etiqueta fácil de usar de la propiedad que se usa si se especifica que la propiedad se muestre en ObjectDisplayOptions. Si se proporciona, la etiqueta de visualización se muestra frente a los valores de la propiedad cuando esta forma parte de las opciones de visualización del objeto. Por ejemplo, si el valor de la propiedad es "1", es posible que el valor por sí mismo no sea un contexto útil para el usuario. Si el nombre visible proporcionado era "priority", el usuario verá "priority : 1". en los resultados de la búsqueda, lo que proporciona un contexto claro a los usuarios de la búsqueda. Esto es OPCIONAL; Si no se proporciona, solo se muestran los valores de la propiedad. La longitud máxima es de 64 caracteres.