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 en igual que este valor. Por ejemplo, si nombre es Documento, las solicitudes de indexación para elementos del tipo Documento deben establecer objectType igual a Documento. 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 (de la A a la 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 las propiedades del 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

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

NOTA: “objecttype”, “type” y “mimetype” ya son compatibles. Esta propiedad se usa para configurar operadores específicos de esquema.

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

No se admiten operadores que se asignan a varias propiedades dentro del mismo objeto. Si el operador abarca diferentes tipos de objetos, esta opción se debe configurar 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 configura, 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 Indexing usará 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 predeterminado es 2 años a partir de la hora actual.

string (Duration format)

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

Es una duración en segundos con hasta nueve dígitos decimales que termina en "s". Ejemplo: "3.5s".

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

string

Es la etiqueta fácil de usar que se muestra en el resultado de la búsqueda para indicar el tipo de 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 la propiedad se muestran en el orden que se indica aquí. Si una propiedad tiene varios valores, todos estos se muestran antes de las siguientes propiedades. Por este motivo, se recomienda especificar propiedades únicas 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 de la metalínea. La cantidad máxima de propiedades es 5.

{
  "propertyName": string
}

string

El nombre de la propiedad de nivel superior como se define en una definición de propiedad del objeto. Si el nombre no es una propiedad definida en el esquema, se mostrará un error cuando se intente 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 enviadas a la API de Indexing deben establecer el property name en igual a este valor. Por ejemplo, si el nombre es subject_line, las solicitudes de indexación de elementos de documentos con campos de asunto deberían establecer que name para ese campo sea igual a subject_line. Usa el nombre como identificador para la propiedad del objeto. Una vez que se registra como una propiedad de un objeto, no puedes volver a usar este nombre para otra propiedad dentro de ese objeto. El nombre debe comenzar con una letra y solo puede contener letras (de la A a la 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 propiedades 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 consultas de búsqueda, lo que afecta el rendimiento de grandes conjuntos de datos. Se establece como true aquí solo si el campo es necesario para los resultados de la búsqueda. No puede ser verdadero para propiedades cuyo tipo es 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 puede ser verdadero para propiedades cuyo tipo es un 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. Esto no sucede con las propiedades repetibles. No puede ser verdadero para propiedades cuyo tipo es un objeto. El valor de IsReturnable debe ser verdadero para configurar esta opción. Solo se admite para 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 puede ser verdadero para propiedades cuyo tipo es un objeto. El valor de IsReturnable debe ser verdadero para configurar esta opción. Solo se admite para propiedades booleanas, de enumeración, de número entero y de texto.

boolean

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

boolean

Indica que los usuarios pueden realizar 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)

Las opciones que determinan cómo se muestra la propiedad en la página de resultados de Cloud Search si se especifica para 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 con el fin de especificar la clasificación ordenada para el número entero. Solo se puede usar si isRepeatable es falso.

string (Int64Value format)

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 clasifican con el mismo peso que los elementos indexados con el valor mínimo.

string (Int64Value format)

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 máximo se aceptan y 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 valor 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, si operadorName es prioridad y el nombre de la propiedad es priorVal, las consultas como prioridad:<valor> muestran resultados solo cuando el valor de la propiedad llamada prioridad coincide con <valor>. Por el contrario, una búsqueda que usa el mismo valor <valor> sin un operador muestra todos los elementos en los que <valor> coincide con el valor de cualquier elemento de cadena o texto dentro del campo de contenido para el campo de contenido. 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 menosThanOperatorName es carne debajo y el nombre de la propiedad es prioridadVal, las consultas como prioridad debajo:<valor> solo muestran resultados en los que el valor de la propiedad llamada prioridad es menor que <valor>. 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 del número entero con el operador mayor que. Por ejemplo, si mayorThanOperatorName es priorante y el nombre de la propiedad es priorVal, las consultas como prioridad sobre:<valor> muestran resultados solo donde el valor de la propiedad llamada prioridad es mayor que <valor>. 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 establece, describe cómo se debe usar la marca de tiempo como un 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, si operadorName es closedon y el nombre de la propiedad es closeDate, las consultas como closedon:<value> solo muestran resultados en los que el valor de la propiedad llamada closeDate coincide con <value>. Por el contrario, una búsqueda que usa el mismo <value> sin un operador muestra todos los elementos en los que <value> coincide con el valor de cualquier elemento de string o de texto dentro del campo de contenido. 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 marca de tiempo con el operador menor que. Por ejemplo, si lessThanOperatorName es closedbefore y el nombre de la propiedad es closeDate, las consultas como closedbefore:<value> solo muestran los resultados cuando el valor de la propiedad llamada closeDate es 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 marca de tiempo con el operador mayor que. Por ejemplo, si mayorThanOperatorName es closedafter y el nombre de la propiedad es closeDate, las consultas como closedafter:<value> solo muestran resultados 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 está establecido, 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, si operadorName 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 use el mismo <value> sin un operador mostrará todos los elementos en los que <value> coincida 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)

La lista de valores posibles para la propiedad de enumeración. Todos los EnumValuePairs deben proporcionar un valor de string. Si especificas un valor entero para un EnumValuePair, entonces todos los EnumValuePairs posibles deben proporcionar un número entero. Tanto el valor de string como el valor de número entero deben ser únicos para 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 enum adicionales en el futuro, deja espacios en los valores enteros iniciales para permitir agregar un valor entre los valores registrados anteriormente. 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 enteros proporcionados en los posibles EnumValuePairs para clasificar los resultados. Si se especifica, se deben proporcionar valores enteros para todos los valores EnumValuePair posibles de esta propiedad. Solo se puede usar si isRepeatable es falso.

object (EnumPropertyOptions.EnumOperatorOptions)

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

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

string

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

integer

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

{
  "operatorName": string
}

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de enumeración. Por ejemplo, si operadorName es prioridad y el nombre de la propiedad es priorVal, las consultas como prioridad:<valor> muestran resultados solo cuando el valor de la propiedad llamada prioridad coincide con <valor>. Por el contrario, una búsqueda que usa el mismo valor <valor> sin un operador muestra todos los elementos en los que <valor> coincide con el valor de cualquier elemento de cadena o texto dentro del campo de contenido para el campo de contenido. 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 un operador de búsqueda.

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

string

Indica la cadena real requerida en la consulta para aislar la propiedad de fecha. Por ejemplo, supongamos que un objeto de esquema de seguimiento de problemas tiene una propiedad llamada closeDate que especifica un operador con un operadorName de closedon. Para las búsquedas de esos datos, las consultas como closedon:<value> muestran solo resultados en los que el valor de la propiedad closeDate coincide con <value>. Por el contrario, una búsqueda que usa el mismo <value> sin un operador muestra todos los elementos en los que <value> 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 con el operador menor que. Por ejemplo, si lessThanOperatorName es closedbefore y el nombre de la propiedad es closeDate, las consultas como closedbefore:<value> solo muestran los resultados cuando el valor de la propiedad llamada closeDate es 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 fecha con el operador mayor que. Por ejemplo, si mayorThanOperatorName es closedafter y el nombre de la propiedad es closeDate, las consultas como closedafter:<value> solo muestran resultados 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 la recuperación.

object (TextPropertyOptions.TextOperatorOptions)

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

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

enum (RetrievalImportance.Importance)

Indica la importancia de clasificación que se le da a la propiedad cuando coincide durante la recuperación. Una vez establecida, la importancia del token de una propiedad no se puede cambiar.

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

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de texto. Por ejemplo, si operadorName es subject y el nombre de la propiedad es subjectLine, entonces las consultas como subject:<value> solo muestran resultados en los que el valor de la propiedad llamada subjectLine coincide con <value>. Por el contrario, una búsqueda que use el mismo <value> sin un operador mostrará todos los elementos en los que <value> coincida 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 “genre” y el valor es “science-fiction”, las restricciones de consulta “genre:science” y “genre:fiction” no coinciden con el elemento; “genre:science-fiction” sí. La coincidencia de valores de texto distingue mayúsculas de minúsculas y no quita los caracteres especiales. Si es falso, se asignan tokens al texto. Por ejemplo, si el valor es “science-fiction”, las consultas “genre:science” y “genre:fiction” coincidirán 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 la recuperación. Solo puede configurarse como PREDETERMINADO o NINGUNO.

object (HtmlPropertyOptions.HtmlOperatorOptions)

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

{
  "operatorName": string
}

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad HTML. Por ejemplo, si operadorName es subject y el nombre de la propiedad es subjectLine, entonces las consultas como subject:<value> solo muestran resultados en los que el valor de la propiedad llamada subjectLine coincide con <value>. Por el contrario, una búsqueda que use el mismo <value> sin un operador mostrará todos los elementos en los que <value> coincida 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

La etiqueta fácil de usar de la propiedad que se usa si se especifica la propiedad para que se muestre en ObjectDisplayOptions. Si se proporciona, la etiqueta de visualización se muestra delante de 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 en sí mismo no sea un contexto útil para el usuario. Si el nombre visible asignado era "prioridad", el usuario verá "prioridad : 1" en los resultados de la búsqueda, lo que proporciona un contexto claro para los usuarios que realizan búsquedas. Esto es OPCIONAL; si no se proporciona, solo se muestran los valores de la propiedad. La longitud máxima es de 64 caracteres.