この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

CustomLabels

CustomLabels メタデータ型を使用して、異なる言語、国、および通貨で使用するためにローカライズできるカスタム表示ラベルを作成できます。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所

Metadata メタデータ型を拡張し、その fullName 項目を継承します。カスタム表示ラベルは、Apex クラスまたは Visualforce ページからアクセスできる、最長 1,000 文字のカスタムテキスト値です。詳細は、Salesforce ヘルプの「カスタム表示ラベル」を参照してください。

マスタカスタム表示ラベルの値は、CustomLabels.labels ファイルに保存されます。カスタム表示ラベルの翻訳は、メタデータ API の Translations を介して取得できます。翻訳は、translations フォルダの localeCode.translation という名前形式のファイルに保存されます。localeCode は、翻訳言語のロケールコードです。サポートされるロケールコードのリストは、「言語」に示しています。

バージョン

CustomLabels コンポーネントは、API バージョン 14.0 以降で使用できます。

項目

項目	項目の型	説明
fullName	string	必須。カスタム表示ラベルバンドルの名前。 Metadata から継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「`createMetadata()`」を参照してください。
labels	CustomLabel[]	カスタム表示ラベルのリスト。

CustomLabel

このメタデータ型は、カスタム表示ラベルを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

項目	項目の型	説明
categories	string	表示ラベルのカテゴリのカンマ区切りのリスト。この項目は、カスタム表示ラベルのリストビューを作成するときに、検索条件として使用できます。最大 255 文字です。
fullName	string	必須。カスタム表示ラベルの名前。 Metadata から継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「`createMetadata()`」を参照してください。
language	string	必須。翻訳されたカスタム表示ラベルの言語。
protected	boolean	必須。このコンポーネントが保護されるか (`true`)、否か (`false`) を示します。保護コンポーネントは、インストールする組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。
shortDescription	string	必須。このカスタム表示ラベルを識別するための、認識しやすい用語。この説明は差し込み項目で使用されます。
value	string	必須。翻訳済みのカスタム表示ラベル。最大 1000 文字です。

使用方法

組織で定義されているすべてのカスタム表示ラベルを取得するには、package.xml マニフェストファイルのメンバーに対して CustomLabels とワイルドカード文字 (*) を使用します。CustomLabels では、名前による 1 つ以上のカスタム表示ラベルの取得はサポートされません。名前で特定の表示ラベルを取得するには、CustomLabel を使用し、メンバーとして表示ラベル名を指定します。

宣言的なメタデータの定義のサンプル

カスタム表示ラベルコンポーネントの XML 定義のサンプルを次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<CustomLabels xmlns="http://soap.sforce.com/2006/04/metadata">
3    <labels>
4        <fullName>quoteManual</fullName>
5        <value>This is a manual quote.</label>
6        <language>en_US</language>
7        <protected>false</protected>
8        <shortDescription>Manual Quote</shortDescription>
9    </labels>
10    <labels>
11        <fullName>quoteAuto</fullName>
12        <value>This is an automatically generated quote.</label>
13        <language>en_US</language>
14        <protected>false</protected>
15        <shortDescription>Automatic Quote</shortDescription>
16    </labels>
17</CustomLabels>

次のサンプルマニフェストファイルは、CustomLabels 型を使用して、組織のすべてのカスタム表示ラベルを取得します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <fullName>MyPkg</fullName>
4    <types>
5      <members>*</members>
6      <name>CustomLabels</name>
7    </types>
8    <version>48.0</version>
9</Package>

次のサンプルマニフェストファイルでは、名前で 2 つのカスタム表示ラベルを取得します。単数形の CustomLabel が使用されています。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <fullName>MyPkg</fullName>
4    <types>
5      <members>quoteManual</members>
6      <members>quoteAuto</members>
7      <name>CustomLabel</name>
8    </types>
9    <version>48.0</version>
10</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。

メタデータ API 開発者ガイド