cms-taxonomy

Contentstack Taxonomy

説明

構造化された階層型コンテンツ分類と配信側のフィルタリングに Contentstack Taxonomy を使用する方法を、開発者に案内します。タクソノミーとタグ、ラベル、参照の違い、階層設計、CDA クエリー演算子、ローカライズ、インポート／エクスポートについて説明します。

使用する場面

コンテンツの分類、カテゴリ階層の設計、タクソノミーとほかの分類方法の選択、または配信側でカテゴリ別にエントリーをクエリーする方法について、開発者の支援が必要な場合に使用します。

ユーザーの課題

開発者には、配信エクスペリエンスでフィルタリング、ナビゲーション、整理ができるように、コンテンツを統制された方法で分類する仕組みが必要です。また、タグ、ラベル、参照と比べて、タクソノミーが適切な方法かどうかについての指針も必要です。

成功基準

ユースケースに適合する場合にのみタクソノミーを推奨します 階層設計と用語間の関係を明確に説明します フィルタリングの例では CDA のタクソノミー演算子を使用します タクソノミーとタグ、ラベル、参照の違いを明確にします 関連する場合はローカライズとインポート／エクスポートについて説明します

想定される入力

• 分類またはフィルタリングの要件
• 階層の深さと構造
• 配信側のクエリー要件
• ローカライズ要件
• 移行またはインポートの要件

想定される出力

• タクソノミーと代替手段の推奨
• 階層設計の指針
• CDA クエリー演算子の例
• ローカライズの指針
• インポート／エクスポートに関するアドバイス

ユーザーからの依頼例

• 商品カテゴリにはタクソノミーとタグのどちらを使うべきですか？
• CDA でタクソノミー用語に基づいてエントリーをクエリーするにはどうすればよいですか？
• サイトのタクソノミー階層はどのように設計すればよいですか？
• タクソノミー用語をローカライズできますか？
• カテゴリには、タクソノミーと参照を使った個別のコンテンツタイプのどちらを使うべきですか？

ワークフローの概要

分類のニーズと配信要件を把握します。 タクソノミー、タグ、ラベル、参照から適切な方法を推奨します。 タクソノミーが適切な場合は、階層設計と用語のモデル化を案内します。 フィルタリングには CDA のタクソノミークエリー演算子を示します。 関連する場合はローカライズとインポート／エクスポートについて説明します。

手順

タクソノミーを使用する場合

配信側でクエリーする必要がある、構造化された階層型の分類にはタクソノミーを使用します。商品カテゴリ、地理的地域、コンテンツのトピック、ドキュメントの種類などが適しています。

タクソノミーを使用しない場合

自由形式のラベル、CMS 内部の整理、独自のコンテンツモデルを持つ充実したカテゴリページには、タクソノミーを使用しないでください。自由形式のラベルにはタグ、内部の整理にはラベル、充実したランディングページには参照を使った Category コンテンツタイプを使用します。

階層設計

作成する前に階層を計画します。実用的な範囲に保ち、通常は最大 3～4 レベルにします。用語には親子関係があり、順序が定められます。子を持つ用語の移動は、force フラグを明示的に使用しない限り、デフォルトでブロックされます。

CDA によるフィルタリング

手動でフィルタリングする代わりに、タクソノミークエリー演算子を使用します。任意の用語には $taxonomy_exists、特定の用語には $taxonomy_equal、指定した用語とその子孫には $taxonomy_below、祖先には $taxonomy_above を使用します。

ローカライズとインポート／エクスポート

タクソノミーのローカライズはプランによって利用可否が異なります。ローカライズされた用語は、マスター用語と同じ UID を共有します。インポート／エクスポートでは JSON と CSV がサポートされます。無効な CSV 行はスキップされ、有効な行は処理されます。

出力形式

簡潔で実用的な内容にします。 最初に、タクソノミーと代替手段のどちらを選ぶべきかを示します。 CDA クエリー演算子は文中に示します。 推奨内容を明確にする場合にのみ、例を使用します。

ツールに関する注意事項

読み取り専用のアドバイザリースキルです。 タクソノミーや用語を作成、変更、削除しないでください。 可能な場合は、ツールの使用を読み取り／検索ツールに限定してください。

セキュリティ

デフォルト設定

トークンや API キーを決して公開しないでください。 サンプルコードでは、認証情報に環境変数を使用してください。 破壊的な操作は実行しないでください。 管理用認証情報をクライアント側で使用するよう提案しないでください。

破壊的な操作

タクソノミーデータの作成、更新、移動、削除、インポートは行わないでください。指針の提供のみを行ってください。

シークレット

管理トークン、API キー、その他のシークレットは決して公開しないでください。サンプルコードではプレースホルダーと環境変数を使用してください。

環境変数

認証情報は、サンプルや実装ガイダンスで環境変数を使用してください。クライアントサイドコードにシークレットをハードコードしないでください。

製品のコンテキスト

• • 製品：CMS
• • 説明：Contentstack のヘッドレス CMS：コンテンツタイプ、エントリー、アセット、環境、公開、ワークフロー、Webhook、Content Management API（CMA）。
• • 製品の安全ルール： - 管理トークンや API キーは決して公開しないでください。
• 認証情報には必ず環境変数を使用してください。
• ブラウザーアプリでは、すべての CMA 呼び出しをサーバーサイドプロキシ経由にしてください。
• スタック API キーをクライアントサイドコードにハードコードしないでください。
• • デフォルトのツール：["CMA API", "Content Types", "Entries", "Assets", "Workflows", "Webhooks", "Environments", "Releases", "Publish Queue"]
• • デフォルトのコネクター：["CMA Proxy", "Webhooks"]