GlobalValueSetTranslation

Contains details for a global value set translation. Global value sets are lists of values that can be shared by multiple custom picklist fields, optionally across objects.This type extends the Metadata metadata type and inherits its fullName field.

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.

Important

File Suffix and Directory Location

GlobalValueSetTranslation components have the suffix .globalValueSetTranslation and are stored in the globalValueSetTranslations folder.

Translations are stored in a file with a format of ValueSetName-lang.globalValueSetTranslation, where ValueSetName is the global value set’s name, and lang is the translation language.

Version

GlobalValueSetTranslation components are available in API version 38.0 and later.

Fields

Field	Field Type	Description
valueTranslation	ValueTranslation[]	The translated name of a value in a translated global value set. Each valueTranslation is paired with a masterLabel, which is the original (untranslated) name of the value.

ValueTranslation

The original value name and the translated value name in a translated global value set.

Field	Field Type	Description
masterLabel	string	Required. The original (untranslated) name of a value in a global value set. Each valueTranslation has a masterLabel paired with its translation..
translation	string	The translated name of a value in a translated global value set.

Declarative Metadata Sample Definition

The following is an example of a GlobalValueSetTranslation component. When a value isn’t translated, its translation becomes a comment that’s paired with its masterLabel.

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

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3        <types>
4        <members>Numbers-fr</members>
5        <name>GlobalValueSetTranslation</name>
6    </types>
7    <version>38.0</version>
8</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.

Metadata API Developer Guide