SharePoint Server のクエリ変数
適用対象:
2016 2019 Subscription Edition SharePoint in Microsoft 365
注: この記事は、最新の Microsoft Search エクスペリエンスと API には適用されません。 モダン検索の詳細については、「 プロファイル クエリ変数」を参照してください。
クエリ変数
次の表は、Microsoft 365 の SharePoint Server と SharePoint のクエリ変数と、それらの使用方法の例を示しています。
サイトとサイト コレクションのプロパティ
| クエリ変数 | 定義 |
|---|---|
| {Site} または {Site.URL} |
クエリが発行されたサイトの URL です。 たとえば、この値を使用して管理プロパティ Path の内容をクエリできます。 |
| {Site.ID} |
クエリが発行されたサイトの GUID です。 この値は、管理プロパティ WebId の値に対応します。 |
| {Site.LCID} |
クエリが発行されたサイトのサイト設定の地域設定で指定されているロケールの数値です。 |
| {Site.Locale} |
クエリが発行されたサイトの言語です。ll-cc 形式です (例: en-us)。 |
| {Site.<property>} |
クエリが発行されたサイト (SPWeb) のプロパティ バッグの任意のプロパティです。カスタム プロパティを含みます。 |
| {SiteCollection} または {SiteCollection.URL} |
クエリが発行されたサイト コレクションの URL です。 たとえば、この値を使用して管理プロパティ Path の内容をクエリできます。 |
| {SiteCollection.ID} |
クエリが発行されたコレクションの GUID です。 この値は、管理プロパティ SiteID の値に対応しています。 |
| {SiteCollection.LCID} |
クエリが発行されたサイト コレクションのサイト設定の地域設定で指定されているロケールの数値です。 |
| {SiteCollection.Locale} |
クエリが発行されたサイト コレクションの言語です。ll-cc 形式です (例: en-us)。 |
| {SiteCollection.<property>} |
クエリが発行されたサイト コレクション (SPSite) のルート サイト (SPWeb) のプロパティ バッグの任意のプロパティです。カスタム プロパティを含みます。 |
ページ、URL トークン、クエリ文字列、要求のプロパティ
| クエリ変数 | 定義 |
|---|---|
| {Page} または {Page.URL} |
クエリが発行されたページの URL です。 たとえば、この値を使用して管理プロパティ Path の内容をクエリできます。 |
| {Page.UsageAnalyticsId} |
使用状況分析用のアイテム ID です。 |
| {Page.<FieldName>} |
クエリが発行されたページのフィールドの名前です。 たとえば、クエリが発行されたページに "ContentOwner" という名前のサイト列が含まれる場合、{Page.ContentOwner} と指定すると、"ContentOwner" の値をクエリできます。 |
| {URLToken.<integer>} |
ページの URL からの値です。 整数は、URL 内で右から左に数えた値の位置です。 たとえば、http://www.contoso/audio/mp3/1010101 というページの場合、クエリ変数 {URLToken.1} は、URL の最後の値 1010101 をクエリします。 クエリ変数 {URLToken.3} は、URL の最後から 3 番目のプロパティ audio をクエリします。 ULR の最後から 9 番目の位置の値までクエリできます。 |
| {QueryString.<ParameterName>} |
現在のページの URL に含まれるクエリ文字列の値です。 たとえば、現在のページの URL に ItemNumber=567 というクエリ文字列が含まれる場合、{QueryString.ItemNumber} と指定することによって値 567 を取得できます。 |
| {Request.<PropertyName>} |
現在の HTTP 要求の値です (例: {Request.Url})。 |
ユーザーのプロパティ
| クエリ変数 | 定義 |
|---|---|
| {User} または {User.Name} |
クエリを発行したユーザーの表示名です。 たとえば、この値を使用して管理プロパティ Author の内容をクエリできます。 |
| {User.Email} |
クエリを発行したユーザーの電子メール アドレスです。 たとえば、この値を使用して管理プロパティ WorkEmail の内容をクエリできます。 |
| {User.SID} |
クエリを発行したユーザーの SID です。 |
| {User.LCID} |
クエリを発行したユーザーのプロファイルで定義されているロケールの数値です。 |
| {User.PreferredContentLanguage} |
クエリを発行したユーザーのプロファイルで優先コンテンツ言語として指定されている言語です。 |
| {User.PreferredDisplayLanguage} |
クエリを発行したユーザーのプロファイルで優先表示言語として指定されている言語です。 |
| {User.<property>} |
クエリを発行したユーザーのユーザー プロファイルに含まれるプロパティです (例: SPS-Interests)。カスタム プロパティを含みます。 |
| {User.Audiences} (SharePoint のみ) |
管理プロパティ ModernAudienceAadObjectIdsの最新の SharePoint 対象ユーザーターゲット フィルターで使用されます。 例: 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+/- <日数の整数値>} |
クエリが発行された日付と指定した値の加算または減算によって計算された日付です。 日付の形式は YYYY-MM-DD です。 たとえば、この値を使用して管理プロパティ LastModifiedTime の内容をクエリできます。 |
| {SearchBoxQuery} |
ページの検索ボックスに入力されたクエリ値です。 |
| {CurrentDisplayLanguage} |
ll-cc 形式の MUI に基づく現在の表示言語です。 |
| {CurrentDisplayLCID} |
ll-cc 形式の MUI に基づく現在の表示言語の数値です。 |
値での空白の取り扱い
検索クエリでは、ユーザーによって入力されたクエリ値をトークン化するために空白文字を使用します。 クエリ変数が空白を含む値に展開されると、値全体が二重引用符で囲まれます。 たとえば、クエリ author:{User} の場合、展開された値は author:"John Smith" になります。
値を二重引用符で囲みたくない場合は (複数の値を連結する場合など)、クエリ変数でエスケープ文字列を使用できます。 たとえば、customProperty:"{\User.Name};{\User.ZipCode}" は customProperty:"John Smith;98109" となります。
複数の値を含むクエリ変数
一部のクエリ変数は複数の値を返す場合があります。 複数の値を返すクエリ変数の場合は、{|ManagedProperty:{QueryVariable}} という構文を使用する必要があります。 すべてのクエリ変数値がビット単位の OR 演算子を使用して結合されます。 たとえば、ユーザーの興味の分類に使用する用語セットがあるものとします。 User Profile Service アプリケーションでは、複数値のプロパティ SPS-Interests を使用して、すべてのユーザーに 1 つ以上の興味が構成されます。 現在のユーザーの興味に対するクエリを発行するには、{|owstaxIdMetadataAllTagsInfo:{User.SPS-Interests}} という構文を使用できます。 現在のユーザーが 2 つの関心を持つよう構成されている場合 (#0f95d1fdf-781f-42f4-99f9-c656c1341b2e) とバスケットボール (#0c2cff933-9377-4692-aa98-ce59768aa38b) にクエリが変換されます (owstaxIdMetadataAllTagsInfo:#0f95d1fdf-781f-42f4-99f9-c656c1341b2e) OR (owstaxIdMetadataAllTagsInfo:#0c2cff933-9377-4692-aa98-ce59768aa38b) 。
複数の値を使用するときにはいくつかの制限があります。 複数の値には、OR 演算子 ({|) のみがサポートされています。 AND 演算子はサポートされていません。 また、複数値の場合には、管理メタデータ型の列のみが正しく動作します。 複数の値を使用できる他の型 (人、グループ、選択肢など) の列の場合、アイテムは区切り文字列に展開されます。