Metadata API Developer’s Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Translations

This metadata type allows you to work with translations for a variety of supported languages. It extends the Metadata metadata type and inherits its fullName field. The ability to translate component labels is part of the Translation Workbench. For more information, see “Setting Up the Translation Workbench” in the Salesforce online help.

Language

Salesforce offers three levels of language support: fully supported languages, end user languages, and platform-only languages. All languages are identified by a two-character language code (such as en) or a five-character locale code (such as en_AU).

Setting a default locale is different from setting a default language.

Note

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
  • Swedish: sv
  • Thai: th

Salesforce supports the following end user languages, where administration pages and online help are not translated:

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

Platform-only languages are used when you want to localize custom functionality (apps) that you’ve built on the Salesforce platform. With platform-only languages you can localize the custom labels, custom objects, and field labels in situations where Salesforce doesn’t provide any default translations.

Platform-only languages are available in all of the places where you can select a language in the application, however, when you select a platform-only language all labels in the application still default to English. You can translate all customizations made to Salesforce into a platform-only language, and you can use renaming to provide translations for standard field names on most objects. Informative text and non-field label text isn’t translatable.

  • Albanian: sq
  • Armenian: hy
  • Basque: eu
  • Bosnian: bs
  • Bengali: bn
  • Croatian: hr
  • English (Australia): en_AU
  • English (Canada): en_CA
  • English (India): en_IN
  • English (Malaysia): en_MY
  • English (Philippines): en_PH
  • Estonian: et
  • French (Canada): fr_CA
  • Georgian: ka
  • German (Austria): de_AT
  • German (Switzerland): de_CH
  • Hindi: hi
  • Icelandic: is
  • Irish: ga
  • Latvian: lv
  • Lithuanian: lt
  • Luxembourgish: lb
  • Macedonian: mk
  • Malay: ms
  • Maltese: mt
  • Romanian (Moldova): ro_MD
  • Montenegrin: sh_ME
  • Romansh: rm
  • Serbian (Cyrillic): sr
  • Serbian (Latin): sh
  • Slovenian: sl
  • Tagalog: tl
  • Tamil: ta
  • Urdu: ur
  • Welsh: cy

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.
fullName string Required. The language code; for example, de for German.

Inherited from Metadata, this field is not defined in the WSDL for this metadata type. It must be specified when creating, updating, or deleting. See create() to see an example of this field specified for a call.
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.

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.

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

S-controls have been superseded by Visualforce pages. Organizations that haven’t previously used s-controls can’t create them. Existing s-controls are unaffected, and can still be edited.

Important

ScontrolTranslation contains details for a translation of an s-control. For more information, see “About S-Controls” in the Salesforce online help.
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>32.0</version>
32</Package>