CustomObjectTranslation

This metadata type allows you to translate custom objects for a variety of languages.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

The ability to translate component labels is part of the Translation Workbench.

This type extends Metadata and inherits its fields.

Local translations are stored in a file with a format of customObjectName__c-lang.objectTranslation, where customObjectName__c is the custom object name, and lang is the translation language. A sample file name for German translations is myCustomObject__c-de.objectTranslation.

Similarly, packaged translations are stored in a file with a format of customObjectName-pkgNamespace__c-lang.objectTranslation, where customObjectName-pkgNamespace__c is the custom object and package namespace, and lang is the translation language. A sample file name for German translations in a package with the namespace of Acme is myCustomObject-Acme__c-de.objectTranslation. Custom object translations are stored in the objectTranslations folder in the corresponding package directory.

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

Introduced in API version 14.0.

• Type: ObjectNameCaseValue[]
• Required: No
• Description: Different combinations of the custom object with regard to article, plural, possessive, and case.

• Type: CustomFieldTranslation[]
• Required: No
• Description: A list of translations for the custom fields associated with the custom object.

• Type: FieldSetTranslation[]
• Required: No
• Introduced: API version 41.0
• Description: A list of field set translations.

• Type: string

• Required: No

• Description: The name of the custom object and the translation language with a format of customObjectName-lang, where customObjectName is the custom object name, and lang is the translation language.

  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.

• Type: Gender (enumeration of type string)
• Required: No
• Description: Indicates the gender of the noun that represents the object. Used for languages where words need different treatment depending on their gender.

• Type: LayoutTranslation[]
• Required: No
• Description: A list of page layout translations.

• Type: NamedFilterTranslation[]

• Required: No

• Description: A list of translations for lookup filter error messages associated with the custom object.

  This field has been removed as of API version 30.0 and is only available in prior versions. The translation metadata associated with a lookup filter is now represented by the lookupFilter field in the CustomFieldTranslation subtype.

• Type: string
• Required: No
• Description: The label for the name field. Maximum of 80 characters. When you deploy a change to nameFieldLabel, also include at least one top-level caseValues entry with a nonempty value. Otherwise, the deployment succeeds but doesn’t apply the nameFieldLabel change.

• Type: QuickActionTranslation[]
• Required: No
• Description: A list of translations for actions.

• Type: RecordTypeTranslation[]
• Required: No
• Description: A list of record type translations.

• Type: SharingReasonTranslation[]
• Required: No
• Description: A list of sharing reason translations.

• Type: StandardFieldTranslation[]
• Required: No

• Type: StartsWith (enumeration of type string)
• Required: No
• Description: Indicates whether the noun starts with a vowel, consonant, or is a special character. This is used for languages where words need different treatment depending on the first character.

• Type: ValidationRuleTranslation[]
• Required: No
• Description: A list of validation rule translations.

• Type: WebLinkTranslation[]
• Required: No
• Description: A list of web link translations.

• Type: WorkflowTaskTranslation[]
• Required: No
• Description: A list of workflow task translations.

CustomFieldTranslation contains details for a custom field translation. In API versions 37.0 and earlier standard picklist values could be translated with CustomFieldTranslation. In API version 38.0, use StandardValueSetTranslation instead. For more details, see CustomField.

Not every language supports all the possible values for the fields in CustomFieldTranslation. For language-specific supported values, see the fully supported languages and end-user languages appendices.

Not every language supports all the possible values for the fields in CustomFieldTranslation. For language-specific supported values, see the fully supported languages and end-user languages appendices.

• Type: ObjectNameCaseValue[]
• Required: No
• Introduced: API version 29.0
• Description: Different combinations of the custom object with regard to article, plural, possessive, and case.

• Type: string
• Required: No
• Description: Translation for the custom field description.

• Type: Gender (enumeration of type string)
• Required: No
• Introduced: API version 29.0
• Description:

• Type: string
• Required: No
• Description: Translation for the text that displays in the field-level help hover text for this field.

• Type: string
• Required: No
• Description: Translation for the label. Maximum of 40 characters.

• Type: LookupFilterTranslation

• Required: No

• Introduced: API version 30.0

• Description: Represents the translation metadata associated with a lookup filter.

  LookupFilter isn’t supported on the article type object.

• Type: string
• Required: Yes
• Description: Required. The name of the field relative to the custom object; for example, MyField__c.

• Type: PicklistValueTranslation[]

• Required: No

• Description: List of translations for picklist values. See PicklistValue.

  Note: “Subject” on the Task object is a text field, not a picklist value. It can’t be retrieved via Metadata API. Translations can be provided via the Translation Workbench.

• Type: string
• Required: No
• Description: Translation for a lookup relationship label. A lookup relationship allows a field to be associated with another field. The relationship field allows users to select an option from a list of values defined by the other field. Maximum of 80 characters.

• Type: StartsWith (enumeration of type string)
• Required: No
• Introduced: API version 29.0
• Description: Indicates whether the noun starts with a vowel, consonant, or is a special character. Used for languages where words need different treatment depending on the first character.

FieldSetTranslation contains details for a field set translation. For more details, see FieldSet. Available in API 41.0 and later.

• Type: string
• Required: Yes
• Description: Required. Translation for the field set label. Maximum of 80 characters.

• Type: string
• Required: Yes
• Description: Required. The field set name.

LayoutSectionTranslation contains details for a page layout section translation. For more details, see LayoutSection.

• Type: string
• Required: Yes
• Description: Required. Translation for the label. Maximum of 765 characters.

• Type: string
• Required: Yes
• Description: Required. The section name.

LayoutTranslation contains details for a page layout translation. For more details, see Fields.

• Type: string
• Required: Yes
• Description: Required. The layout name.

• Type: string
• Required: No

• Type: LayoutSectionTranslation[]
• Required: No
• Description: An array of layout section translations.

LookupFilterTranslation shows a translation for a lookup filter error message associated with the custom object. Replaces NamedFilterTranslation.

Introduced in API version 30.0.

• Type: string
• Required: Yes
• Description: The error message that appears if the lookup filter fails.

• Type: string
• Required: Yes
• Description: The information message displayed on the page. Use to describe things some users don’t understand, such as why certain items are excluded in the lookup filter.

NamedFilterTranslation has been removed as of API version 30.0 and is only available in previous API versions.

NamedFilterTranslation shows a list of translations for lookup filter error messages associated with the custom object. See NamedFilter for more information.

• Type: string
• Required: No
• Description: The error message that appears if the lookup filter fails.

• Type: string
• Required: No
• Description: The information message displayed on the page. Use to describe things the user doesn’t understand, such as why certain items are excluded in the lookup filter.

• Type: string
• Required: Yes
• Description: Required. The name of the lookup filter. If you create this field in the user interface, a name is automatically assigned. If you create this field through Metadata API, you must include the name field.

ObjectNameCaseValue supports multiple cases and definitions of the custom object name to allow usage in various grammatical contexts.

Not every language supports all the possible values for the fields in ObjectNameCaseValue. For language-specific supported values, see the fully supported languages and end-user languages appendices.

Not every language supports all the possible values for the fields in ObjectNameCaseValue. For language-specific supported values, see the fully supported languages and end-user languages appendices.

• Type: Article (enumeration of type string)
• Required: No
• Description: English has two types of articles: definite (the) and indefinite (a, an). The usage of these articles depends mainly on whether you’re referring to any member of a group, or to a specific member of a group.
• Possible values:
  • Definite
  • Indefinite
  • None

• Type: CaseType (enumeration of type string)
• Required: No
• Description: The case of the custom object name.
• Possible values:
  • Ablative
  • Accusative
  • Adessive
  • Allative
  • Causalfinal
  • Dative
  • Delative
  • Distributive
  • Elative
  • Essive
  • Essiveformal
  • Genitive
  • Illative
  • Inessive
  • Instrumental
  • Lative
  • Locative
  • Nominative
  • Objective
  • Partitive
  • Prepositional
  • Subjective
  • Sublative
  • Superessive
  • Termanative
  • Translative
  • Vocative

• Type: boolean
• Required: No
• Description: Indicates whether the value field is plural (true) or singular (false).

• Type: Possessive (enumeration of type string)
• Required: No
• Description: The possessive case of a language is a grammatical case used to indicate a relationship of possession.
• Possible values:
  • First
  • None
  • Second

• Type: string
• Required: Yes
• Description: Required. The value or label in this grammatical context.

PicklistValueTranslation contains details for translation of a picklist value from a local, custom picklist field. For more details, see Picklist (Including Dependent Picklist).

• Type: string
• Required: Yes
• Description: Required. The picklist value defined on the setup page in the application. Displayed wherever a translated label isn’t available.

• Type: string
• Required: No
• Description: Required. Translation for the value.

QuickActionTranslation contains details for an action label in the user interface. For more information, see QuickAction.

• Type: string
• Required: No
• Introduced: API version 53.0
• Description: 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.

• Type: string
• Required: Yes
• Description: Required. Translation for the label. Maximum of 765 characters.

• Type: string
• Required: Yes
• Description: Required. The quick action name.

RecordTypeTranslation contains details for a record type name translation. For more details, see RecordType.

• Type: string
• Required: No
• Introduced: API version 42.0
• Description: Translation for the record type description.

• Type: string
• Required: Yes
• Description: Required. Translation for the label. Maximum of 765 characters.

• Type: string
• Required: Yes
• Description: Required. The record type name.

SharingReasonTranslation contains details for a sharing reason translation. For more details, see SharingReason.

• Type: string
• Required: Yes
• Description: Required. Translation for the sharing reason.

• Type: string
• Required: Yes
• Description: Required. The sharing reason name.

• Type: string
• Required: No
• Description: The label that identifies this component in the Salesforce UI and in metadata listings. Character limits and translation behavior follow the enclosing type.

• Type: string
• Required: Yes

ValidationRuleTranslation contains details for a validation rule translation. For more details, see ValidationRule.

• Type: string
• Required: Yes
• Description: Required. Translation for the error message associated with the validation rule failure.

• Type: string
• Required: Yes
• Description: Required. The validation rule name.

WebLinkTranslation contains details for a web link translation. For more details, see WebLink.

• Type: string
• Required: Yes
• Description: Required. Translation for the web link label. Maximum of 765 characters.

• Type: string
• Required: Yes
• Description: Required. The web link name.

WorkflowTaskTranslation contains details for a workflow task translation. For more details, see Workflow.

• Type: string
• Required: No
• Description: Translation for the workflow task description.

• Type: string
• Required: Yes
• Description: Required. The workflow task name.

• Type: string
• Required: No
• Description: Translation for the workflow task subject.

This sample XML definition shows a CustomObjectTranslation for the Description__c object in German, with one custom field, Summary__c. The name and location of the file containing this definition would be objectTranslations/Description__c-de.objectTranslation.

This sample XML definition shows a CustomObjectTranslation for the Account object, renaming Account to Client (Kunde) in German. The Account object has one standard field, account_number, and one custom field, Account_Code__c. The name and location of the file containing this definition would be objectTranslations/Account-de.objectTranslation.

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.