メインコンテンツまでスキップ

副言語について

[環境設定] -> [ローカライズ]で多言語設定を有効にするとコンテンツに副言語の登録が可能です。
本ドキュメントでは副言語を登録した際の動作について説明します。

APIパラメータ

エンドポイントで利用できる副言語に関するパラメータは以下になります。

パラメータ説明
_langレスポンスするコンテンツの言語を指定します。

※システムのメッセージはja, enのみに対応しています。
※意図して設定されたバリデーションエラーを除くシステムのエラーメッセージ(スキーマエラー等)は英語になります。
filter_lang絞り込みに利用する言語を指定します。
_doc_langPOST系のエンドポイントで、POSTの対象となる言語を指定します。

コンテンツ定義

コンテンツ定義に対する副言語の設定は、以下のように影響します。

項目説明
全般-名前APIからのレスポンスで言語毎の値を取得できます。また、日本語・英語に設定した名前は管理画面の言語設定に連動して管理画面上での表示にも使用されます。
全般-説明APIからのレスポンスで言語毎の値を取得できます。
項目設定言語毎のコンテンツデータに適用され、管理画面上では言語のタブを切り替えることで表示が変わります。
選択形式の項目では言語毎にlabelを変更できますが、keyは共通になっている必要があります。
詳細設定管理画面の言語設定に連動して、管理画面上での表示・動作に影響します。日本語・英語以外の言語については設定しても動作しません。

コンテンツ

コンテンツに関する副言語データは、主言語のデータとセットで登録をする使い方を想定しています。
そのため、コンテンツ内の項目に繰り返しを利用した場合の並び順は、主言語が基準となり、主言語の並び順の変更が副言語にも反映されます。

また、APIのレスポンスは管理画面の表示・並び順と同一になります。

  1. 主言語の並び順を変更すると、それに対応して副言語の並び順も更新されます。
    管理画面:
    Image from Gyazo

    レスポンス:

      "ext_1": [
    "3",
    "1",
    "2"
    ]
  2. 副言語の繰り返し項目の一部にデータが登録されていない場合、主言語と同じ並び順に""のデータが返ります。
    管理画面:
    Image from Gyazo

    レスポンス:

      "ext_1": [
    "1",
    "2",
    "3"
    ]
  3. 繰り返し項目のうち、主言語・副言語で共にデータがない順番の項目はAPIからレスポンスされません。
    管理画面:
    Image from Gyazo

    レスポンス:

      "ext_1": [
    "2",
    "3"
    ]
  4. 主言語にデータが登録されていない繰り返し順で、副言語にデータが登録されている場合、該当の項目は主言語と副言語のセットから外れ、主言語に対する追加項目として扱われます。
    そのため、主言語に登録が無いデータは副言語の並び順の最後に移動します。
    管理画面:
    Image from Gyazo

    レスポンス:

      "ext_1": [
    "2",
    "3"
    ]

制限事項

主言語にしか設定できない項目

Slugや関連情報など、いくつかの項目はコンテンツに対しての設定となるため、主言語からしか設定できず、 APIから副言語のコンテンツを取得した場合、主言語と同じ情報がレスポンスされます。

主言語のみにデータを持つ項目は以下になります。

  • topics_id
  • ymd
  • contents_type
  • contents_type_cnt
  • topics_flg
  • regular_flg
  • inst_ymdhi
  • update_ymdhi
  • topics_group_id
  • post_time
  • member_id
  • Slug
  • order_no
  • カウンター
  • 関連情報選択
  • タグ(tag_nm, ext_col_XX は言語設定に連動)
  • お気に入り
  • コメント

これらの項目を主言語と副言語で別々に設定したい場合は、主言語の拡張項目に設定して利用します。

例えば副言語の更新日時を主言語と別に設定したい場合は、 日付フォーマットの項目を作成し、更新日時(EN)などを設定します。

ヒント

特定の項目を自動で入力されるようにするには、コンテンツの更新前のトリガーやカスタムテンプレートを組み合わせて設定してください。

並び替え

パフォーマンス維持のため、Orderクエリによる並び替えは主言語でしか実行できません。 主言語と副言語で並び順を変えたい場合は、並び替えに使いたいデータを主言語の拡張項目に設定します。

例:
・並び順
・並び順(EN)

関連ドキュメント


サポート

お探しのページは見つかりましたか?解決しない場合は、問い合わせフォームからお問い合わせいただくか、Slackコミュニティにご参加ください。