Managed Topics

コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユーザ) のみが、管理トピックの作成または並び替えを行うことができます。

リソース

使用可能なバージョン

32.0

Chatter が必要かどうか

いいえ

HTTP メソッド

GET、POST、PATCH、HEAD

GET の要求パラメータ

パラメータ名	型	説明	必須項目/省略可能	使用可能なバージョン
depth	Integer	整数 1 ～ 3 を指定します。1 を指定すると、Managed Topic レスポンスボディの children プロパティは null になります。2 を指定すると、Managed Topic レスポンスボディの children プロパティには管理トピックの直接の子である管理トピック (存在する場合) が含まれます。3 を指定すると、直接の子である管理トピックとその子管理トピック (存在する場合) が取得されます。depth が指定されていない場合、デフォルトは 1 です。	省略可能	35.0
managedTopic​Type	String	管理トピックの種別。 Featured — コミュニティホームページなどの主要トピック。ただし、全体的なナビゲーションは提供しません。 Navigational — コミュニティのナビゲーションメニューに表示されるトピック。 1 つのトピックは最大 2 つの種別の管理トピックに関連付けることができるため、1 つのトピックを Featured トピックと Navigational トピックの両方にすることができます。	省略可能 recordId または depth を指定する場合は必須	32.0
recordId	String	管理トピックに関連付けられたトピックの ID。	省略可能	35.0

GET のレスポンスボディ

Managed Topic Collection

POST のリクエストボディ

ルート XML タグ

<managedTopic>

JSON の例

プロパティ

名前	型	説明	必須項目/省略可能	使用可能なバージョン
managedTopic​Type	String	管理トピックの種別。 Featured — コミュニティホームページなどの主要トピック。ただし、全体的なナビゲーションは提供しません。 Navigational — コミュニティのナビゲーションメニューに表示されるトピック。 1 つのトピックは最大 2 つの種別の管理トピックに関連付けることができるため、1 つのトピックを Featured トピックと Navigational トピックの両方にすることができます。 managedTopicType につき、最大 25 個の管理トピックを作成できます。 子管理トピックを作成するには、managedTopicType として Navigational を指定し、parentId を指定します。	必須項目	32.0
name	String	管理トピックの名前。	新規トピックでは必須 name または recordId を指定する必要があります。両方を指定することはできません。	32.0
parentId	String	親管理トピックの ID。 parentId を指定する場合は、managedTopicType として Navigational も指定する必要があります。 最大 3 レベル (親、直接の子、その子) の管理トピックを作成でき、管理トピックにつき最大 10 個の子管理トピックを作成できます。	省略可能	35.0
recordId	String	管理トピックになるレコードの ID。 バージョン 32.0 では、recordId はトピック ID である必要があります。	Name プロパティが使用されていない場合、既存のトピックに必要です。 name または recordId を指定する必要があります。両方を指定することはできません。	32.0

POST の要求パラメータ

パラメータ名	型	説明	必須項目/省略可能	使用可能なバージョン
managedTopic​Type	String	管理トピックの種別。 Featured — コミュニティホームページなどの主要トピック。ただし、全体的なナビゲーションは提供しません。 Navigational — コミュニティのナビゲーションメニューに表示されるトピック。 1 つのトピックは最大 2 つの種別の管理トピックに関連付けることができるため、1 つのトピックを Featured トピックと Navigational トピックの両方にすることができます。 managedTopicType につき、最大 25 個の管理トピックを作成できます。 子管理トピックを作成するには、managedTopicType として Navigational を指定し、parentId を指定します。	必須項目	32.0
name	String	管理トピックの名前。	新規トピックでは必須 name または recordId を指定する必要があります。両方を指定することはできません。	32.0
parentId	String	親管理トピックの ID。 parentId を指定する場合は、managedTopicType として Navigational も指定する必要があります。 最大 3 レベル (親、直接の子、その子) の管理トピックを作成でき、管理トピックにつき最大 10 個の子管理トピックを作成できます。	省略可能	35.0
recordId	String	管理トピックになるレコードの ID。 バージョン 32.0 では、recordId はトピック ID である必要があります。	Name プロパティが使用されていない場合は必須 name または recordId を指定する必要があります。両方を指定することはできません。	32.0

POST のレスポンスボディ

Managed Topic

PATCH のリクエストボディ

ルート XML タグ

<managedTopicPositionCollection>

JSON の例

プロパティ

名前	型	説明	必須項目/省略可能	使用可能なバージョン
managedTopic​Positions	Managed Topic Position Input[]	Managed Topic Position リクエストボディのコレクション。このコレクションには、Featured および Navigational 管理トピックを含めることができます。また、すべての管理トピックを含める必要はありません。 managedTopicPositions にすべての管理トピックを含めない場合、管理トピックは managedTopicPositions で指示された位置に従って並び替えられ、managedTopicPositions に含まれない管理トピックは次に空いている位置まで順序を下げられます。「管理トピックの並び替えの例」を参照してください。	必須項目	32.0

管理トピックの並び替えの例

次の管理トピックがあるとします。

管理トピック	位置
ManagedTopicA	0
ManagedTopicB	1
ManagedTopicC	2
ManagedTopicD	3
ManagedTopicE	4

Managed Topic Position Collection Input に次の情報を含めて管理トピックを並び替えます。

管理トピック	位置
ManagedTopicD	0
ManagedTopicE	2

結果は次のとおりです。

管理トピック	位置
ManagedTopicD	0
ManagedTopicA	1
ManagedTopicE	2
ManagedTopicB	3
ManagedTopicC	4

PATCH のレスポンスボディ

Managed Topic Collection