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 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.
Platform-only languages are available in all places where you can select a language in the application. However, when you select a platform-only language, all standard Salesforce labels default to English or, in select cases, to an end-user or fully supported language.
Platform-only languages include:
- 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 (Belgium): en_BE
- English (Canada): en_CA
- English (Cyprus): en_CY
- English (Germany): en_DE
- English (Hong Kong): en_HK
- English (India): en_IN
- English (Ireland): en_IE
- English (Israel): en_IL
- English (Malaysia): en_MY
- English (Malta): en_MT
- English (Netherlands): en_NL
- English (New Zealand): en_NZ
- English (Philippines): en_PH
- English (Singapore): en_SG
- English (South Africa): en_ZA
- English (United Arab Emirates): en_AE
- Estonian: et
- Farsi: fa
- French (Belgium): fr_BE
- French (Canada): fr_CA
- French (Luxembourg): fr_LU
- French (Morocco): fr_MA
- French (Switzerland): fr_CH
- Georgian: ka
- German (Austria): de_AT
- German (Belgium): de_BE
- German (Luxembourg): de_LU
- German (Switzerland): de_CH
- Greek (Cyprus): el_CY
- Greenlandic: kl
- Gujarati: gu
- Hawaiian: haw
- Haitian Creole: ht
- Hindi: hi
- Hmong: hmn
- 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
- Punjabi: pa
- 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
- Yiddish: ji
- Zulu: zu
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
| Field | Field Type | Description |
|---|---|---|
| aiCoachAgentScnrDefs | AiCoachAgentScnrDefTranslation[] | A list of AI Coach agent scenario definition translations. Available in API version 64.0 and later. |
| botBlocks | BotBlockTranslation[] | A list of bot block translations. Available in API version 59.0 and later. |
| botTemplates | BotTemplateTranslation[] | A list of bot template translations. Available in API version 59.0 and later. |
| bots | BotTranslation[] | A list of bot translations. Available in API version 53.0 and later. |
| conversationMessageDefinitions | ConversationMessageDefinitionTranslation[] | A list of conversation message definition translations. Available in API version 61.0 and later. |
| 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. |
| dataConnectors | DataConnectorTranslation[] | A list of data connector translations. Available in API version 64.0 and later. |
| desFieldTemplateMessages | ExplainabilityMsgTemplateFieldTranslation[] | A list of admin-configured explainability message templates. |
| 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. |
| identityVerificationCustomFieldLabels | IdentityVerificationFieldTranslation |
A list of identity verification translation fields. This field is available in API version 54.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. For an example of this field specified for a call, see createMetadata(). |
| 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. |
| pipelineInspMetricConfigs | PipelineInspMetricConfigTranslation | A list of translations of Pipeline Inspection forecast category metric settings. This field is available in API version 57.0 and later. |
| productSpecificationTypes | ProductSpecificationTypeTranslation | A list of product specification type translations. This field is available in API version 66.0 and later. |
| 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. |
| recordAlertCategories | RecordAlertCategoryTranslation[] | A list of record alert category translations. Available in API version 66.0 and later. |
| recordAlertTemplates | RecordAlertTemplateTranslation[] | A list of record alert template translations. Available in API version 66.0 and later. |
| reportTypes | ReportTypeTranslation[] | A list of report type translations. |
| scontrols | ScontrolTranslation[] | A list of s-control translations. |
| svcCatalogItemAttributes | ServiceProcessAttributeTranslation[] | A list of service catalog item attribute translations. Available in API version 64.0 and later. |
| svcCatalogItemGroups | ServiceProcessItemGroupTranslation[] | A list of service catalog item group translations. Available in API version 64.0 and later. |
| timelineObjectDefinitions | TimelineObjectDefinitionTranslation[] | A list of timeline object definition translations. Available in API version 66.0 and later. |
AiCoachAgentScnrDefTranslation
AiCoachAgentScnrDefTranslation contains details for the translation of Agentforce Sales Coach scenarios. Available in API version 64.0 and later.
| Field | Field Type | Description |
|---|---|---|
| description | string | The description of the coaching scenario. |
| label | string | The title of the coaching scenario. |
| name | string | Required. Name of the coaching scenario. |
| infoMessage | string | The instructions that the rep has to follow before starting the coaching session. |
BotBlockTranslation
BotBlockTranslation contains details for a translation of a bot block. Available in API version 59.0 and later.
| Field | Field Type | Description |
|---|---|---|
| botBlockVersions | BotBlockVersionTranslation[] | A list of bot block version translations. |
| fullName | string | Required. The name of the bot block. |
BotBlockVersionTranslation
BotBlockVersionTranslation contains details for a translation of a bot block version. Available in API version 59.0 and later.
| Field | Field Type | Description |
|---|---|---|
| botDialogs | BotDialogTranslation[] | A list of bot dialog translations for the bot block version. |
| fullName | string | Required. The name of the bot block version. |
BotTemplateTranslation
BotTemplateTranslation contains details for a translation of a bot template. Available in API version 59.0 and later.
| Field | Field Type | Description |
|---|---|---|
| botDialogs | BotDialogTranslation[] | A list of bot dialog translations for the bot template. |
| fullName | string | Required. The name of the bot template. |
BotTranslation
BotTranslation contains details for a translation of a bot. Available in API version 53.0 and later.
| Field | Field Type | Description |
|---|---|---|
| botVersions | BotVersionTranslation[] | A list of bot version translations. |
| fullName | string | Required. Name of the bot. The fullName for the translation must match the fullName inherited by the original Bot type. |
BotVersionTranslation
BotVersionTranslation contains details for a translation of a bot version. Available in API version 53.0 and later.
| Field | Field Type | Description |
|---|---|---|
| botDialogs | BotDialogTranslation[] | A translated list of dialogs in this bot version. |
| fullName | string | Required. Name of a bot version. The fullName for the translation must match the fullName inherited by the original BotVersion type. |
BotDialogTranslation
BotDialogTranslation contains details for a translation of a bot dialog. Available in API version 53.0 and later.
| Field | Field Type | Description |
|---|---|---|
| botSteps | BotStepTranslation[] | A translated list of steps that are executed as part of the dialog. |
| developerName | string | Required. This unique name prevents conflicts with other dialogs
associated with the same bot version. The developerName for the translation must match the developerName on the original BotDialog subtype of BotVersion. |
| label | string | A translated label that identifies the dialog throughout the Salesforce user interface. |
BotStepTranslation
BotStepTranslation contains details for a translation of a bot step. Available in API version 53.0 and later.
| Field | Field Type | Description |
|---|---|---|
| botMessages | BotMessageTranslation[] | A translated list of bot messages used by a BotStep of type Message. |
| botSteps | BotStepTranslation[] | A translated list of bot steps associated with a BotStep of type Group. |
| botVariableOperation | BotVariableOperationTranslation | A translated bot variable operation used by a BotStep of type VariableOperation. |
| stepIdentifier | string | Required. A unique key that identifies a step within a dialog.
This key is used to link translated labels to labels within the
step. This field is recommended for all step records and is required
for translated step labels. The stepIdentifier for the translation must match the stepIdentifier on the original BotStep subtype of BotVersion. |
| type | BotStepType (enumeration of type string) | Required. Valid values are:
The type for the translation must match the type on the original BotStep subtype of BotVersion. |
BotMessageTranslation
BotMessageTranslation contains details for a translation of a bot message step. Available in API version 53.0 and later.
| Field | Field Type | Description |
|---|---|---|
| message | string | A translated message to display as part of an outgoing message from the bot to the customer. |
| messageIdentifier | string | Required. A unique key that identifies a message within a dialog.
This key is used to link translated labels to labels within the
message. This field is recommended for all message records and is
required for translated message labels. The messageIdentifier for the translation must match the messageIdentifier on the original BotMessage subtype of BotVersion. |
BotVariableOperationTranslation
BotVariableOperationTranslation contains details for a translation of a bot variable operation (question) step. Available in API version 53.0 and later.
| Field | Field Type | Description |
|---|---|---|
| botMessages | BotMessageTranslation[] | A translated list of bot messages used as prompt messages by a BotVariableOperation of type Collect. |
| botQuickReplyOptions | BotQuickReplyOptionTranslation[] | A translated list of static choice options used by a BotVariableOperation of type Collect and quickReplyType of Static. |
| quickReplyOptionTemplate | string | A translated formula template used to resolve a label for Dynamic choice options of type Object. |
| retryMessages | BotMessageTranslation[] | In Conversation Repair, the translated messages assigned to repair attempts. |
| successMessages | BotMessageTranslation[] | In a File dialog step, the translated message displayed to the customer as part of type CollectAttachment to confirm a successful file upload. Available in API version 57.0 and later. |
| type | BotVariableOperationType (enumeration of type string) | Required. Valid values are:
|
| variableOperationIdentifier | string | Required. A unique key that identifies a variable operation
within a dialog. This key is used to link translated labels to
labels within the variable operation. This field is recommended for
all variable operation records and is required for translated
variable operation labels. The variableOperationIdentifier for the translation must match the variableOperationIdentifier on the original BotVariableOperation subtype of BotVersion. |
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.
| Field | Field Type | Description |
|---|---|---|
| literalValue | string | A translated value to be displayed as a menu or button choice to your customer. |
| quickReplyOptionIdentifier | string | Required. A unique key that identifies a quick reply option
within a dialog. This key is used to link translated labels to
labels within the quick reply option. This field is recommended for
all quick reply option records and is required for translated quick
reply option labels. The quickReplyOptionIdentifier for the translation must match the quickReplyOptionIdentifier on the original BotQuickReplyOption subtype of BotVersion. |
CustomApplicationTranslation
CustomApplicationTranslation contains details for a custom application translation. For more details, see CustomApplication.
| Field | Field Type | Description |
|---|---|---|
| description | string | Description text for the application translation. |
| label | string | 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. |
ExplainabilityMsgTemplateFieldTranslation
Represents the template that contains the decision explanation message for a specified step element type.
| Field Name | Field Type | Description |
|---|---|---|
| description | string | The explainability message field description. |
| label | string | A user-friendly name for ExplainabilityMsgTemplateFieldTranslation. |
| name | string |
Required. The name of the decision explanation message for a specified step element type. |
| templateMessage | string | The message associated with the template for a specific expression set step 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.
| 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. |
| orchestrationStages | FlowOrchestrationStageTranslation | A list of orchestration stage translations for the flow version. Available in API version 63.0 and later. |
| orchestrationSteps | FlowOrchestrationStepTranslation | A list of orchestration step translations for the flow version. Available in API version 63.0 and later. |
| 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. |
FlowOrchestrationStageTranslation
FlowOrchestrationStageTranslation contains details for a translation of an orchestration stage in an orchestration version. For more details, see FlowOrchestratedStage in Flow.
Available in API version 64.0 and later.
| Field | Field Type | Description |
|---|---|---|
| name | string | Required. The unique name of the orchestration stage translation. |
| stageLabel | string | A translated label for the orchestration stage. |
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.
| Field | Field Type | Description |
|---|---|---|
| name | string | Required. The unique name of the orchestration step translation. |
| stepLabel | string | A translated label for the orchestration step. |
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 |
|---|---|---|
| backButtonLabel | string | A translated label for the Back button. Available in API version 54.0 and later. |
| fields | FlowScreenFieldTranslation[] | 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. |
| nextOrFinishButtonLabel | string | A translated label for the Next or Finish button. Available in API version 54.0 and later. |
| pauseButtonLabel | string | A translated label for the Pause button. Available in API version 54.0 and later. |
| 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. |
| inputParameters | FlowInputParameterTranslation | Reserved for internal use. |
| name | string | Required. An API name for the screen component. |
| validationRule | FlowInputValidationRuleTranslation | Translated validation rule for the screen component. |
FlowInputParameterTranslation
FlowInputParameterTranslation is reserved for internal use.
| Field | Field Type | Description |
|---|---|---|
| name | string | Reserved for internal use. |
| value | FlowFerovTranslation | Reserved for internal use. |
FlowFerovTranslation
FlowFerovTranslation is reserved for internal use.
| Field | Field Type | Description |
|---|---|---|
| complexValues | FlowComplexLiteralTranslation | Reserved for internal use. |
| stringValues | string | Reserved for internal use. |
FlowComplexLiteralTranslation
FlowComplexLiteralTranslation is reserved for internal use.
| Field | Field Type | Description |
|---|---|---|
| customAspectKey | string | Reserved for internal use. |
| value | string | 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.
| 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. |
IdentityVerificationFieldTranslation
Translates the UI components associated with identity verification fields.
Available in API version 54.0 and later.
| Field | Field Type | Description |
|---|---|---|
| customFieldLabel | string | The custom label for the field that contains the verification data. |
| description | string | The identity verification field description. |
| label | string | A user-friendly name for IdentityVerificationFieldTranslation. |
| name | string | Required. The name of the identity verification field. |
TimelineObjectDefinitionTranslation
Contains details for a translation of a timeline object definition. Available in API version 66.0 and later.
| Field | Field Type | Description |
|---|---|---|
| label | string | Translated label for the timeline object definition. |
| name | string | Required. Name of the timeline object definition. |
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>| 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 global translation of a quick action. For more information, see QuickAction.
| Field | Field Type | Description |
|---|---|---|
| aspect | string | Identifies which quick action label the translated text belongs to. Use this field only when you want to use different strings for the quick action’s field label and informational message. Valid values are Master and InfoMessage. Available in API version 53.0 and later. |
| label | string | Required. The translated quick action name, globally. |
| name | string | Required. The quick action name. |
PipelineInspMetricConfigTranslation
| Field | Field Type | Description |
|---|---|---|
| label | string | Required. The translated Pipeline Inspection metric configuration name. |
| name | string | Required. The name of the Pipeline Inspection metric configuration. |
ProductSpecificationTypeTranslation
ProductSpecificationTypeTranslation contains details for a translation of a product specification type. For more details, see ProductSpecificationType. Available in API version 66.0 and later.
| Field | Field Type | Description |
|---|---|---|
| description | string | The translated product specification type description. |
| label | string | The translated product specification type name. |
| name | string | Required. The name of the product specification type. |
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. |
| imageAltText | string | The alt text for a prompt’s image. Available in API version 53.0 and later. |
| imageLink | string | The URL for a prompt’s image. Available in API version 53.0 and later. |
| 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
ScontrolTranslation contains details for a translation of an s-control. For more information, see “About S-Controls” in Salesforce Help.
| Field | Field Type | Description |
|---|---|---|
| label | string | Required. The translated s-control name. |
| name | string | Required. The name of the s-control. |
ConversationMessageDefinitionTranslation
ConversationMessageDefinitionTranslation contains details for a translation of a conversation message definition. Available in API version 61.0 and later.
| Field | Field Type | Description |
|---|---|---|
| constantValueTranslations | ConversationMessageConstantValueTranslation[] | A list of conversation message constant value translations. |
| label | string | Required. The translated label for the conversation message definition. |
| name | string | Required. The name of the conversation message definition. |
ConversationMessageConstantValueTranslation
ConversationMessageConstantValueTranslation contains details for a translation of a conversation message constant value. Available in API version 61.0 and later.
| Field | Field Type | Description |
|---|---|---|
| name | string | Required. The name of the conversation message constant value. |
| value | string | Required. The translated constant value. |
DataConnectorTranslation
DataConnectorTranslation contains details for a translation of a data connector. Available in API version 64.0 and later.
| Field | Field Type | Description |
|---|---|---|
| attributes | DataConnectorAttributeTranslation[] | A list of data connector attribute translations. |
| description | string | The translated description for the data connector. |
| errors | DataConnectorErrorTranslation[] | A list of data connector error translations. |
| help | string | The translated help text for the data connector. |
| label | string | The translated label for the data connector. |
| language | string | The language for the data connector translation. |
| name | string | The name of the data connector. |
DataConnectorAttributeTranslation
DataConnectorAttributeTranslation contains details for a translation of a data connector attribute. Available in API version 64.0 and later.
| Field | Field Type | Description |
|---|---|---|
| errorMessage | string | The translated error message for the attribute. |
| infoMessage | string | The translated info message for the attribute. |
| inputLabel | string | The translated input label for the attribute. |
| label | string | Required. The translated label for the attribute. |
| name | string | Required. The name of the attribute. |
| options | DataConnectorAttributeOptTranslation[] | A list of data connector attribute option translations. |
DataConnectorAttributeOptTranslation
DataConnectorAttributeOptTranslation contains details for a translation of a data connector attribute option. Available in API version 64.0 and later.
| Field | Field Type | Description |
|---|---|---|
| label | string | Required. The translated label for the attribute option. |
| name | string | Required. The name of the attribute option. |
DataConnectorErrorTranslation
DataConnectorErrorTranslation contains details for a translation of a data connector error. Available in API version 64.0 and later.
| Field | Field Type | Description |
|---|---|---|
| label | string | Required. The translated label for the error. |
| name | string | Required. The name of the error. |
RecordAlertCategoryTranslation
RecordAlertCategoryTranslation contains details for a translation of a record alert category. Available in API version 66.0 and later.
| Field | Field Type | Description |
|---|---|---|
| description | string | The translated description for the record alert category. |
| label | string | Required. The translated label for the record alert category. |
| name | string | Required. The name of the record alert category. |
RecordAlertTemplateTranslation
RecordAlertTemplateTranslation contains details for a translation of a record alert template. Available in API version 66.0 and later.
| Field | Field Type | Description |
|---|---|---|
| description | string | The translated description for the record alert template. |
| label | string | The translated label for the record alert template. |
| name | string | Required. The name of the record alert template. |
| subject | string | The translated subject for the record alert template. |
ServiceProcessAttributeTranslation
ServiceProcessAttributeTranslation contains details for a translation of a service process attribute. Available in API version 64.0 and later.
| Field | Field Type | Description |
|---|---|---|
| label | string | Required. The translated label for the service process attribute. |
| name | string | Required. The name of the service process attribute. |
| serviceProcessName | string | Required. The name of the service process. |
ServiceProcessItemGroupTranslation
ServiceProcessItemGroupTranslation contains details for a translation of a service process item group. Available in API version 64.0 and later.
| Field | Field Type | Description |
|---|---|---|
| groupName | string | Required. The name of the service process item group. |
| name | string | Required. The name of the service process item group translation. |
| serviceProcessName | string | Required. The name of the service process. |
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>66.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.