CrowdingSpec

Spécification pour l'encombrement. Le regroupement améliore la diversité des résultats de recherche en limitant le nombre de résultats qui partagent la même valeur de champ. Par exemple, si le regroupement est défini sur le champ "color" (couleur) avec un maxCount de 3 et un mode DROP_CROWDED_RESULTS, au maximum trois résultats de la même couleur seront renvoyés sur toutes les pages.

Représentation JSON 
{
  "field": string,
  "maxCount": integer,
  "mode": enum (Mode)
}
Champs
field

string

Champ à utiliser pour l'encombrement. Les documents peuvent être encombrés par un champ dans l'objet Document. Le champ "Encombrement" est sensible à la casse.
maxCount

integer

Nombre maximal de documents à conserver par valeur du champ. Une fois qu'il y a au moins maxCount résultats précédents qui contiennent la même valeur pour le champ donné (selon l'ordre spécifié dans orderBy), les résultats ultérieurs avec la même valeur sont "écartés". Si aucune valeur n'est spécifiée, la valeur par défaut est 1.
mode

enum (Mode)

Mode à utiliser pour les documents trop éloignés.

Mode

Énumération décrivant le mode à utiliser pour les documents qui sont écartés. Elles peuvent être supprimées ou reléguées sur les pages suivantes.

Enums
MODE_UNSPECIFIED Mode d'encombrement non spécifié. Dans ce cas, le comportement du serveur est défini par défaut sur Mode.DROP_CROWDED_RESULTS.
DROP_CROWDED_RESULTS Supprimez les résultats regroupés.
DEMOTE_CROWDED_RESULTS_TO_END Reléguer les résultats encombrés sur les pages suivantes.