Schema

Définition du schéma d'une source de données.

Représentation JSON 
{
  "objectDefinitions": [
    {
      object (ObjectDefinition)
    }
  ],
  "operationIds": [
    string
  ]
}
Champs
objectDefinitions[]

object (ObjectDefinition)

Liste des objets de premier niveau pour la source de données. Le nombre maximal d'éléments est de 10.
operationIds[]

string

ID des opérations de longue durée (LRO) en cours d'exécution pour ce schéma. Après avoir modifié le schéma, attendez la fin des opérations avant d'indexer du contenu supplémentaire.

ObjectDefinition

Définition d'un objet dans une source de données.

Représentation JSON 
{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}
Champs
name

string

Nom de l'objet, qui définit ensuite son type. Les demandes d'indexation d'éléments doivent définir le champ objectType sur cette valeur. Par exemple, si la valeur name est Document, les requêtes d'indexation des éléments de type "Document" doivent définir objectType sur Document. Chaque définition d'objet doit être nommée de manière unique dans un schéma. Le nom doit commencer par une lettre et ne peut contenir que des lettres (A-Z, a-z) ou des chiffres (0-9). La longueur maximale est de 256 caractères.
options

object (ObjectOptions)

Options facultatives spécifiques à l'objet.
propertyDefinitions[]

object (PropertyDefinition)

Définitions des propriétés de l'objet. Le nombre maximal d'éléments est de 1 000.

ObjectOptions

Options d'un objet.

Représentation JSON 
{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}
Champs
freshnessOptions

object (ObjectOptions.FreshnessOptions)

Options d'actualisation d'un objet.
displayOptions

object (ObjectDisplayOptions)

Options qui déterminent la manière dont l'objet s'affiche sur la page des résultats de Cloud Search.
suggestionFilteringOperators[]

string

Opérateurs pouvant être utilisés pour filtrer les suggestions. Pour l'API query.suggest, seuls les opérateurs mentionnés ici sont appliqués dans FilterOptions. Seuls les opérateurs TEXT et ENUM sont acceptés.

REMARQUE : "objecttype", "type" et "type MIME" sont déjà prises en charge. Cette propriété permet de configurer des opérateurs spécifiques au schéma.

Même s'il s'agit d'un tableau, un seul opérateur peut être spécifié. Il s'agit d'un tableau pour une extensibilité future.

Les opérateurs mappés à plusieurs propriétés au sein d'un même objet ne sont pas acceptés. Si l'opérateur couvre différents types d'objets, cette option doit être définie une fois pour chaque définition d'objet.

ObjectOptions.FreshnessOptions

Indique la propriété d'actualisation à utiliser pour ajuster le classement dans les résultats de recherche d'un élément. Plus la date est récente, plus la date est récente, meilleure est la qualité. Utilisez la propriété d'option d'actualisation qui fonctionne le mieux avec vos données. Pour les documents de partage de fichiers, l'heure de la dernière modification est la plus pertinente. Pour les données d'événement d'agenda, l'heure à laquelle l'événement se produit est un indicateur d'actualisation plus pertinent. Ainsi, les événements d'agenda les plus proches de l'heure de la requête de recherche sont considérés comme étant de meilleure qualité et classés en conséquence.

Représentation JSON 
{
  "freshnessProperty": string,
  "freshnessDuration": string
}
Champs
freshnessProperty

string

Cette propriété indique le niveau d'actualisation de l'objet dans l'index. Si cette propriété est définie, elle doit être une propriété de premier niveau dans property definitions, et doit être timestamp type ou date type. Sinon, l'API d'indexation utilise updateTime comme indicateur d'actualisation. La longueur maximale est de 256 caractères.

Lorsqu'une propriété est utilisée pour calculer l'actualisation, la valeur par défaut est de deux ans à compter de l'heure actuelle.
freshnessDuration

string (Duration format)

Délai au terme duquel un objet doit être considéré comme non actualisé. La valeur par défaut est de 180 jours (en secondes).

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

ObjectDisplayOptions

Options d'affichage d'un objet.

Représentation JSON 
{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}
Champs
objectDisplayLabel

string

Libellé convivial à afficher dans les résultats de recherche pour indiquer le type d'élément. Cette étape est FACULTATIVE. S'il n'est pas fourni, aucun libellé d'objet n'est affiché sur la ligne de contexte des résultats de recherche. La longueur maximale est de 64 caractères.
metalines[]

object (ObjectDisplayOptions.Metaline)

Définit les propriétés affichées dans les métalignes des résultats de recherche. Les valeurs des propriétés sont affichées dans l'ordre indiqué ici. Si une propriété contient plusieurs valeurs, toutes les valeurs sont affichées avant les propriétés suivantes. C'est pourquoi il est recommandé de spécifier des propriétés uniques avant les propriétés répétées de cette liste. Toutes les propriétés doivent définir isReturnable sur "true". Le nombre maximal de métalignes est de 3.

ObjectDisplayOptions.Metaline

Une métaligne est une liste de propriétés qui s'affiche avec le résultat de recherche pour fournir du contexte.

Représentation JSON 
{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}
Champs
properties[]

object (ObjectDisplayOptions.DisplayedProperty)

Liste des propriétés affichées pour la métaligne. Le nombre maximal d'établissements est de 5.

ObjectDisplayOptions.DisplayedProperty

Référence à une propriété de niveau supérieur au sein de l'objet à afficher dans les résultats de recherche. Les valeurs des établissements sélectionnés s'affichent dans les résultats de recherche avec le display label de cet établissement, le cas échéant. Si aucun libellé d'affichage n'est spécifié, seules les valeurs sont affichées.

Représentation JSON 
{
  "propertyName": string
}
Champs
propertyName

string

Nom de la propriété de premier niveau, telle que définie dans la définition de la propriété de l'objet. Si le nom n'est pas une propriété définie dans le schéma, une erreur s'affiche lors de la tentative de mise à jour du schéma.

PropertyDefinition

Définition d'une propriété dans un objet.

Représentation 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.
}
Champs
name

string

Nom de la propriété. Les requêtes d'indexation d'éléments envoyées à l'API d'indexation doivent définir property name sur cette valeur. Par exemple, si le nom est subject_line, alors les demandes d'indexation d'éléments de document avec des champs d'objet doivent définir la valeur name de ce champ sur subject_line. Utilisez le nom comme identifiant de la propriété d'objet. Une fois enregistré en tant que propriété d'un objet, vous ne pouvez pas réutiliser ce nom pour une autre propriété de cet objet. Le nom doit commencer par une lettre et ne peut contenir que des lettres (A-Z, a-z) ou des chiffres (0-9). La longueur maximale est de 256 caractères.
isReturnable

boolean

Indique que la propriété identifie les données à renvoyer dans les résultats de recherche via l'API Query. Si la valeur est true, indique que les utilisateurs de l'API Query peuvent utiliser les champs de propriété correspondants dans les résultats. Toutefois, le stockage des champs nécessite davantage d'espace et de bande passante pour les requêtes de recherche, ce qui affecte les performances sur les ensembles de données volumineux. Définissez ce paramètre sur true ici uniquement si le champ est nécessaire pour les résultats de recherche. La valeur ne peut pas être "true" pour les propriétés dont le type est un objet.
isRepeatable

boolean

Indique que plusieurs valeurs sont autorisées pour la propriété. Par exemple, un document ne comporte qu'une seule description, mais peut avoir plusieurs commentaires. La valeur ne peut pas être "true" pour les propriétés dont le type est une valeur booléenne. Si elle est définie sur "false", les propriétés qui contiennent plusieurs valeurs entraînent le rejet de la requête d'indexation de cet élément.
isSortable

boolean

Indique que la propriété peut être utilisée pour le tri. La valeur ne peut pas être "true" pour les propriétés reproductibles. La valeur ne peut pas être "true" pour les propriétés dont le type est "object". Pour définir cette option, IsReturnable doit être défini sur "true". Compatible uniquement avec les propriétés de type booléen, date, double, entier et horodatage.
isFacetable

boolean

Indique que la propriété peut être utilisée pour générer des attributs. La valeur ne peut pas être "true" pour les propriétés dont le type est "object". Pour définir cette option, IsReturnable doit être défini sur "true". Compatible uniquement avec les propriétés booléennes, énumération, entiers et texte.
isSuggestable

boolean

Indique que la propriété peut être utilisée pour générer des suggestions de requête.
isWildcardSearchable

boolean

Indique que les utilisateurs peuvent effectuer une recherche avec caractères génériques pour cette propriété. Uniquement disponible pour les propriétés Text. Pour définir cette option, IsReturnable doit être défini sur "true". Dans une source de données donnée, cinq propriétés au maximum peuvent être marquées comme isWildcardSearchable. Pour en savoir plus, consultez Définir les propriétés d'un objet.
displayOptions

object (PropertyDisplayOptions)

Options qui déterminent la manière dont la propriété s'affiche sur la page des résultats de Cloud Search si elle est spécifiée pour être affichée dans le display options de l'objet.
Champ d'union property_options. Les options spécifiques au type qui déterminent la manière dont la propriété est indexée et utilisée. Si les options devraient être les options par défaut d'un type, ce champ doit quand même être défini sur l'un des types. Si ce champ n'est pas défini, les mises à jour du schéma sont refusées. property_options ne peut être qu'un des éléments suivants :
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

Options des propriétés des nombres entiers.

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

enum (IntegerPropertyOptions.OrderedRanking)

Permet de spécifier le classement ordonné pour l'entier. Ne peut être utilisé que si la valeur de isRepeatable est "false".
minimumValue

string (Int64Value format)

Valeur minimale de la propriété. Les valeurs minimale et maximale de la propriété permettent de classer les résultats en fonction de ordered ranking. Les demandes d'indexation dont la valeur est inférieure à la valeur minimale sont acceptées et classées avec la même pondération que les éléments indexés avec la valeur minimale.
maximumValue

string (Int64Value format)

Valeur maximale de la propriété. Les valeurs minimale et maximale de la propriété permettent de classer les résultats en fonction de ordered ranking. Les demandes d'indexation dont la valeur est supérieure à la valeur maximale sont acceptées et classées avec la même pondération que les éléments indexés avec la valeur maximale.
operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

S'il est défini, décrit comment l'entier doit être utilisé comme opérateur de recherche.
integerFacetingOptions

object (IntegerFacetingOptions)

Si cet attribut est défini, il décrit les options d'attributs d'entiers pour la propriété d'entier donnée. La propriété d'entier correspondante doit être marquée comme isFacetable.

IntegerPropertyOptions.OrderedRanking

Permet de spécifier le mode de classement d'une valeur entière par rapport aux autres valeurs. Un nombre entier avec un classement plus élevé suggère une importance plus importante. Par exemple, dans certaines sources de données, une priorité inférieure indique une importance plus élevée, tandis que dans d'autres, une priorité plus élevée indique une importance plus élevée.

Enums
NO_ORDER Il n'y a pas d'ordre de classement pour la propriété. Les résultats ne sont pas ajustés en fonction de la valeur de cette propriété.
ASCENDING Cette propriété est classée par ordre croissant. Plus la valeur est faible, plus le classement est faible.
DESCENDING Cette propriété est classée par ordre décroissant. Plus la valeur est faible, plus le classement est élevé.

IntegerPropertyOptions.IntegerOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés des nombres entiers. Cette étape est facultative. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques en rapport avec le type d'élément recherché.

Représentation JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Champs
operatorName

string

Indique le nom d'opérateur requis dans la requête afin d'isoler la propriété d'entier. Par exemple, si "operatorName" est Priority et que le nom de la propriété est primaryVal, les requêtes telles que Priority:<value> affichent uniquement les résultats dans lesquels la valeur de la propriété nommée primaryVal correspond à <value>. En revanche, une recherche qui utilise le même &lt;value&gt; sans opérateur renvoie tous les éléments dans lesquels &lt;value&gt; correspond à la valeur de n'importe quelle propriété de chaîne ou de tout texte dans le champ de contenu de l'élément. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.
lessThanOperatorName

string

Indique le nom d'opérateur requis dans la requête afin d'isoler la propriété d'entier à l'aide de l'opérateur "inférieur à". Par exemple, si lessThanOperatorName est Prioritybelow et que le nom de la propriété est PriorityVal, les requêtes telles que Prioritybelow:<value> affichent uniquement les résultats dans lesquels la valeur de la propriété nommée PriorityVal est inférieure à <value>. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.
greaterThanOperatorName

string

Indique le nom de l'opérateur requis dans la requête afin d'isoler la propriété du nombre entier à l'aide de l'opérateur "supérieur à". Par exemple, si "greatThanOperatorName" est Priorityabove et que le nom de la propriété est PriorityVal, les requêtes telles que Priorityabove:<value> affichent uniquement les résultats dans lesquels la valeur de la propriété nommée primaryVal est supérieure à <value>. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

DoublePropertyOptions

Options pour les propriétés doubles.

Représentation JSON 
{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}
Champs
operatorOptions

object (DoublePropertyOptions.DoubleOperatorOptions)

S'il est défini, décrit comment utiliser le double en tant qu'opérateur de recherche.

DoublePropertyOptions.DoubleOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés doubles. Cette étape est facultative. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques en rapport avec le type d'élément recherché.

Représentation JSON 
{
  "operatorName": string
}
Champs
operatorName

string

Indique le nom de l'opérateur requis dans la requête pour utiliser la propriété double lors du tri ou en tant qu'attribut. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

TimestampPropertyOptions

Options des propriétés de code temporel.

Représentation JSON 
{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}
Champs
operatorOptions

object (TimestampPropertyOptions.TimestampOperatorOptions)

Si cet attribut est défini, décrit comment utiliser le code temporel en tant qu'opérateur de recherche.

TimestampPropertyOptions.TimestampOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés d'horodatage. Cette étape est facultative. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques en rapport avec le type d'élément recherché.

Représentation JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Champs
operatorName

string

Indique le nom de l'opérateur requis dans la requête afin d'isoler la propriété d'horodatage. Par exemple, si "operatorName" est closedon et que le nom de la propriété est closeDate, les requêtes telles que closedon:<value> affichent uniquement les résultats dans lesquels la valeur de la propriété closeDate correspond à <value>. En revanche, une recherche qui utilise le même &lt;value&gt; sans opérateur renvoie tous les éléments dans lesquels &lt;value&gt; correspond à la valeur de n'importe quelle propriété de chaîne ou de tout texte dans le champ de contenu de l'élément. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.
lessThanOperatorName

string

Indique le nom d'opérateur requis dans la requête afin d'isoler la propriété d'horodatage à l'aide de l'opérateur "inférieur à". Par exemple, si lessThanOperatorName a la valeur closedbefore et que le nom de la propriété est closeDate, les requêtes telles que closedbefore:<value> affichent uniquement les résultats dans lesquels la valeur de la propriété closeDate est antérieure à <value>. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.
greaterThanOperatorName

string

Indique le nom de l'opérateur requis dans la requête afin d'isoler la propriété d'horodatage à l'aide de l'opérateur "supérieur à". Par exemple, si "greatThanOperatorName" est closedafter et que le nom de la propriété est closeDate, les requêtes telles que closedafter:<value> affichent uniquement les résultats dans lesquels la valeur de la propriété closeDate est postérieure à <value>. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

BooleanPropertyOptions

Options pour les propriétés booléennes.

Représentation JSON 
{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}
Champs
operatorOptions

object (BooleanPropertyOptions.BooleanOperatorOptions)

Si cet indicateur est défini, il décrit comment utiliser la valeur booléenne en tant qu'opérateur de recherche.

BooleanPropertyOptions.BooleanOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés booléennes. Cette étape est facultative. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques en rapport avec le type d'élément recherché.

Représentation JSON 
{
  "operatorName": string
}
Champs
operatorName

string

Indique le nom d'opérateur requis dans la requête afin d'isoler la propriété booléenne. Par exemple, si "operatorName" est closed (fermé) et que le nom de l'établissement est isClosed (par exemple), les requêtes telles que closed:<value> n'affichent des résultats que si la valeur de la propriété nommée isClosed correspond à <value>. En revanche, une recherche qui utilise le même &lt;value&gt; sans opérateur renvoie tous les éléments dans lesquels &lt;value&gt; correspond à la valeur de n'importe quelle propriété de chaîne ou de tout texte dans le champ de contenu de l'élément. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

ObjectPropertyOptions

Options des propriétés de l'objet.

Représentation JSON 
{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}
Champs
subobjectProperties[]

object (PropertyDefinition)

Propriétés du sous-objet. Ces propriétés représentent un objet imbriqué. Par exemple, si cette propriété représente une adresse postale, les subobjectProperties peuvent être nommées street, city et state. Le nombre maximal d'éléments est de 1 000.

EnumPropertyOptions

Options pour les propriétés d'énumération Par exemple, pour les éléments d'un système de suivi des demandes avec des informations de priorité, vous pouvez définir p0 comme valeur d'énumération autorisée et lier cette énumération au nom d'opérateur Priority afin que les utilisateurs de la recherche puissent ajouter Priority:p0 à leur requête pour limiter l'ensemble de résultats aux seuls éléments indexés avec la valeur p0.

Représentation JSON 
{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}
Champs
possibleValues[]

object (EnumPropertyOptions.EnumValuePair)

Liste des valeurs possibles pour la propriété d'énumération. Toutes les valeurs EnumValuePairs doivent fournir une valeur de chaîne. Si vous spécifiez une valeur entière pour une EnumValuePair, toutes les EnumValuePairs possibles doivent fournir une valeur entière. La valeur de chaîne et la valeur entière doivent être uniques parmi toutes les valeurs possibles. Une fois définies, les valeurs possibles ne peuvent pas être supprimées ni modifiées. Si vous fournissez un classement ordonné et que vous pensez pouvoir insérer des valeurs enum supplémentaires à l'avenir, laissez des espaces dans les valeurs entières initiales pour permettre l'ajout d'une valeur entre les valeurs enregistrées précédemment. Le nombre maximal d'éléments est de 100.
orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

Permet de spécifier le classement ordonné pour l'énumération qui détermine la manière dont les valeurs entières fournies dans les possibles EnumValuePairs sont utilisées pour classer les résultats. Si elle est spécifiée, des valeurs entières doivent être fournies pour toutes les valeurs EnumValuePair possibles fournies pour cette propriété. Ne peut être utilisé que si la valeur de isRepeatable est "false".
operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

Si cet attribut est défini, il décrit comment utiliser l'énumération en tant qu'opérateur de recherche.

EnumPropertyOptions.EnumValuePair

La paire de valeurs d'énumération définit deux éléments: une valeur de chaîne obligatoire et une valeur entière facultative. La valeur de chaîne définit le terme de requête nécessaire pour récupérer cet élément (par exemple p0 pour un élément prioritaire). La valeur entière détermine le classement de cette valeur de chaîne par rapport aux autres valeurs énumérées pour la même propriété. Par exemple, vous pouvez associer p0 à 0 et définir une autre paire d'énumérations, telle que p1 et 1. Vous devez utiliser la valeur entière en combinaison avec ordered ranking pour définir le classement d'une valeur donnée par rapport aux autres valeurs énumérées pour la même propriété. Ici, un ordre de classement de DESCENDING (décroissant) pour les propriétés de priorité entraîne une amélioration du classement des éléments indexés avec une valeur de p0 par rapport à ceux indexés avec une valeur de p1. Si aucun ordre de classement n'est spécifié, la valeur entière n'a aucun effet sur le classement des éléments.

Représentation JSON 
{
  "stringValue": string,
  "integerValue": integer
}
Champs
stringValue

string

Valeur de chaîne d'EnumValuePair. La longueur ne doit pas dépasser 32 caractères.
integerValue

integer

Valeur entière de l'EnumValuePair qui ne doit pas être négative. Facultatif.

EnumPropertyOptions.OrderedRanking

Permet de spécifier le sens de classement d'un entier EnumValuePair par rapport aux autres valeurs entières EnumValuePair. Pour certaines propriétés, des valeurs entières faibles indiquent une importance plus élevée, tandis que dans d'autres, un entier supérieur indique une importance plus élevée.

Enums
NO_ORDER Il n'y a pas d'ordre de classement pour la propriété. Les résultats ne sont pas ajustés en fonction de la valeur de cette propriété.
ASCENDING Cette propriété est classée par ordre croissant. Plus la valeur est faible, plus le classement est faible.
DESCENDING Cette propriété est classée par ordre décroissant. Plus la valeur est faible, plus le classement est élevé.

EnumPropertyOptions.EnumOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés d'énumération. Cette étape est facultative. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques en rapport avec le type d'élément recherché. Par exemple, si vous ne fournissez aucun opérateur pour une propriété d'énumération priorité avec les valeurs possibles p0 et p1, une requête contenant le terme p0 renvoie les éléments dont la propriété priorité est p0, ainsi que tous les éléments contenant la chaîne p0 dans d'autres champs. Si vous indiquez un nom d'opérateur pour l'énumération, tel que Priority, les utilisateurs de la recherche peuvent utiliser cet opérateur pour affiner les résultats afin d'afficher uniquement les éléments dont la valeur de cette propriété est p0, avec la requête Priority:p0.

Représentation JSON 
{
  "operatorName": string
}
Champs
operatorName

string

Indique le nom d'opérateur requis dans la requête pour isoler la propriété d'énumération. Par exemple, si "operatorName" est Priority et que le nom de la propriété est primaryVal, les requêtes telles que Priority:<value> affichent uniquement les résultats dans lesquels la valeur de la propriété nommée primaryVal correspond à <value>. En revanche, une recherche qui utilise le même &lt;value&gt; sans opérateur renvoie tous les éléments dans lesquels &lt;value&gt; correspond à la valeur de n'importe quelle propriété de chaîne ou de tout texte dans le champ de contenu de l'élément. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

DatePropertyOptions

Options des propriétés de date.

Représentation JSON 
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
Champs
operatorOptions

object (DatePropertyOptions.DateOperatorOptions)

Si cette valeur est définie, décrit comment utiliser la date en tant qu'opérateur de recherche.

DatePropertyOptions.DateOperatorOptions

Facultatif. Fournit un opérateur de recherche pour les propriétés de date. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques en rapport avec le type d'élément recherché.

Représentation JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Champs
operatorName

string

Indique la chaîne réelle requise dans la requête afin d'isoler la propriété "date". Par exemple, supposons qu'un objet schéma de suivi des problèmes comporte une propriété nommée closeDate qui spécifie un opérateur dont le champoperatorName est closedon. Pour les recherches sur ces données, les requêtes telles que closedon:&lt;value&gt; affichent uniquement les résultats dont la valeur de la propriété closedon:&lt;value&gt; correspond à closedon:&lt;value&gt;. En revanche, une recherche qui utilise le même &lt;value&gt; sans opérateur renvoie tous les éléments dans lesquels &lt;value&gt; correspond à la valeur de n'importe quelle propriété de chaîne ou de n'importe quel texte dans le champ de contenu de la source de données indexée. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.
lessThanOperatorName

string

Indique le nom d'opérateur requis dans la requête afin d'isoler la propriété de date à l'aide de l'opérateur "inférieur à". Par exemple, si lessThanOperatorName a la valeur closedbefore et que le nom de la propriété est closeDate, les requêtes telles que closedbefore:<value> affichent uniquement les résultats dans lesquels la valeur de la propriété closeDate est antérieure à <value>. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.
greaterThanOperatorName

string

Indique le nom d'opérateur requis dans la requête afin d'isoler la propriété de date à l'aide de l'opérateur "supérieur à". Par exemple, si "greatThanOperatorName" est closedafter et que le nom de la propriété est closeDate, les requêtes telles que closedafter:<value> affichent uniquement les résultats dans lesquels la valeur de la propriété closeDate est postérieure à <value>. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

TextPropertyOptions

Options des propriétés de texte.

Représentation JSON 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}
Champs
retrievalImportance

object (RetrievalImportance)

Indique l'importance de la qualité de la recherche des jetons dans le champ lorsqu'ils sont utilisés pour la récupération.
operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

Si cet attribut est défini, décrit comment la propriété doit être utilisée en tant qu'opérateur de recherche.

RetrievalImportance

Représentation JSON 
{
  "importance": enum (RetrievalImportance.Importance)
}
Champs
importance

enum (RetrievalImportance.Importance)

Indique l'importance du classement attribuée à la propriété lorsqu'elle est mise en correspondance lors de la récupération. Une fois définie, l'importance du jeton d'une propriété ne peut plus être modifiée.

RetrievalImportance.Importance

Enums
DEFAULT Traitez la correspondance comme une correspondance de texte.
HIGHEST Traitez la correspondance comme une correspondance avec le titre de l'élément.
HIGH Traitez la correspondance avec une importance plus élevée que le corps du texte.
LOW Traitez la correspondance avec une importance moindre que celle du corps du texte.
NONE Ne mettez pas en correspondance ce champ lors de la récupération. La propriété peut toujours être utilisée pour la mise en correspondance des opérateurs, les attributs et les suggestions si vous le souhaitez.

TextPropertyOptions.TextOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés textuelles. Cette étape est facultative. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques en rapport avec le type d'élément recherché.

Représentation JSON 
{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}
Champs
operatorName

string

Indique le nom d'opérateur requis dans la requête afin d'isoler la propriété textuelle. Par exemple, si "operatorName" est subject et que le nom de la propriété est subjectLine, les requêtes telles que subject:<value> affichent uniquement les résultats où la valeur de la propriété nommée subjectLine correspond à <value>. En revanche, une recherche qui utilise le même &lt;value&gt; sans opérateur renvoie tous les éléments où &lt;value&gt; correspond à la valeur de toute propriété de texte ou de tout texte dans le champ de contenu de l'élément. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.
exactMatchWithOperator

boolean

Si la valeur est "true", la valeur de texte est tokenisée sous la forme d'une valeur atomique unique dans les recherches avec opérateur et les correspondances d'attributs. Par exemple, si le nom d'opérateur est "genre", et la valeur est "SF" les restrictions de requête "genre:science" et "genre:fiction" ne correspond pas à l'article ; "genre:science-fiction" . La mise en correspondance des valeurs textuelles est sensible à la casse et ne supprime pas les caractères spéciaux. Si la valeur est "false", le texte est tokenisé. Par exemple, si la valeur est "SF" les requêtes "genre:science" et "genre:fiction" correspond à l'élément.

HtmlPropertyOptions

Options des propriétés HTML.

Représentation JSON 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}
Champs
retrievalImportance

object (RetrievalImportance)

Indique l'importance de la qualité de la recherche des jetons dans le champ lorsqu'ils sont utilisés pour la récupération. Peut uniquement être défini sur PAR DÉFAUT ou NONE.
operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

Si cet attribut est défini, décrit comment la propriété doit être utilisée en tant qu'opérateur de recherche.

HtmlPropertyOptions.HtmlOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés HTML. Cette étape est facultative. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques en rapport avec le type d'élément recherché.

Représentation JSON 
{
  "operatorName": string
}
Champs
operatorName

string

Indique le nom de l'opérateur requis dans la requête afin d'isoler la propriété HTML. Par exemple, si "operatorName" est subject et que le nom de la propriété est subjectLine, les requêtes telles que subject:<value> affichent uniquement les résultats où la valeur de la propriété nommée subjectLine correspond à <value>. En revanche, une recherche qui utilise le même &lt;value&gt; sans opérateur renvoie tous les éléments où &lt;value&gt; correspond à la valeur de toute propriété HTML ou de tout texte dans le champ de contenu de l'élément. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

PropertyDisplayOptions

Options d'affichage d'une propriété.

Représentation JSON 
{
  "displayLabel": string
}
Champs
displayLabel

string

Libellé convivial de la propriété utilisée si celle-ci est spécifiée pour être affichée dans ObjectDisplayOptions. S'il est fourni, le libellé d'affichage est affiché devant les valeurs de la propriété lorsque celle-ci fait partie des options d'affichage de l'objet. Par exemple, si la valeur de la propriété est "1", il est possible que cette valeur ne constitue pas un contexte utile pour l'utilisateur. Si le nom à afficher indiqué était "priorité", l'utilisateur voit "priorité : 1". dans les résultats de recherche afin d'offrir un contexte clair aux utilisateurs. Cette étape est FACULTATIVE. Si elles ne sont pas fournies, seules les valeurs de propriété sont affichées. La longueur maximale est de 64 caractères.