Translations

This type extends the Metadata metadata type and inherits its fullName field.

Language

A two-character language code identifies each language, such as en. A five-character code is used for languages that differ depending on location. For example, en_AU.

Salesforce offers full support for these languages.

• Chinese (Simplified): zh_CN
• Chinese (Traditional): zh_TW
• Danish: da
• Dutch: nl_NL
• English: en_US
• Finnish: fi
• French: fr
• German: de
• Italian: it
• Japanese: ja
• Korean: ko
• Norwegian: no
• Portuguese (Brazil): pt_BR
• Russian: ru
• Spanish: es
• Spanish (Mexico): es_MX Spanish (Mexico) defaults to Spanish for customer-defined translations.
• Swedish: sv
• Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English.

End-user languages are useful if you have a multilingual organization or partners who speak languages other than your company’s default language. For end-user languages, Salesforce provides translated labels for standard objects and pages, except admin pages, Setup, and Help. Some clouds and features support a subset of these languages in the UI. For details, see User Interface Language Support in Salesforce Help. When you select an end-user language, labels that aren’t translated and Salesforce Help appear in English. End-user languages are intended only for personal use by end users. Don’t use end-user languages as corporate languages. Salesforce doesn’t provide customer support in end-user languages.

End-user languages include:

• Arabic: ar
• Bulgarian: bg
• Croatian: hr
• Czech: cs
• English (UK): en_GB
• Greek: el
• Hebrew: iw
• Hungarian: hu
• Indonesian: in
• Polish: pl
• Portuguese (European): pt_PT
• Romanian: ro
• Slovak: sk
• Slovenian: sl
• Turkish: tr
• Ukrainian: uk
• Vietnamese: vi

In situations where Salesforce doesn’t provide default translations, use platform-only languages to localize apps and custom functionality that you build on the Salesforce Platform. You can translate items such as custom labels, custom objects, and field names. You can also rename most standard objects, labels, and fields. Informational text and non-field label text aren’t translatable.

Declarative Metadata File Suffix and Directory Location

Local translations are stored in a file with a format of localeCode.translation, where localeCode is the locale code of the translation language. For example, the file name for German translations is de.translation. Packaged translations are stored in a file with a format of pkgNamespace_ _localeCode.translation. For example, if the package namespace is Acme, the file name for German translations installed by the package is Acme_ _de.translation. The supported locale codes are listed in Language.

Custom object translations are stored in the objectTranslations folder in the corresponding package directory.

Version

Translations components are available in API version 14.0 and later.

Fields

BotTranslation

BotTranslation contains details for a translation of a bot. Available in API version 53.0 and later.

BotVersionTranslation

BotVersionTranslation contains details for a translation of a bot version. Available in API version 53.0 and later.

BotDialogTranslation

BotDialogTranslation contains details for a translation of a bot dialog. Available in API version 53.0 and later.

BotStepTranslation

BotStepTranslation contains details for a translation of a bot step. Available in API version 53.0 and later.

BotMessageTranslation

BotMessageTranslation contains details for a translation of a bot message step. Available in API version 53.0 and later.

BotVariableOperationTranslation

BotVariableOperationTranslation contains details for a translation of a bot variable operation (question) step. Available in API version 53.0 and later.

BotQuickReplyOptionTranslation

BotQuickReplyOptionTranslation contains details for a translation of a bot quick reply option within a bot variable operation (question) step. Available in API version 53.0 and later.

CustomApplicationTranslation

CustomApplicationTranslation contains details for a custom application translation. For more details, see CustomApplication.

CustomLabelTranslation

CustomLabelTranslation contains details for a custom label translation. For more details, see CustomLabels.

CustomPageWebLinkTranslation

CustomPageWebLinkTranslation contains details for a translation of a web link defined in a home page component. For more details, see CustomPageWebLink.

CustomTabTranslation

CustomTabTranslation contains details for a translation of a custom tab. For more details, see CustomTab.

ExplainabilityMsgTemplateFieldTranslation

Represents the template that contains the decision explanation message for a specified step element type.

Declarative Metadata Sample Definition

This is an example of an ExplainabilityMsgTemplateFieldTranslation component.

1<?xml version="1.0" encoding="UTF-8"?>
2<Translations xmlns="http://soap.sforce.com/2006/04/metadata">
3    <desFieldTemplateMessages>
4        <description>Calc Blitz Message</description>
5        <label>CALBLITZ</label>
6        <name>CALBLITZ</name>
7        <templateMessage>CALBLITZ</templateMessage>
8    </desFieldTemplateMessages>
9</Translations>

FlowDefinitionTranslation

FlowDefinitionTranslation contains details for a translation of a flow definition. For more details, see FlowDefinition.

Available in API version 41.0 and later.

FlowTranslation

FlowTranslation contains details for a translation of a flow version. For more details, see Flow.

Available in API version 41.0 and later.

FlowChoiceTranslation

FlowChoiceTranslation contains details for a translation of a choice in a flow version. For more details, see FlowChoice in Flow.

Available in API version 41.0 and later.

FlowChoiceUserInputTranslation

FlowChoiceUserInputTranslation contains details for a translation of a choice input. For more details, see FlowChoiceUserInput in Flow.

Available in API version 41.0 and later.

FlowInputValidationRuleTranslation

FlowInputValidationRuleTranslation contains details for a translation of a validation rule. For more details, see FlowInputValidationRule in Flow.

Available in API version 41.0 and later.

FlowOrchestrationStepTranslation

FlowOrchestrationStepTranslation contains details for a translation of an orchestration step in an orchestration version. For more details, see FlowStageStep in Flow.

Available in API version 63.0 and later.

FlowScreenTranslation

FlowScreenTranslation contains details for a translation of a screen. For more details, see FlowScreen in Flow.

Available in API version 41.0 and later.

FlowScreenFieldTranslation

FlowScreenFieldTranslation contains details for a translation of a screen component. For more details, see FlowScreenField in Flow.

Available in API version 41.0 and later.

FlowInputParameterTranslation

FlowInputParameterTranslation is reserved for internal use.

FlowFerovTranslation

FlowFerovTranslation is reserved for internal use.

FlowComplexLiteralTranslation

FlowComplexLiteralTranslation is reserved for internal use.

FlowStageTranslation

FlowStageTranslation contains details for a translation of a stage in a flow version. For more details, see FlowStage in Flow.

Available in API version 43.0 and later.

FlowTextTemplateTranslation

FlowTextTemplateTranslation is available only in flows created via Salesforce Surveys and represents the translation details for the text on all the pages of a survey.

Available in API version 45.0 and later.

IdentityVerificationFieldTranslation

Translates the UI components associated with identity verification fields.

Available in API version 54.0 and later.

Declarative Metadata Sample Definition

This is an example of an IdentityVerificationFieldTranslation component.

1<?xml version="1.0" encoding="UTF-8"?>
2<Translations
3    xmlns="http://soap.sforce.com/2006/04/metadata">
4    <identityVerificationCustomFieldLabels>
5        <description>Telefono Numero</description>
6        <label>Telefono Numero</label>
7        <name>Sample93Phone</name>
8    </identityVerificationCustomFieldLabels>
9    <identityVerificationCustomFieldLabels>
10        <description>Nombre de la Cuenta</description>
11        <label>Nombre de la Cuenta</label>
12        <name>Sample93Account</name>
13    </identityVerificationCustomFieldLabels>
14    <identityVerificationCustomFieldLabels>
15        <name>Sample93PostalCode</name>
16    </identityVerificationCustomFieldLabels>
17    <identityVerificationCustomFieldLabels>
18        <name>Sample93AccountName</name>
19        <description>Nombre</description>
20        <label>Nombre</label>
21    </identityVerificationCustomFieldLabels>
22</Translations>

GlobalPicklistTranslation

GlobalPicklistTranslation contains details for a global picklist translation.

Translations are stored in a file with a format of globalPicklistName__e-lang.objectTranslation, where globalPicklistName__e is the global picklist name and lang is the translation language. To reference a global picklist translation value, use globalPicklistName__e.value1, where value1 is the translated value for the user interface.

Here’s what translations look like for a global picklist.

1<?xml version="1.0" encoding="UTF-8"?>
2<Translations xmlns="http://soap.sforce.com/2006/04/metadata">
3<globalPicklists>
4    <name>transpicklist</name>
5    <picklistValues>
6        <masterLabel>Three</masterLabel>
7        <translation>Trois</translation>
8    </picklistValues>
9    <picklistValues>
10        <masterLabel>Four</masterLabel>
11        <translation>Quatre</translation>
12    </picklistValues>
13</globalPicklists>
14</Translations>

GlobalQuickActionTranslation

GlobalQuickActionTranslation contains details for the global translation of a quick action. For more information, see QuickAction.

PipelineInspMetricConfigTranslation

PromptTranslation

PromptTranslation contains metadata for the translation of a prompt, which is part of In-App Guidance. Available in API Version 48.0 and later.

PromptVersionTranslation

PromptVersionTranslation contains details for translation of a prompt, which is part of In-App Guidance. Available in API Version 48.0 and later.

ReportTypeTranslation

ReportTypeTranslation contains details for a translation of a custom report type. For more details, see ReportType.

ReportTypeSectionTranslation

ReportTypeSectionTranslation contains details for a report type section translation.

ReportTypeColumnTranslation

ReportTypeColumnTranslation contains details for a report type column translation.

ScontrolTranslation

Declarative Metadata Sample Definition

This sample XML definition shows a translations component.

1<?xml version="1.0" encoding="UTF-8"?>
2<Translations xmlns="http://soap.sforce.com/2006/04/metadata">
3    <customApplications>
4    <label>Angebot-Manager</label>
5        <name>Quote Manager</name>
6    </customApplications>
7    <customLabels>
8    <label>Dieses ist ein manuelles Angebot</label>
9        <name>quoteManual</name>
10    </customLabels>
11</Translations>

Usage

When you use the retrieve() call to get translations, the files returned in the .translations folder only include translations for the other metadata types referenced in package.xml. For example, this package.xml file contains types elements that match all custom applications, custom labels, web links defined in home page components, custom tabs, report types, and s-controls. Translations for all these metadata types are returned because each metadata type is explicitly listed in package.xml.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4       <members>*</members>
5       <name>CustomApplication</name>
6    </types>
7    <types>
8       <members>*</members>
9       <name>CustomLabels</name>
10    </types>
11    <types>
12       <members>*</members>
13       <name>CustomPageWebLink</name>
14    </types>
15    <types>
16       <members>*</members>
17       <name>CustomTab</name>
18    </types>
19    <types>
20       <members>*</members>
21       <name>ReportType</name>
22    </types>
23    <types>
24       <members>*</members>
25       <name>Scontrol</name>
26    </types>
27    <types>
28       <members>*</members>
29        <name>Translations</name>
30    </types>
31    <version>63.0</version>
32</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.