Query variables in SharePoint Server
ОБЛАСТЬ ПРИМЕНЕНИЯ:
2013 2016 2019 Subscription Edition SharePoint в Microsoft 365
Примечание. Эта статья не относится к современным интерфейсам поиска (Майкрософт) и API. Дополнительные сведения о современном поиске см. в разделе Профилирование переменных запроса.
Переменные запроса
В следующих таблицах показаны переменные запросов для SharePoint Server и SharePoint в Microsoft 365, а также примеры их использования.
Свойства сайта и семейства веб-сайтов
| Переменная запроса | Определение |
|---|---|
| {Site} или {Site.URL} |
URL-адрес сайта, с которого был отправлен запрос. Например, эту переменную можно использовать для запроса значения управляемого свойства Path. |
| {Site.ID} |
Идентификатор GUID сайта, с которого был отправлен запрос. Это значение соответствует значению управляемого свойства WebId. |
| {Site.LCID} |
Числовое значение языкового стандарта, указанного в региональных параметрах сайта, с которого был отправлен запрос. |
| {Site.Locale} |
Язык сайта, с которого был отправлен запрос, в формате яя-сс, например en-us. |
| {Сайт.<property>} |
Любое свойство из контейнера свойств сайта (SPWeb), с которого был отправлен запрос, включая настраиваемые свойства. |
| {SiteCollection} или {SiteCollection.URL} |
URL-адрес семейства веб-сайтов, из которого был отправлен запрос. Например, эту переменную можно использовать для запроса значения управляемого свойства Path. |
| {SiteCollection.ID} |
Идентификатор GUID семейства веб-сайтов, из которого был отправлен запрос. Это значение соответствует значению управляемого свойства SiteID. |
| {SiteCollection.LCID} |
Числовое значение языкового стандарта, указанного в региональных параметрах семейства веб-сайтов, из которого был отправлен запрос. |
| {SiteCollection.Locale} |
Язык семейства веб-сайтов, из которого был отправлен запрос, в формате яя-сс, например en-us. |
| {SiteCollection.<property>} |
Любое свойство из контейнера свойств корневого сайта (SPWeb) в семействе веб-сайтов (SPSite), из которого был отправлен запрос, включая настраиваемые свойства. |
Свойства страницы, URL-маркера, строки запроса и запроса
| Переменная запроса | Определение |
|---|---|
| {Page} или {Page.URL} |
URL-адрес страницы, с которой был отправлен запрос. Например, эту переменную можно использовать для запроса значения управляемого свойства Path. |
| {Page.UsageAnalyticsId} |
Идентификатор элемента для анализа использования. |
| {Page.<FieldName>} |
Значение поля на странице, с которой был отправлен запрос. Например, если страница, с которой был отправлен запрос, содержит столбец сайта с именем ContentOwner, то с помощью переменной {Page.ContentOwner} можно запросить значение поля "ContentOwner". |
| {URLToken.<целое число>} |
Элемент URL-адреса страницы. Целое число указывает на положение элемента в URL-адресе, если считать справа налево. Например, для страницы http://www.contoso/audio/mp3/1010101 переменная запроса {URLToken.1} вернет значение "1010101". Переменная запроса {URLToken.3} вернет третий с конца элемент URL-адреса, то есть "audio". Запросить можно максимум девятый элемент ULR-адреса с конца. |
| {QueryString.<ParameterName>} |
Значение строки запроса в URL-адресе текущей страницы. Например, если URL-адрес текущей страницы содержит строку запроса ItemNumber=567, то переменная {QueryString.ItemNumber} вернет значение 567. |
| {Request.<PropertyName>} |
Значение текущего HTTP-запроса, например {Request.Url}. |
Свойства пользователя
| Переменная запроса | Определение |
|---|---|
| {User} или {User.Name} |
Отображаемое имя пользователя, отправившего запрос. Например, эту переменную можно использовать для запроса значения управляемого свойства Author. |
| {User.Email} |
Адрес электронной почты пользователя, отправившего запрос. Например, эту переменную можно использовать для запроса значения управляемого свойства WorkEmail. |
| {User.SID} |
ИД безопасности пользователя, отправившего запрос. |
| {User.LCID} |
Числовое значение языкового стандарта, определенного в профиле пользователя, который отправил запрос. |
| {User.PreferredContentLanguage} |
Язык, указанный в качестве предпочтительного языка контента в профиле пользователя, отправившего запрос. |
| {User.PreferredDisplayLanguage} |
Язык, указанный в качестве предпочтительного языка интерфейса в профиле пользователя, отправившего запрос. |
| {Пользователь.<property>} |
Любое свойство из профиля пользователя, отправившего запрос, например SPS-Interests, включая настраиваемые свойства. |
| {User.Audiences} (только SharePoint) |
Используется с современной фильтрацией целевой аудитории SharePoint по управляемому свойству ModernAudienceAadObjectIds. Пример: ModernAudienceAadObjectIds:{User.Audiences}. |
Свойства термина или набора терминов
| Переменная запроса | Определение |
|---|---|
| {Term}, {Term.ID} или {Term.IDNoChildren} |
Идентификатор GUID текущего узла в структуре навигации веб-сайта с префиксом #0, например #083e99dcb-7907-4dc9-abc8-b5614a284f1c. Например, эту переменную можно использовать для запроса значения управляемого свойства owstaxIdMetadataAllTagsInfo или owstaxIdProductCatalogItemCategory в семействе веб-сайтов "Каталог продукции". |
| {Term.IDWithChildren} |
Идентификатор GUID текущего узла в структуре навигации веб-сайта с префиксом #, например #83e99dcb-7907-4dc9-abc8-b5614a284f1c. Возвращает все элементы, помеченные с помощью текущего термина структуры навигации веб-сайта, или дочерние элементы этого термина. Например, эту переменную можно использовать для запроса значения управляемого свойства owstaxIdProductCatalogItemCategory в семействе веб-сайтов "Каталог продукции". Ее нельзя использовать для запроса значения управляемого свойства owstaxidmetadataalltagsinfo. |
| {Term.Name} |
Метка узла в структуре навигации веб-сайта, например Audio. |
| {Term.<property>} |
Любое свойство из контейнера свойств термина, включая настраиваемые свойства. |
| {TermSet} или {TermSet.ID} |
Идентификатор GUID набора терминов, используемого для текущей структуры навигации веб-сайта. |
| {TermSet.Name} |
Метка набора терминов, используемого для текущей структуры навигации веб-сайта. |
Свойства списка и элементов списка
| Переменная запроса | Определение |
|---|---|
| {List} |
URL-адрес текущего списка. |
| {List.<property>} |
Любое свойство текущего списка. |
| {ListItem} |
URL-адрес текущего элемента списка. |
| {ListItem.<property>} |
Любое свойство текущего элемента списка. |
Другие свойства
| Переменная запроса | Определение |
|---|---|
| {Today+/- <целочисленное значение количества дней>} |
Дата, получаемая путем прибавления указанного числа дней к дате отправки запроса или вычитания их из нее. Формат даты: ГГГГ-ММ-ДД. Например, эту переменную можно использовать для запроса значения управляемого свойства LastModifiedTime. |
| {SearchBoxQuery} |
Значение запроса, введенного в поле поиска на странице. |
| {CurrentDisplayLanguage} |
Текущий язык многоязыкового пользовательского интерфейса в формате яя-сс. |
| {CurrentDisplayLCID} |
Числовое значение текущего языка многоязыкового пользовательского интерфейса в формате яя-сс. |
Пробелы в значениях
В поисковых запросах символ пробела используется для разметки значения запроса, отправленного пользователем. Когда переменная запроса развертывается в значение, содержащее пробел, все значение заключается в двойные кавычки. Например, для запроса author:{User} развернутое значение имеет вид "Владимир Егоров".
Если вы не хотите, чтобы значение заключалось в кавычки, например, при сцеплении нескольких значений, вы можете воспользоваться escape-символом в переменной запроса. Например, запрос customProperty:"{\User.Name};{\User.ZipCode}" вернет customProperty:"Владимир Егоров;98109".
Переменные запроса с несколькими значениями
Некоторые переменные запроса могут возвращать несколько значений. For query variables that return multiple values, the following syntax must be used: {|ManagedProperty:{QueryVariable}}. All the query variable values will be combined by using the bitwise OR operation. For example, say that you have a term set that is used to categorized interest of users. All users are configured to have one or more interests using the multi-value property SPS-Interests in the User Profile Service Application. To issue a query for any of the interests of the current user, the following syntax could be used: {|owstaxIdMetadataAllTagsInfo:{User.SPS-Interests}}. Если текущий пользователь настроен на наличие двух интересов — футбола (#0f95d1fdf-781f-42f4-99f9-c656c1341b2e) и баскетбола (#0c2cff933-9377-4692-aa98-ce59768aa38b), запрос будет преобразован в (9377-4692-aa98-ce59768aa38b) owstaxIdMetadataAllTagsInfo:#0f95d1fdf-781f-42f4-99f9-c656c1341b2e) OR (owstaxIdMetadataAllTagsInfo:#0c2cff933-9377-4692-aa98-ce59768aa38b) .
На использование нескольких значений накладываются некоторые ограничения. Для них поддерживается только оператор ИЛИ ({|). Оператор И не поддерживается. Кроме того, несколько значений возвращаются правильно только для столбцов типа "Управляемые метаданные". Для других типов столбцов, в которых может быть несколько значений, например "Человек", "Группа" или "Выбор", элементы будут развертываться в виде строки с разделителями.