Skip to content

Latest commit

History

History
30 lines (26 loc) · 2.88 KB

File metadata and controls

30 lines (26 loc) · 2.88 KB

KeyCreateParameters

Properties

NameTypeDescriptionNotes
branchstrspecify the branch to use[optional]
namestrKey name
descriptionstrKey description (usually includes contextual information for translators)[optional]
pluralboolIndicates whether key supports pluralization[optional]
use_ordinal_rulesboolIndicates whether key uses ordinal rules for pluralization[optional]
name_pluralstrPlural name for the key (used in some file formats, e.g. Gettext)[optional]
data_typestrType of the key. Can be one of the following: string, number, boolean, array, markdown.[optional]
tagsstrList of tags separated by comma to be associated with the key.[optional]
max_characters_allowedintMax. number of characters translations for this key can have.[optional]
screenshotbytearrayScreenshot/image for the key. This parameter is deprecated. Please use the Screenshots endpoint instead.[optional]
remove_screenshotboolIndicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead.[optional]
unformattedboolIndicates whether the key should be exported as "unformatted". Supported by Android XML and other formats.[optional]
default_translation_contentstrCreates a translation in the default locale with the specified content[optional]
autotranslateboolIndicates whether the key should be autotranslated to other locales based on the copy provided in `default_translation_content`.[optional]
xml_space_preserveboolIndicates whether the key should be exported with "xml:space=preserve". Supported by several XML-based formats.[optional]
original_filestrOriginal file attribute. Used in some formats, e.g. XLIFF.[optional]
localized_format_stringstrNSStringLocalizedFormatKey attribute. Used in .stringsdict format.[optional]
localized_format_keystrNSStringLocalizedFormatKey attribute. Used in .stringsdict format.[optional]
custom_metadataobjectCustom metadata property name and value pairs to be associated with key.[optional]
excluded_in_localesList[str]Locales for which translations of this key are excluded from exports. Pass an empty array to clear exclusions.[optional]
format_value_typestrOverride of the value type for the key in the export. Most useful for formats like Android XML that distinguish string vs. plural resources.[optional]

[Back to Model list][Back to API list][Back to README]