Variáveis de consulta no SharePoint Server
APLICA-SE A:
2013 2016 2019 Subscription Edition SharePoint no Microsoft 365
Nota: este artigo não se aplica a APIs e experiências modernas do Microsoft Search. Para saber mais sobre a Pesquisa Moderna, veja Variáveis de Consulta de Perfil.
Variáveis de consulta
As tabelas seguintes mostram as variáveis de consulta para o SharePoint Server e o SharePoint no Microsoft 365 e exemplos sobre como podem ser utilizadas.
Site e propriedades de coleção de site
| Variável de consulta | Definição |
|---|---|
| {Site} ou {Site.URL} |
O URL do site o qual a consulta foi emitida. Por exemplo, este valor pode ser usado para conteúdo de consulta da propriedade gerenciada Path. |
| {Site.ID} |
O GUID do site o qual a consulta foi emitida. Este valor corresponde ao valor do WebId da propriedade gerida. |
| {Site.LCID} |
Valor numérico do local conforme especificado pelas Configurações Regionais no site onde a consulta foi emitida. |
| {Site.Locale} |
Idioma do Site onde a consulta foi emitida, em formato ll-cc — por exemplo, en-us. |
| {Site.<property>} |
Qualquer propriedade do recipiente de propriedades do site (SPWeb) o qual a consulta foi emitida, excluindo propriedades personalizadas. |
| {SiteCollection} ou {SiteCollection.URL} |
URL do conjunto de sites o qual a consulta foi emitida. Por exemplo, este valor pode ser usado para conteúdo de consulta da propriedade gerenciada Path. |
| {SiteCollection.ID} |
O GUID do conjunto de sites onde a consulta foi emitida. O valor corresponde ao valor da propriedade gerenciada SiteID. |
| {SiteCollection.LCID} |
Valor numérico do local, conforme especificado pelas Configurações Regionais nas Configurações de Site o qual a consulta foi emitida. |
| {SiteCollection.Locale} |
Idioma do Conjunto de Site onde a consulta foi emitida, em formato ll-cc — por exemplo, en-us. |
| {SiteCollection.<property>} |
Qualquer propriedade do recipiente de propriedades do site de raiz (SPWeb) o qual a consulta foi emitida, incluindo propriedades personalizadas. |
Página, token de URL, cadeia de consulta e propriedades de solicitação
| Variável de consulta | Definição |
|---|---|
| {Page} ou {Page.URL} |
O URL da página a qual a consulta foi emitida. Por exemplo, este valor pode ser usado para conteúdo de consulta da propriedade gerenciada Path. |
| {Page.UsageAnalyticsId} |
ID de Item para análise de uso |
| {Página.<FieldName>} |
O valor de um campo na página onde a consulta foi emitida. Por exemplo, se a página a qual a consulta foi emitida possuir uma coluna de site chamado "ContentOwner," especificar {Page.ContentOwner} permitiria que você consultasse pelo valor de "ContentOwner." |
| {URLToken.<número inteiro>} |
O valor do URL de uma página. O inteiro representa a posição do valor no URL contado da direita para esquerda. Por exemplo, para a página http://www.contoso/audio/mp3/1010101, a variável de consulta {URLToken.1} irá consultar o último valor no URL, 1010101. O valor de consulta {URLToken.3} pesquisará pela terceira última propriedade no URL, audio. Você pode consultar por valores até a nona posição em um URL. |
| {QueryString.<ParameterName>} |
Um valor de uma cadeia de consulta no URL da página atual. Por exemplo, se o URL da página atual possuir uma cadeia de consulta como ItemNumber=567, você pode obter o valor 567 ao especificar {QueryString.ItemNumber}. |
| {Pedido.<PropertyName>} |
Um valor da solicitação http atual; por exemplo, {Request.Url}. |
Propriedades de usuário
| Variável de consulta | Definição |
|---|---|
| {User} ou {User.Name} |
Exibe o nome do usuário que emitiu a consulta. Por exemplo, este valor pode ser usado para conteúdo de consulta da propriedade gerenciada Author. |
| {User.Email} |
Endereço de email do usuário que emitiu a consulta. Por exemplo, este valor pode ser usado para conteúdo de consulta da propriedade gerenciada WorkEmail. |
| {User.SID} |
SID do usuário que emitiu a consulta. |
| {User.LCID} |
Valor numérico do local, como definido no perfil do usuário que emitiu a consulta. |
| {User.PreferredContentLanguage} |
Idioma conforme especificado como Idioma de Conteúdo Preferido no perfil do usuário que emitiu a consulta. |
| {User.PreferredDisplayLanguage} |
Idioma conforme especificado em Idioma de Exibição Preferido no perfil do usuário que emitiu a consulta. |
| {Utilizador.<property>} |
Qualquer propriedade do perfil de usuário que emitiu a consulta — por exemplo, SPS-Interests, incluindo propriedades personalizadas. |
| {User.Audiences} (apenas no SharePoint) |
Utilizado com a filtragem da audiência moderna do SharePoint na propriedade ModernAudienceAadObjectIdsgerida . Exemplo: ModernAudienceAadObjectIds:{User.Audiences}. |
Termo e propriedades de definição de termo
| Variável de consulta | Definição |
|---|---|
| {Term} ou {Term.ID} ou {Term.IDNoChildren} |
O GUID do nó de navegação do site com um prefixo de #0 — por exemplo, #083e99dcb-7907-4dc9-abc8-b5614a284f1c. Por exemplo, este valor pode ser usado para conteúdo de consulta da propriedade gerenciada owstaxIdMetadataAllTagsInfo ou owstaxIdProductCatalogItemCategory em um Conjunto de Sites de Catálogo de Produto. |
| {Term.IDWithChildren} |
O GUID do nó de navegação de site atual com um prefixo de # — por exemplo, #83e99dcb-7907-4dc9-abc8-b5614a284f1c. Isso retornará todos os itens marcados com o termo de navegação do site atual ou filho do termo de navegação do site atual. Por exemplo, este valor pode ser utilizado para consultar o conteúdo da propriedade gerida owstaxIdProductCatalogItemCategory numa Coleção de Sites do Catálogo de Produtos. Este valor não pode ser usado para consultar conteúdo da propriedade gerenciada ]owstaxidmetadataalltagsinfo. |
| {Term.Name} |
Rótulo do nó de navegação do site — por exemplo, Audio. |
| {Termo.<property>} |
Qualquer propriedade do recipiente de propriedade do termo, incluindo propriedades personalizadas. |
| {TermSet} ou {TermSet.ID} |
O GUID do conjunto de termos usados para a navegação de site atua. |
| {TermSet.Name} |
Rótulo do conjunto de termo usado para a navegação do site atual. |
Lista e propriedades de item de lista
| Variável de consulta | Definição |
|---|---|
| {List} |
URL da lista atual. |
| {Lista.<property>} |
Qualquer propriedade da lista atual. |
| {ListItem} |
URL do item de lista atual. |
| {ListItem.<property>} |
Qualquer propriedade do item de lista atual. |
Outras propriedades
| Variável de consulta | Definição |
|---|---|
| {Hoje+/- <valor inteiro para o número de dias>} |
Uma data calculada ao adicionar/subtrair o número específico de dias de/para a data quando a consulta é emitida. O formato de data é AAAA-MM-DD. Por exemplo, este valor pode ser usado para conteúdo de consulta da propriedade gerenciada LastModifiedTime. |
| {SearchBoxQuery} |
O valor de consulta inserido em uma caixa de pesquisa em uma página. |
| {CurrentDisplayLanguage} |
O idioma exibido atualmente com base no MUI no formato ll-cc. |
| {CurrentDisplayLCID} |
Valor numérico do idioma exibido atualmente com base no MUI no formato ll-cc. |
Lidando com espaços nos valores
As consultas de pesquisa usam o caractere de espaço para criar tokens de valores de consulta emitidos pelos usuários. Quando uma variável de consulta é expandido para um valor que contém um espaço, o valor completo é inserido em aspas duplas. Por exemplo, para a consulta author:{User}, o valor expandido se torna author:"John Smith".
Se você não quer que o valor seja inserido em aspas duplas, por exemplo ao concatenar vários valores, você pode usar o caractere de escape na variável de consulta. Por exemplo: customProperty:"{\User.Name}; {\User.ZipCode}" tornar-se-ia customProperty:"John Smith; 98109".
Variáveis de consulta com vários valores
Algumas variáveis de consulta podem retornar vários valores. Para variáveis de consulta que retornam vários valores, a sintaxe a seguir deve ser usada: {|ManagedProperty:{QueryVariable}}. Todos os valores de variável de consulta serão combinados utilizando a operação OR bit a bit. Por exemplo, digamos que você tenha um conjunto de termo que é usado para categoriza interesses de usuários. Todos os usuários estão configurados para ter um ou mais interesses usando a propriedade de múltiplos valores SPS-Interests no Aplicativo de Serviço de Perfil de Usuário. Para emitir uma consulta para qualquer um dos interesses do usuário atual, a sintaxe a seguir poderia ser usada: {|owstaxIdMetadataAllTagsInfo:{User.SPS-Interests}}. Se o utilizador atual estiver configurado para ter dois interesses : futebol (#0f95d1fdf-781f-42f4-99f9-c656c1341b2e) e basquetebol (#0c2cff933-9377-4692-aa98-ce59768aaa38b), a consulta será transformada em (ows)taxIdMetadataAllTagsInfo:#0f95d1fdf-781f-42f4-99f9-c656c1341b2e) OR (owstaxIdMetadataAllTagsInfo:#0c2cff933-9377-4692-aa98-ce59768aa38b) .
Existem algumas restrições ao usar vários valores. Apenas o operador OR ({|) é suportado para vários valores. O operador AND não é suportado. Além disso, apenas colunas do tipo Metadados Gerenciados funcionam corretamente para casos de vários valores. Em outros tipos de colunas que podem usar diversos valores, como colunas de tipo Pessoa ou Grupo ou Opção, os itens serão expandidos em uma cadeia delimitada.