Metadata API Developer Guide
jNewer Version Available
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 locale code is used for languages that differ depending on the location. For example, en_AU.
Salesforce offers full support for the following 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 all standard objects and pages, except admin pages, Setup, and Help. When you specify an end-user language, labels and Help that aren’t translated 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.
- Albanian: sq
- Afrikaans: af
- Amharic: am
- Arabic (Algeria): ar_DZ
- Arabic (Bahrain): ar_BH
- Arabic (Egypt): ar_EG
- Arabic (Iraq): ar_IQ
- Arabic (Jordan): ar_JO
- Arabic (Kuwait): ar_KW
- Arabic (Lebanon): ar_LB
- Arabic (Libya): ar_LY
- Arabic (Morocco): ar_MA
- Arabic (Oman): ar_OM
- Arabic (Qatar): ar_QA
- Arabic (Saudi Arabia): ar_SA
- Arabic (Sudan): ar_SD
- Arabic (Syria): ar_SY
- Arabic (Tunisia): ar_TN
- Arabic (United Arab Emirates): ar_AE
- Arabic (Yemen): ar_YE
- Armenian: hy
- Basque: eu
- Bosnian: bs
- Bengali: bn
- Burmese: my
- Catalan: ca
- Chinese (Hong Kong): zh_HK
- Chinese (Singapore): zh_SG
- Chinese (Malaysia): zh_MY
- Dutch (Belgium): nl_BE
- English (Australia): en_AU
- English (Canada): en_CA
- English (Hong Kong): en_HK
- English (India): en_IN
- English (Ireland): en_IE
- English (Malaysia): en_MY
- English (New Zealand): en_NZ
- English (Philippines): en_PH
- English (Singapore): en_SG
- English (South Africa): en_ZA
- Estonian: et
- Farsi: fa
- French (Belgium): fr_BE
- French (Canada): fr_CA
- French (Luxembourg): fr_LU
- French (Switzerland): fr_CH
- Georgian: ka
- German (Austria): de_AT
- German (Belgium): de_BE
- German (Luxembourg): de_LU
- German (Switzerland): de_CH
- Gujarati: gu
- Hawaiian: haw
- Haitian Creole: ht
- Hindi: hi
- Icelandic: is
- Irish: ga
- Italian (Switzerland): it_CH
- Kannada: kn
- Kazakh: kk
- Khmer: km
- Latvian: lv
- Lithuanian: lt
- Luxembourgish: lb
- Macedonian: mk
- Malay: ms
- Malayalam: ml
- Maltese: mt
- Marathi: mr
- Montenegrin: sh_ME
- Romanian (Moldova): ro_MD
- Romansh: rm
- Russian (Armenia): ru_AM
- Russian (Belarus): ru_BY
- Russian (Kazakhstan): ru_KZ
- Russian (Kyrgyzstan): ru_KG
- Russian (Lithuania): ru_LT
- Russian (Moldova): ru_MD
- Russian (Poland): ru_PL
- Russian (Ukraine): ru_UA
- Samoan: sm
- Serbian (Cyrillic): sr
- Serbian (Latin): sh
- Spanish (Argentina): es_AR
- Spanish (Bolivia): es_BO
- Spanish (Chile): es_CL
- Spanish (Colombia): es_CO
- Spanish (Costa Rica): es_CR
- Spanish (Dominican Republic): es_DO
- Spanish (Ecuador): es_EC
- Spanish (El Salvador): es_SV
- Spanish (Guatemala): es_GT
- Spanish (Honduras): es_HN
- Spanish (Nicaragua): es_NI
- Spanish (Panama): es_PA
- Spanish (Paraguay): es_PY
- Spanish (Peru): es_PE
- Spanish (Puerto Rico): es_PR
- Spanish (United States): es_US
- Spanish (Uruguay): es_UY
- Spanish (Venezuela): es_VE
- Swahili: sw
- Tagalog: tl
- Tamil: ta
- Te reo: mi
- Telugu: te
- Urdu: ur
- Welsh: cy
- Xhosa: xh
- Zulu: zu
Declarative Metadata File Suffix and Directory Location
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. The supported locale codes are listed in Language.
Custom object translations are stored in the translations folder in the corresponding package directory.
Version
Translations components are available in API version 14.0 and later.
Fields
| Field | Field Type | Description |
|---|---|---|
| customApplications | CustomApplicationTranslation[] | A list of custom application translations. |
| customLabels | CustomLabelTranslation[] | A list of custom label translations. |
| customPageWebLinks | CustomPageWebLinkTranslation[] | A list of translations for web links defined in a home page component. |
| customTabs | CustomTabTranslation[] | A list of custom tab translations. |
| flowDefinitions | FlowDefinitionTranslation[] | A list of flow translations. Only Flow and AutolaunchedFlow types are supported for translation. This field is available in API version 41.0 and later. |
| fullName | string | Required. The language code; for example, de for German. Inherited from Metadata, this field is defined in the WSDL for this metadata type. It must be specified when creating, updating, or deleting. See createMetadata() to see an example of this field specified for a call. |
| globalPicklists | GlobalPicklistTranslation[] |
A list of global picklist
translations. A global picklist’s value set is inherited by all
the custom picklist fields that are based on it.
This field is available in API version 37.0 only and is removed from later versions. |
| prompts | PromptTranslation | A list of In-App Guidance prompt translations. This field is available in API version 48.0 and later. |
| quickActions | GlobalQuickActionTranslation[] | A list of global (rather than object-specific) quick actions. |
| reportTypes | ReportTypeTranslation[] | A list of report type translations. |
| scontrols | ScontrolTranslation[] | A list of s-control translations. |
CustomApplicationTranslation
CustomApplicationTranslation contains details for a custom application translation. For more details, see CustomApplication.
| Field | Field Type | Description |
|---|---|---|
| label | string | Required. The translated custom application name. Maximum of 765 characters. |
| name | string | Required. The name of the custom application. |
CustomLabelTranslation
CustomLabelTranslation contains details for a custom label translation. For more details, see CustomLabels.
| Field | Field Type | Description |
|---|---|---|
| label | string | Required. The translated custom label name. Maximum of 765 characters. |
| name | string | Required. The custom label name. |
CustomPageWebLinkTranslation
CustomPageWebLinkTranslation contains details for a translation of a web link defined in a home page component. For more details, see CustomPageWebLink.
| Field | Field Type | Description |
|---|---|---|
| label | string | Required. The translated web link. |
| name | string | Required. The name of the web link. |
CustomTabTranslation
CustomTabTranslation contains details for a translation of a custom tab. For more details, see CustomTab.
| Field | Field Type | Description |
|---|---|---|
| label | string | Required. The translated custom tab name. |
| name | string | Required. The custom tab name. |
FlowDefinitionTranslation
FlowDefinitionTranslation contains details for a translation of a flow definition. For more details, see FlowDefinition.
Available in API version 41.0 and later.
| Field | Field Type | Description |
|---|---|---|
| flows | FlowTranslation[] | A list of flow version translations for the flow definition. |
| fullName | string | Required. The API name for the flow definition. |
| label | string | A translated label for the flow definition. By default, flow definitions inherit the label of the active flow version. If you provide a label here, the definition label no longer inherits changes to the active version label. |
FlowTranslation
FlowTranslation contains details for a translation of a flow version. For more details, see Flow.
Available in API version 41.0 and later.
| Field | Field Type | Description |
|---|---|---|
| choices | FlowChoiceTranslation[] | A list of choice translations for the flow version. |
| fullName | string | The API name for the flow version. A unique name for the flow that contains only underscores and alphanumeric characters. The name must be unique across the org, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. To deploy or retrieve a version, you can specify the version number. For example, sampleFlow-3 specifies version 3 of the flow whose unique name is sampleFlow. If you don’t specify a version number, the flow is the latest version. In API version 43.0 and earlier, this field included the version number. In API version 44 and later, this field no longer includes the version number. |
| label | string | A translated label for the flow version. |
| screens | FlowScreenTranslation[] | A list of screen translations for the flow version. |
| stages | FlowStageTranslation[] | A list of stage translations for the flow version. Available in API version 43.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.
| Field | Field Type | Description |
|---|---|---|
| choiceText | string | A translated label for the choice. |
| name | string | Required. A unique name for the choice. |
| userInput | FlowChoiceUserInputTranslation | A translated choice input for the choice. |
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.
| Field | Field Type | Description |
|---|---|---|
| promptText | string | A translated label for the choice input. |
| validationRule | FlowInputValidationRuleTranslation | A translated validation rule for the choice input. |
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.
| Field | Field Type | Description |
|---|---|---|
| errorMessage | string | A translated error message for the validation rule. |
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.
| Field | Field Type | Description |
|---|---|---|
| fields | FlowScreenField[] | A list of screen component translations for the screen. |
| helpText | string | Translated help text for the screen. |
| name | string | Required. An API name for the screen. |
| pausedText | string | A translated pause confirmation message for the screen. |
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.
| Field | Field Type | Description |
|---|---|---|
| fieldText | string | A translated label for the screen component. |
| helpText | string | Translated help text for the screen component. |
| name | string | Required. An API name for the screen component. |
| validationRule | FlowInputValidationRuleTranslation | Translated validation rule for the screen component. |
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.
| Field | Field Type | Description |
|---|---|---|
| label | string | A translated label for the stage. |
| name | string | Required. An API name for the stage. |
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.
| Field | Field Type | Description |
|---|---|---|
| name | string | Required. Unique name for the text template. |
| text | string | Translated text for the text template. |
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>| Field | Field Type | Description |
|---|---|---|
| name | string | Required. Represents the name of a global picklist to be translated. |
| picklistValues | PicklistValueTranslation[] | A list of picklist values from global picklists to be translated. |
GlobalQuickActionTranslation
GlobalQuickActionTranslation contains details for the translation of a quick action, globally. For more information, see QuickAction.
| Field | Field Type | Description |
|---|---|---|
| label | string | Required. The translated quick action name, globally. |
| name | string | Required. The quick action name. |
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.
| Field | Field Type | Description |
|---|---|---|
| description | string | The prompt description |
| label | string | The translated prompt name. |
| name | string | Required. The name of the prompt. |
| promptVersions | PromptVersionTranslation | A list of the prompt version translations. |
PromptVersionTranslation
PromptVersionTranslation contains details for translation of a prompt, which is part of In-App Guidance. Available in API Version 48.0 and later.
| Field | Field Type | Description |
|---|---|---|
| actionButtonLabel | string | The label for the prompt’s action button. |
| actionButtonLink | string | The URL for the prompt’s action button. |
| body | string | The body text of the prompt. |
| description | string | The prompt description. |
| dismissButtonLabel | string | The label for the floating prompt’s dismiss button. |
| header | string | The header for the docked prompt. |
| label | string | The translated prompt name. |
| name | string | Required. The name of the prompt. |
| title | string | The title of the prompt. |
| videoLink | string | The URL for the docked prompt’s video. |
ReportTypeTranslation
ReportTypeTranslation contains details for a translation of a custom report type. For more details, see ReportType.
| Field | Field Type | Description |
|---|---|---|
| description | string | The translated report type description. |
| label | string | The translated report type name. |
| name | string | Required. The name of the report type. |
| sections | ReportTypeSectionTranslation[] | A list of report type section translations. |
ReportTypeSectionTranslation
ReportTypeSectionTranslation contains details for a report type section translation.
| Field | Field Type | Description |
|---|---|---|
| columns | ReportTypeColumnTranslation[] | A list of report type column translations. |
| label | string | The translated report type section name. |
| name | string | Required. The name of the report type section. |
ReportTypeColumnTranslation
ReportTypeColumnTranslation contains details for a report type column translation.
| Field | Field Type | Description |
|---|---|---|
| label | string | Required. The translated report type column name. |
| name | string | Required. The report type column name. |
ScontrolTranslation
| Field | Field Type | Description |
|---|---|---|
| label | string | Required. The translated s-control name. |
| name | string | Required. The name of the s-control. |
Declarative Metadata Sample Definition
A sample XML definition of a translations component is shown below.
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 in your organization, the files returned in the .translations folder only include translations for the other metadata types referenced in package.xml. For example, the following 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>52.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.