|
Расширения файлов |
.json |
|
Расширение API |
strings_json |
|
Импорт |
Да |
|
Экспорт |
Да |
|
Поддержка форм множественного числа |
Да |
|
Поддержка описания |
Да |
|
Поддержка состояния |
Да |
|
Поддержка метаданных |
Да |
|
Варианты формата |
ignore_translation_state export_translation_state export_description export_tags export_system_tags export_max_characters_allowed custom_metadata_columns export_use_ordinal_rules |
Формат JSON для Phrase Strings предоставляет структурированный способ хранения и управления переводами, включая метаданные, отслеживание состояния и интеграцию с рабочими процессами для улучшения функциональности.
Этот формат включает метаданные, такие как сведения о локализации, ограничения на количество символов, описания, тип множественного числа и состояния перевода. Функция поддержки состояния позволяет лучше отслеживать ход выполнения перевода и интеграцию с автоматизированными рабочими процессами.
Объект ключ
Объект ключа содержит метаданные и настройки для каждого ключа перевода.
|
Поле |
Обязательно |
Тип |
Описание |
|---|---|---|---|
|
|
Да |
Строка |
Уникальный идентификатор ключа. |
|
|
Нет |
Строка |
Краткое пояснение назначения ключа. |
|
|
Нет |
Булевский тип данных |
Указывает, поддерживает ли ключ множественное число. |
|
|
Нет |
Булевский тип данных |
Указывает, являются ли ключевые формы порядковыми. По умолчанию Используется при импорте и экспорте. |
|
|
Нет |
Целое число/Null |
Максимально допустимое количество символов. |
|
|
Нет |
Множество |
Категоризация теги для фильтрации и организации. |
|
|
Нет |
Объект |
Хранит дополнительные метаданные в виде пар ключ-значение. Их можно добавить или обновить, но нельзя удалить. Чтобы удалить метаданные, установите для их значения пустую строку. |
Объект переводов
Объект переводов содержит локализованные переводы для заданного ключа.
|
Поле |
Обязательно |
Тип |
Описание |
|---|---|---|---|
|
|
Да |
Строка |
Название или идентификатор языкового стандарта, как настроено в . Это значение определяет совпадение при импорте. Если оно не совпадает в точности с существующим названием языка, перевод не будет импортирован. |
|
|
Нет |
Строка |
Языковый код языкового стандарта (например, en-US, fr-FR). |
|
|
Да |
Строка/Объект |
Переведённое содержимое. Если используется множественное число, объект, сопоставляющий формы множественного числа на основе настройки |
|
|
Нет |
Строка |
Состояние перевода. Поддерживаемые состояния перевода:
|
Параметры формата
|
Идентификатор |
ignore_translation_state |
|
Тип |
булевский |
|
Загрузить |
Да |
|
Скачать |
Нет |
|
По умолчанию |
false |
|
Описание |
Если true, игнорирует значения состояния в импортированных переводах, что означает, что загруженный файл не перезапишет существующие состояния перевода. |
|
Идентификатор |
export_translation_state |
|
Тип |
булевский |
|
Загрузить |
Нет |
|
Скачать |
Да |
|
По умолчанию |
true |
|
Описание |
Включает значения состояния в экспортированные переводы; если установлено значение false, информация о состоянии будет опущена из экспортированного файла. |
|
Идентификатор |
export_system_tags |
|
Тип |
булевский |
|
Загрузить |
Нет |
|
Скачать |
Да |
|
По умолчанию |
false |
|
Описание |
Если true, экспортирует системные теги вместе с ключами и переводами. |
|
Идентификатор |
export_tags |
|
Тип |
булевский |
|
Загрузить |
Нет |
|
Скачать |
Да |
|
По умолчанию |
false |
|
Описание |
Если true, экспортирует теги вместе с ключами и переводами. |
|
Идентификатор |
export_description |
|
Тип |
булевский |
|
Загрузить |
Нет |
|
Скачать |
Да |
|
По умолчанию |
true |
|
Описание |
Экспорт описания ключа. |
|
Идентификатор |
export_max_characters_allowed |
|
Тип |
булевский |
|
Загрузить |
Нет |
|
Скачать |
Да |
|
По умолчанию |
true |
|
Описание |
Экспорт ограничения на количество символов ключа вместе с ключами и переводами. |
|
Идентификатор |
custom_metadata_columns |
|
Тип |
hash |
|
Загрузить |
Нет |
|
Скачать |
Да |
|
По умолчанию |
[empty] |
|
Описание |
HashMap значений пользовательских метаданных, которые необходимо импортировать или экспортировать:
|
|
Идентификатор |
export_use_ordinal_rules |
|
Тип |
булевский |
|
Загрузить |
Нет |
|
Скачать |
Да |
|
По умолчанию |
false |
|
Описание |
Если true, поле При скачивании файлов через интерфейс используйте соответствующую опцию . |
Образец кода
{
"welcome_message": {
"key": {
"description": "Сообщение, отображаемое на экране приветствия",
"plural": false,
"max_characters_allowed": 100,
"tags": ["UI", "greeting"],
"metadata": {
"created_by": "admin",
"created_at": "2024-06-20T12:34:56Z"
}
},
"translations": [
{
"locale": "английский (США)",
"locale_code": "en-US",
"content": "Добро пожаловать в наше приложение!",
"state": "проверено"
},
{
"locale": "Французский (Франция)",
"locale_code": "fr-FR",
"content": "Bienvenue dans notre application !",
"state": "переведено"
}
]
}
}
В этом формате используются именованные категории для идентификации различных множественных чисел ключа. Следующие категории зарезервированы для форм множественного числа:
.zero | .one | .two | .few | .many | .other
Примеры имен для правильно идентифицированных, постоянных и помеченных ключей с множественным числом:
-
inbox.messages.notification.one
-
inbox.messages.notification.other
Использование правил образования множественного числа конфигурируется через поле use_ordinal_rules. Если use_ordinal_rules равно false или не задано, будут применяться кардинальные правила образования множественного числа.
Пример ввода
{
"rank": {
"use_ordinal_rules": true,
"values": {
"one": "1-е место",
"two": "2-е место",
"few": "3-е место",
"other": "%d-е место"
}
}