Variables de requête dans SharePoint Server

S’APPLIQUE À :oui-img-132013 oui-img-162016 oui-img-192019 oui-img-seÉdition d’abonnement oui-img-sopSharePoint dans Microsoft 365

Remarque : Cet article ne s’applique pas aux API et expériences De recherche Microsoft modernes. Pour en savoir plus sur la recherche moderne, consultez Variables de requête de profil.

Variables de requête

Les tableaux suivants présentent les variables de requête pour SharePoint Server et SharePoint dans Microsoft 365, ainsi que des exemples sur la façon dont elles peuvent être utilisées.

Propriétés de site et de collection de sites

Variable de requête Définition
{Site} ou {Site.URL}
URL du site duquel la requête a été émise. À titre d'exemple, vous pouvez utiliser cette valeur pour interroger le contenu de la propriété gérée Path.
{Site.ID}
GUID du site duquel la requête a été émise. Cette valeur correspond à la valeur de la propriété managée WebId.
{Site.LCID}
Valeur numérique des paramètres régionaux telle qu'elle apparaît dans la fenêtre Paramètres régionaux, dans Paramètres du site sur le site où la requête a été émise.
{Site.Locale}
Langue du site où la requête a été émise, au format ll-cc (par exemple, en-us).
{Site.< property>}
N'importe quelle propriété du conteneur des propriétés du site (SPWeb) où la requête a été émise, y compris les propriétés personnalisées.
{SiteCollection} ou {SiteCollection.URL}
URL de la collection de sites de laquelle la requête a été émise. À titre d'exemple, vous pouvez utiliser cette valeur pour interroger le contenu de la propriété gérée Path.
{SiteCollection.ID}
GUID de la collection de sites de laquelle la requête a été émise. Cette valeur correspond à la valeur de la propriété gérée SiteID.
{SiteCollection.LCID}
Valeur numérique des paramètres régionaux telle qu'elle apparaît dans la fenêtre Paramètres régionaux, dans Paramètres du site, dans la collection de sites depuis laquelle la requête a été émise.
{SiteCollection.Locale}
Langue de la collection de sites de laquelle la requête a été émise, au format ll-cc (par exemple, en-us).
{SiteCollection.< property>}
N'importe quel conteneur de propriétés du site racine (SPWeb) dans la collection de sites (SPSite) de laquelle la requête a été émise, comprenant notamment les propriétés personnalisées.

Propriété de page, de jeton d'URL, de chaîne de requête et de requête

Variable de requête Définition
{Page} ou {Page.URL}
URL de la page de laquelle la requête a été émise. À titre d'exemple, vous pouvez utiliser cette valeur pour interroger le contenu de la propriété gérée Path.
{Page.UsageAnalyticsId}
ID d'élément d'analyse de l'utilisation
{Page.< FieldName>}
Valeur d'un champ dans la page de laquelle la requête a été émise. Par exemple, si la page d'où la requête a été émise contenait une colonne de site appelée « ContentOwner », la définition de la propriété {Page.ContentOwner} vous permettrait d'interroger la valeur de « ContentOwner ».
{URLToken.< integer>}
Valeur issue de l'URL d'une page. L'entier désigne la position de la valeur dans l'URL, de la droite vers la gauche. Par exemple, pour la page http://www.contoso/audio/mp3/1010101, la variable de requête {URLToken.1} interrogera la dernière valeur dans l'URL, 1010101. La variable de requête {URLToken.3} interrogera la troisième dernière propriété au sein de l'URL (audio). Vous pouvez interroger des valeurs jusqu'à la neuvième dernière position dans une URL.
{QueryString.< ParameterName>}
Valeur de chaîne de requête dans l'URL de la page active. Par exemple, si l'URL de la page active contenait une chaîne de requête telle que ItemNumber=567, vous pourriez obtenir la valeur 567 en spécifiant {QueryString.ItemNumber}.
{Request.< PropertyName>}
Valeur de la requête HTTP actuelle - par exemple, {Request.Url}.

Propriétés utilisateur

Variable de requête Définition
{User} ou {User.Name}
Nom complet de l'utilisateur qui a émis la requête. À titre d'exemple, vous pouvez utiliser cette valeur pour interroger le contenu de la propriété gérée Author.
{Utilisateur. Email}
Adresse de messagerie de l'utilisateur qui a émis la requête. Par exemple, cette valeur peut être employée pour interroger le contenu de la propriété gérée WorkEmail.
{User.SID}
ID de sécurité (SID) de l'utilisateur qui a émis la requête.
{User.LCID}
Valeur numérique des paramètres régionaux définie dans le profil de l'utilisateur qui a émis la requête.
{User.PreferredContentLanguage}
Langue définie comme langue de contenu par défaut dans le profil de l'utilisateur qui a émis la requête.
{User.PreferredDisplayLanguage}
Langue définie comme langue d'affichage par défaut dans le profil de l'utilisateur qui a émis la requête.
{Utilisateur.< property>}
N'importe quelle propriété du profil utilisateur de l'utilisateur qui a émis la requête (par exemple, SPS-Interests), y compris les propriétés personnalisées.
{User.Audiences}

(SharePoint uniquement)
Utilisé avec l’audience SharePoint moderne ciblant le filtrage sur la propriété ModernAudienceAadObjectIdsmanagée . Exemple : ModernAudienceAadObjectIds:{User.Audiences}.

Propriétés de terme et d'ensemble de termes

Variable de requête Définition
{Term} ou {Term.ID} ou {Term.IDNoChildren}
GUID du nœud de navigation actuel du site avec un préfixe #0 (par exemple, #083e99dcb-7907-4dc9-abc8-b5614a284f1c). À titre d'exemple, vous pouvez utiliser cette valeur pour interroger le contenu de la propriété gérée owstaxIdMetadataAllTagsInfo ou de la propriété gérée owstaxIdProductCatalogItemCategory dans une collection de sites Catalogue de produits.
{Term.IDWithChildren}
GUID du nœud de navigation actuel du site avec un préfixe # (par exemple, #83e99dcb-7907-4dc9-abc8-b5614a284f1c). Cette valeur renvoie tous les éléments balisés avec le terme de navigation de site actuel ou des enfants de ce même site. À titre d'exemple, vous pouvez utiliser cette valeur pour interroger le contenu de la propriété gérée owstaxIdProductCatalogItemCategory dans une collection de sites Catalogue de produits. Par contre, elle ne peut pas être employée pour interroger le contenu de la propriété gérée owstaxIdMetadataAllTagsInfo.
{Term.Name}
Étiquette du nœud de navigation du site (par exemple, Audio).
{Term.< property>}
N'importe quelle propriété du conteneur des propriétés du terme, y compris les propriétés personnalisées.
{TermSet} ou {TermSet.ID}
GUID de l'ensemble des termes employés pour la navigation actuelle sur le site.
{TermSet.Name}
Étiquette de l'ensemble des termes employés pour la navigation actuelle sur le site.

Propriétés de liste et d'élément de liste

Variable de requête Définition
{List}
URL de la liste actuelle.
{List.< property>}
N'importe quelle propriété de la liste actuelle.
{ListItem}
URL de l'élément de liste actuel.
{ListItem.< property>}
N'importe quelle propriété de l'élément de liste actuel.

Autres propriétés

Variable de requête Définition
{Today+/- <valeur entière pour le nombre de jours>}
Date calculée par addition/soustraction du nombre de jours spécifié vers/depuis la date à laquelle la requête a été émise. Le format de date est AAAA-MM-JJ. À titre d'exemple, vous pouvez utiliser cette valeur pour interroger le contenu de la propriété gérée LastModifiedTime.
{SearchBoxQuery}
Valeur de requête saisie dans une zone de recherche dans une page.
{CurrentDisplayLanguage}
Langue d'affichage actuelle définie en fonction de l'interface utilisateur multilingue (MUI), au format ll-cc.
{CurrentDisplayLCID}
Valeur numérique de la langue d’affichage actuelle définie en fonction de l’interface utilisateur multilingue (MUI), au format ll-cc.

Traitement des espaces dans les valeurs

Les requêtes de recherche utilisent un espace pour marquer des valeurs de requête émises par les utilisateurs. Lorsqu'une variable de requête est étendue à une valeur dotée d'un espace, la valeur complète est mise entre guillemets. Par exemple, pour la requête author:{User}, la valeur étendue devient author:"John Smith".

Si vous ne souhaitez pas que la valeur apparaisse entre guillemets (par exemple, pour la concaténation de valeurs multiples), vous pouvez utiliser le caractère d'échappement dans la variable de requête. Ainsi, par exemple, customProperty:"{\User.Name};{\User.ZipCode}" deviendrait customProperty:"John Smith;98109".

Variables de requête à valeurs multiples

Certaines variables de requête peuvent renvoyer plusieurs valeurs. Pour ces variables de requête à valeurs multiples, vous devez utiliser la syntaxe suivante : {|ManagedProperty:{QueryVariable}}. Toutes les valeurs des variables de requête seront combinées à l'aide de l'opération OR au niveau du bit. Par exemple, imaginons que vous disposez d'un ensemble de termes utilisés pour classer les centres d'intérêt des utilisateurs par catégories. Tous les utilisateurs sont configurés avec un ou plusieurs centres d'intérêt à l'aide de la propriété à valeurs multiples SPS-Interests disponible dans l'application de service Profil utilisateur. Pour émettre une requête pour l'un des centres d'intérêt de l'utilisateur actuel, vous pouvez appliquer la syntaxe suivante : {|owstaxIdMetadataAllTagsInfo:{User.SPS-Interests}}. Si l’utilisateur actuel est configuré pour avoir deux centres d’intérêt : le football (#0f95d1fdf-781f-42f4-99f9-c656c1341b2e) et le basket-ball (#0c2cff933-9377-4692-aa98-ce59768aa38b), la requête est transformée en (ows)taxIdMetadataAllTagsInfo:#0f95d1fdf-781f-42f4-99f9-c656c1341b2e) OR (owstaxIdMetadataAllTagsInfo:#0c2cff933-9377-4692-aa98-ce59768aa38b) .

L'emploi de valeurs multiples imposent certaines restrictions. Seul l'opérateur OR ({|) est pris en charge pour les valeurs multiples. L'opérateur AND ne l'est pas. De même, seules les colonnes de type Métadonnées gérées fonctionnent correctement dans des cas à valeurs multiples. Les autres colonnes susceptibles d'utiliser plusieurs valeurs, telles que les colonnes de type Personne, Groupe ou Choix, seront étendues dans une chaîne délimitée.