ManagedTopics | メタデータ API 開発者ガイド

関連する Experience Cloud サイトが、管理トピックをリリースする前に存在する必要があります。(これは組織全体をリリースするときに自動的に発生します)。

メモ

ファイルのサフィックスおよびディレクトリの場所

コンポーネントのサフィックスは managedTopics で、managedTopics フォルダーに保存されます。このフォルダー内に、Experience Cloud サイトごとの個別のファイルが保存されています (SiteNameA.managedTopics や SiteNameB.managedTopics など)。

バージョン

ManagedTopics コンポーネントは、API バージョン 32.0 以降で使用できます。

項目

項目名	項目の型	説明
ManagedTopic	ManagedTopic	特定のナビゲーショントピックや主要トピックを表します。

ManagedTopic

項目名	項目の型	説明
name	string	トピック名です。
managedTopicType	string	トピックの種別です (「ナビゲーション」または「主要」)。
topicDescription	string	トピックのコンテンツの説明です (省略可能)。この項目は API を介してのみアクセスできます。ユーザーインターフェースには付随する機能がありません。
parentName	string	このトピックを子とする親トピックの名前。子トピックは親トピックページのサブトピックセクションからアクセスでき、そのフィードは親トピックフィードに追加されます。親-子リレーションがサポートされるのはナビゲーショントピックのみです。
position	int	このトピックの配置は同じ種別の他のトピックと関係します。結果は、トピックの種別によって異なります。最上位のナビゲーショントピックでは、position によって Experience Cloud サイトでの [トピック] メニューが並べ替えられます。子ナビゲーショントピックでは、サブトピックセクションでの同階層トピックが並べ替えられます。主要トピックでは、Experience Cloud サイトホームページでのトピックのサムネイル画像が並べ替えられます。 0 から 24 までの数字を入力します (ナビゲーショントピックまたは主要トピックの最大数は 25 です)。

宣言的なメタデータの定義のサンプル

次の例は、すべてのサイトの管理トピックを取得またはリリースします。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>ManagedTopics</name>
6    </types>
7    <version>32.0</version>
8</Package>

次の例は、ManagedTopics コンポーネントを参照する package.xml ファイルを示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>SiteName</members>
5        <name>ManagedTopics</name>
6    </types>
7    <version>32.0</version>
8</Package>

次の例は、ManagedTopics コンポーネント自体を示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<ManagedTopics>
3    <ManagedTopic>
4        <name>Running</name>
5        <managedTopicType>Navigational</managedTopicType>
6        <topicDescription>Training advice</topicDescription>
7        <parentName></parentName>
8        <position>0</position>
9    </ManagedTopic>
10    <ManagedTopic>
11        <name>Hiking</name>
12        <managedTopicType>Navigational</managedTopicType>
13        <topicDescription>Routes and gear</topicDescription>
14        <parentName></parentName>
15        <position>1</position>
16    </ManagedTopic>
17        <ManagedTopic>
18            <name>Trails</name>
19            <managedTopicType>Navigational</managedTopicType>
20            <topicDescription>Maps for local favorites</topicDescription>
21            <parentName>Hiking</parentName>
22            <position>0</position>
23        </ManagedTopic>
24        <ManagedTopic>
25            <name>Backpacks</name>
26            <managedTopicType>Navigational</managedTopicType>
27            <topicDescription>Recommended models</topicDescription>
28            <parentName>Hiking</parentName>
29            <position>1</position>
30        </ManagedTopic>
31    <ManagedTopic>
32        <name>Footwear</name>
33        <managedTopicType>Featured</managedTopicType>
34        <topicDescription>Suggested types for each sport</topicDescription>
35        <parentName></parentName>
36        <position>0</position>
37    </ManagedTopic>
38    <ManagedTopic>
39        <name>Conditioning</name>
40        <managedTopicType>Featured</managedTopicType>
41        <topicDescription>How to get fit for any activity</topicDescription>
42        <parentName></parentName>
43        <position>1</position>
44    </ManagedTopic>
45</ManagedTopics>

使用方法

API バージョン 50.0 以降でアップロードされた管理トピックの画像は、アセットファイルとして保存されます。API バージョン 50.0 以降でアップロードされた管理トピックの画像を移行するには、ContentAsset メタデータ型を使用します。API バージョン 49.0 以前でアップロードされた管理トピックの画像を移行するには、Document メタデータ型を使用します。

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。