Set-SPEnterpriseSearchResultItemType

  • リファレンス
モジュール:
SharePointServer
適用対象:
SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

結果アイテムの種類のプロパティを設定します。

構文

Set-SPEnterpriseSearchResultItemType
   [-Identity] <ResultItemTypePipeBind>
   -Owner <SearchObjectOwner>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-DisplayProperties <String>]
   [-DisplayTemplateUrl <String>]
   [-Name <String>]
   [-OptimizeForFrequentUse <Boolean>]
   [-RulePriority <Int32>]
   [-Rules <PropertyRuleCollection>]
   [-SearchApplication <SearchServiceApplicationPipeBind>]
   [-SearchApplicationProxy <SearchServiceApplicationProxyPipeBind>]
   [-SourceID <Guid>]
   [-WhatIf]
   [<CommonParameters>]

説明

コマンドレットは Set-SPEnterpriseSearchResultItemType 、ユーザーが作成した結果項目の種類のプロパティを設定します。 このコマンドレットを使用して、SharePoint 製品に含まれる組み込みの結果項目の種類のプロパティを設定または変更することはできません。

結果項目の種類を使用すると、結果の種類に基づいて検索結果の外観を変更できます。 まず、結果のプロパティに対して評価されるルールのコレクションを定義します。 次に、その種類の結果のレンダリングに使用する表示テンプレートを定義します。 結果アイテムの種類を作成すると、結果アイテムの種類のルールに一致する結果は、指定した表示テンプレートを使用してレンダリングされます。

使用例:

  • Word 文書など、特定のファイル名拡張子の結果の外観を変更します。
  • 検索結果で特定のコンテンツ タイプの外観を変更します。
  • 特定の作成者からの結果の外観を変更します。
  • カスタム検索アプリケーションの一部として、結果の動作を特定の結果ソースからの結果に追加します。

Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンライン ドキュメントをご覧ください。

例

-------------------- 例 ---------------------

$web = Get-SPWeb https://webUrl
$tenantOwner = Get-SPEnterpriseSearchOwner -Level SPSite -SPWeb $web
$ssa = Get-SPEnterpriseSearchServiceApplication
$resultType = Get-SPEnterpriseSearchResultItemType -Owner $tenantOwner -SearchApplication $ssa
$resultType.BuiltIn
$rule = Get-SPEnterpriseSearchPropertyRule -PropertyName "ContentTypeId" -Operator "StartsWith"
$rule.AddValue('0x010063C2F478ACC511DFB869B5BFDFD720851252')
$ruleCollection = Get-SPEnterpriseSearchPropertyRuleCollection
$ruleCollection.Add($rule)
$displayProperties = "WorkId,Rank,Title,Size,Path,Description,SiteName,HitHighlightedSummary,HitHighlightedProperties,ViewsLifeTime"
$displaytemplateUrl = "~sitecollection/_catalogs/masterpage/Display Templates/Search/Item_MyCustomDisplayTemplate.js"
Set-SPEnterpriseSearchResultItemType 
-Identity $resultType `
-SearchApplication $ssa `
-Name "CustomResultType" `
-Rules $ruleCollection `
-RulePriority 1 
-DisplayProperties $displayProperties `
-DisplayTemplateUrl $displaytemplateUrl `
-Owner $tenantOwner

この例では、最初に、サイトの URL、検索所有者、および検索アプリケーションの変数を定義します。 結果アイテムの種類を取得して、結果アイテムの種類が内蔵の結果アイテムの種類であるか確認します。 $resultType.BuiltIn が false を返す場合、結果アイテムの種類は組み込まれていないので、 を使用してそのプロパティを Set-SPEnterpriseSearchResultItemType設定できます。

次に、この例では、結果項目の型が照合される規則を作成し、それをプロパティ ルール コレクションに追加します。

次に、結果アイテムの種類のどのプロパティを表示すべきか、どの表示テンプレートを使用するかを定義します。

最後に、この例では コマンドレットを Set-SPEnterpriseSearchResultItemType 使用して結果項目の種類を変更します。

パラメーター

-AssignmentCollection

適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。 メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。

Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。 Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。

Type:SPAssignmentCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Confirm

コマンドを実行する前に確認メッセージを表示します。 詳細については、次のコマンドを入力します。get-help about_commonparameters

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-DisplayProperties

表示する結果プロパティを指定します。

Type:String
Aliases:dp
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-DisplayTemplateUrl

結果のレンダリングに使用する、表示テンプレートの URL を指定します。

Type:String
Aliases:url
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Identity

更新する結果アイテムの種類を指定します。 この型は、12345678-90ab-cdef-1234-567890bcdefgh という形式の GUID であることが必要です。

Type:ResultItemTypePipeBind
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Name

結果アイテムの種類の名前を指定します。

Type:String
Aliases:n
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-OptimizeForFrequentUse

{{ Fill OptimizeForFrequentUse Description }}

Type:Boolean
Aliases:opt
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Owner

結果アイテムの種類が作成される範囲を定義する、検索オブジェクトの所有者を指定します。

Type:SearchObjectOwner
Aliases:o
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-RulePriority

ルールのコレクションが他のルールと比較した優先度を指定します。

Type:Int32
Aliases:priority
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Rules

結果プロパティの評価の基準にするルールのコレクションを指定します。

Type:PropertyRuleCollection
Aliases:rule
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-SearchApplication

検索アプリケーションの名前を指定します。 この型は、12345678-90ab-cdef-1234-567890bcdefgh という形式の有効な GUID であるか、検索アプリケーションの有効な名前 (SearchApp1 など) であるか、有効な SearchServiceApplication オブジェクトのインスタンスであることが必要です。

Type:SearchServiceApplicationPipeBind
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-SearchApplicationProxy

結果アイテムの種類を含む検索アプリケーションのプロキシを指定します。 この型は、12345678-90ab-cdef-1234-567890bcdefgh という形式の有効な GUID であるか、検索アプリケーションの有効なプロキシ名 (SearchAppProxy1 など) であるか、有効な SearchServiceApplicationProxy オブジェクトのインスタンスであることが必要です。

Type:SearchServiceApplicationProxyPipeBind
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-SourceID

結果アイテムの種類が適用される検索先を識別します。

Type:Guid
Aliases:sid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-WhatIf

コマンドを実行する代わりに、コマンドの実行結果を説明するメッセージを表示します。 詳細については、次のコマンドを入力します。get-help about_commonparameters

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019