メタデータ API 開発者ガイド
jCustomObjectTranslation
このメタデータ型を使用して、カスタムオブジェクトをさまざまな言語に翻訳できます。Metadata メタデータ型を拡張し、その fullName 項目を継承します。コンポーネントの表示ラベルを翻訳する機能は、トランスレーションワークベンチの一部です。詳細は、Salesforce オンラインヘルプの「トランスレーションワークベンチの有効化および無効化」を参照してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
翻訳は、customObjectName__c-lang.objectTranslation という形式のファイルに保存されます。customObjectName__c は、カスタムオブジェクト名で、lang は翻訳言語です。ドイツ語の翻訳のサンプルファイル名は、myCustomObject__c-de.objectTranslation です。
カスタムオブジェクトの翻訳は、対応するパッケージディレクトリの objectTranslations フォルダに保存されます。
バージョン
CustomObjectTranslation コンポーネントは、API バージョン 14.0 以降で使用できます。
項目
| 項目 | データ型 | 説明 |
|---|---|---|
| caseValues | ObjectNameCaseValue[] | 冠詞、複数形、所有格、大文字/小文字に関するカスタムオブジェクトのさまざまな組み合わせ。 |
| fields | CustomFieldTranslation[] | カスタムオブジェクトに関連付けられたカスタム項目の翻訳のリスト。 |
| fullName | string |
customObjectName-lang という形式のカスタムオブジェクトの名前と翻訳言語。customObjectName はカスタムオブジェクト名で、lang は翻訳言語です。 Metadata から継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。 |
| gender | Gender | オブジェクトを表す名詞の性別を示します。これは、語の性別に基づいて、異なる処理が必要となる言語に使用されます。 |
| layouts | LayoutTranslation[] | ページレイアウトの翻訳のリスト。 |
| nameFieldLabel | string | 名前項目の表示ラベル。最大 765 文字です。 |
| namedFilters | NamedFilterTranslation[] | カスタムオブジェクトに関連付けられたルックアップ検索条件のエラーメッセージの翻訳のリスト。 この項目は API バージョン 30.0 で削除されました。それより前のバージョンでのみ使用できます。ルックアップ検索条件に関連付けられた翻訳メタデータは、CustomFieldTranslation サブタイプの lookupFilter 項目によって表されるようになりました。 |
| quickActions | QuickActionTranslation[] | アクションの翻訳のリスト。 |
| recordTypes | RecordTypeTranslation[] | レコードタイプの翻訳のリスト。 |
| sharingReasons | SharingReasonTranslation[] | 共有の理由の翻訳のリスト。 |
| startsWith | StartsWith (string 型の列挙) | 名詞が母音、子音、または特殊文字で開始されているかを示します。これは、語の最初の文字に基づいて、異なる処理が必要となる言語に使用されます。 |
| validationRules | ValidationRuleTranslation[] | 入力規則の翻訳のリスト。 |
| webLinks | WebLinkTranslation[] | Web リンクの翻訳のリスト。 |
| workflowTasks | WorkflowTaskTranslation[] | ワークフロー ToDo の翻訳のリスト。 |
CustomFieldTranslation
CustomFieldTranslation には、カスタム項目の翻訳の詳細が含まれます。API バージョン 37.0 以前の標準選択リストの値は、CustomFieldTranslation で翻訳できます。API バージョン 38.0 では、代わりに StandardValueSetTranslation を使用します。詳細は、「CustomField」を参照してください。
| 項目 | データ型 | 説明 |
|---|---|---|
| caseValues | ObjectNameCaseValue[] | 冠詞、複数形、所有格、大文字/小文字に関するカスタムオブジェクトのさまざまな組み合わせ。API バージョン 29.0 以降で利用できます。 |
| description | string | カスタム項目の説明の翻訳。 |
| gender | Gender | オブジェクトを表す名詞の性別を示します。これは、語の性別に基づいて、異なる処理が必要となる言語に使用されます。API バージョン 29.0 以降で利用できます。 |
| help | string | この項目の項目レベルのヘルプでフロート表示テキストとして表示されるテキストの翻訳。 |
| label | string | 表示ラベルの翻訳。最大 765 文字です。 |
| lookupFilter | LookupFilterTranslation |
ルックアップ検索条件に関連付けられた翻訳メタデータを表します。 この項目は API バージョン 30.0 以降で使用できます。
|
| name | string | 必須。MyField__c などの、カスタムオブジェクトに関連する項目の名前。 |
| picklistValues | PicklistValueTranslation[] | 選択リスト値の翻訳のリスト。「PicklistValue」を参照してください。 |
| relationshipLabel | string | 参照関係の表示ラベルの翻訳。参照関係により、項目を別の項目に関連付けることができます。リレーション項目により、ユーザは他の項目によって定義された値のリストからオプションを選択できます。最大 765 文字です。 |
| startsWith | StartsWith (string 型の列挙) | 名詞が母音、子音、または特殊文字で開始されているかを示します。これは、語の最初の文字に基づいて、異なる処理が必要となる言語に使用されます。API バージョン 29.0 以降で利用できます。 |
LayoutTranslation
LayoutTranslation には、ページレイアウトの翻訳の詳細が含まれます。詳細は、「項目」を参照してください。
| 項目 | データ型 | 説明 |
|---|---|---|
| layout | string | 必須。レイアウト名。 |
| layoutType | string | |
| sections | LayoutSectionTranslation[] | レイアウトセクションの翻訳の配列。 |
LayoutSectionTranslation
LayoutSectionTranslation には、ページレイアウトセクションの翻訳の詳細が含まれます。詳細は、「LayoutSection」を参照してください。
| 項目 | データ型 | 説明 |
|---|---|---|
| label | string | 必須。表示ラベルの翻訳。最大 765 文字です。 |
| section | string | 必須。セクション名。 |
LookupFilterTranslation
LookupFilterTranslation は、カスタムオブジェクトに関連付けられたルックアップ検索条件のエラーメッセージの翻訳を表示します。NamedFilterTranslation にこれが置き換わります。
LookupFilterTranslation は、API バージョン 30.0 以降で使用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| errorMessage | string | ルックアップ検索条件が失敗した場合に表示されるエラーメッセージ。 |
| informationalMessage | string | ページに表示される情報メッセージ。ある項目がルックアップ検索条件で除外されている理由など、ユーザにとってわかりにくい内容を説明するために使用します。 |
NamedFilterTranslation
NamedFilterTranslation は API バージョン 30.0 で削除されました。それより前の API バージョンでのみ使用できます。
NamedFilterTranslation は、カスタムオブジェクトに関連付けられるルックアップ検索条件エラーメッセージの翻訳のリストを示します。詳細は、「NamedFilter」を参照してください。
| 項目 | データ型 | 説明 |
|---|---|---|
| errorMessage | string | ルックアップ検索条件が失敗した場合に表示されるエラーメッセージ。 |
| informationalMessage | string | ページに表示される情報メッセージ。ある項目がルックアップ検索条件で除外されている理由など、ユーザにとってわかりにくい内容を説明するために使用します。 |
| name | string | 必須。ルックアップ検索条件の名前。ユーザインターフェースでこの項目を作成する場合、名前は自動的に割り当てられます。メタデータ API を使用してこの項目を作成する場合、name 項目を含める必要があります。 |
ObjectNameCaseValue
ObjectNameCaseValue は、さまざまな文法的なコンテキストで使用できるように、カスタムオブジェクト名の複数の格と定義をサポートします。
| 項目 | データ型 | 説明 |
|---|---|---|
| article | Article (string 型の列挙) | 英語には、定冠詞 (the) と不定冠詞 (a、an) の 2 種類の冠詞があります。これらの冠詞の使用は、主に、グループの任意のメンバーを参照しているか、グループの特定のメンバーを参照しているかによって異なります。有効な値は、次のとおりです。
|
| caseType | CaseType (string 型の列挙) | カスタムオブジェクト名の格。有効な値は、次のとおりです。
|
| plural | boolean | value 項目が複数であるか (true)、単数であるか (false) を示します。 |
| possessive | Possessive (string 型の列挙) | 言語の所有格は、所有の関係を示すために使用される文法上の格です。有効な値は、次のとおりです。
|
| value | string | 必須。この文法的なコンテキストでの値または表示ラベル。 |
PicklistValueTranslation
PicklistValueTranslation には、ローカルのカスタム選択リスト項目の選択リスト値の翻訳の詳細が含まれます。詳細は、「Picklist (連動選択リストを含む)」を参照してください。
| 項目 | データ型 | 説明 |
|---|---|---|
| masterLabel | string | 必須。アプリケーションの設定ページに定義された選択リスト値は、マスタラベルになります。マスタラベルは、翻訳された表示ラベルが使用できないすべての場所に表示されます。 |
| translation | string | 必須。値の翻訳。 |
QuickActionTranslation
QuickActionTranslation には、ユーザインターフェースのアクションの表示ラベルの詳細が含まれています。詳細は、「QuickAction」を参照してください。
| 項目 | データ型 | 説明 |
|---|---|---|
| label | string | 必須。表示ラベルの翻訳。最大 765 文字です。 |
| name | string | 必須。クイックアクション名。 |
RecordTypeTranslation
RecordTypeTranslation には、レコードタイプ名の翻訳の詳細が含まれます。詳細は、「RecordType」を参照してください。
| 項目 | データ型 | 説明 |
|---|---|---|
| label | string | 必須。表示ラベルの翻訳。最大 765 文字です。 |
| name | string | 必須。レコードタイプ名。 |
SharingReasonTranslation
SharingReasonTranslation には、共有の理由の翻訳の詳細が含まれます。詳細は、「SharingReason」を参照してください。
| 項目 | データ型 | 説明 |
|---|---|---|
| label | string | 必須。共有の理由の翻訳。 |
| name | string | 必須。共有の理由名。 |
ValidationRuleTranslation
ValidationRuleTranslation には、入力規則の翻訳の詳細が含まれます。詳細は、「ValidationRule」を参照してください。
| 項目 | データ型 | 説明 |
|---|---|---|
| errorMessage | string | 必須。入力規則の失敗に関連付けられたエラーメッセージの翻訳。 |
| name | string | 必須。入力規則名。 |
WebLinkTranslation
WebLinkTranslation には、Web リンクの翻訳の詳細が含まれます。詳細は、「WebLink」を参照してください。
| 項目 | データ型 | 説明 |
|---|---|---|
| label | string | 必須。Web リンク表示ラベルの翻訳。最大 765 文字です。 |
| name | string | 必須。Web リンク名。 |
WorkflowTaskTranslation
WorkflowTaskTranslation には、ワークフロー ToDo の翻訳の詳細が含まれます。詳細は、「Workflow」を参照してください。
| 項目 | データ型 | 説明 |
|---|---|---|
| description | string | ワークフロー ToDo の説明の翻訳。 |
| name | string | 必須。ワークフロー ToDo 名。 |
| subject | string | ワークフロー ToDo の件名の翻訳。 |
宣言的なメタデータの定義のサンプル
次のサンプルはドイツ語の Description__c オブジェクトに関する CustomObjectTranslation の XML 定義であり、1 つのカスタム項目 Summary__c が含まれています。この定義を含むファイルの名前と場所は、objectTranslations/Description__c-de.objectTranslation となります。
1<?xml version="1.0" encoding="UTF-8"?>
2<CustomObjectTranslation xmlns="http://soap.sforce.com/2006/04/metadata">
3 <caseValues>
4 <caseType>Nominative</caseType>
5 <plural>false</plural>
6 <value>Beschreibung</value>
7 </caseValues>
8 <caseValues>
9 <caseType>Nominative</caseType>
10 <plural>true</plural>
11 <value>Beschreibungen</value>
12 </caseValues>
13 <caseValues>
14 <caseType>Accusative</caseType>
15 <plural>false</plural>
16 <value>Beschreibung</value>
17 </caseValues>
18 <caseValues>
19 <caseType>Accusative</caseType>
20 <plural>true</plural>
21 <value>Beschreibungen</value>
22 </caseValues>
23 <caseValues>
24 <caseType>Genitive</caseType>
25 <plural>false</plural>
26 <value>Beschreibung</value>
27 </caseValues>
28 <caseValues>
29 <caseType>Genitive</caseType>
30 <plural>true</plural>
31 <value>Beschreibungen</value>
32 </caseValues>
33 <caseValues>
34 <caseType>Dative</caseType>
35 <plural>false</plural>
36 <value>Beschreibung</value>
37 </caseValues>
38 <caseValues>
39 <caseType>Dative</caseType>
40 <plural>true</plural>
41 <value>Beschreibungen</value>
42 </caseValues>
43 <fields>
44 <label>Zusammenfassung</label>
45 <name>Summary__c</name>
46 </fields>
47 <gender>Feminine</gender>
48 <nameFieldLabel>Beschreibungen</nameFieldLabel>
49</CustomObjectTranslation>次のサンプルは取引先オブジェクトに関する CustomObjectTranslation の XML 定義であり、取引先名をドイツ語のクライアント名 (Kunde) に変更するものです。取引先オブジェクトには 1 つの標準項目 account_number と、1 つのカスタム項目 Account_Code__c があります。この定義を含むファイルの名前と場所は、objectTranslations/Account-de.objectTranslation となります。
1<?xml version="1.0" encoding="UTF-8"?>
2<CustomObjectTranslation xmlns="http://soap.sforce.com/2006/04/metadata">
3 <caseValues>
4 <caseType>Nominative</caseType>
5 <plural>false</plural>
6 <value>Kunde</value>
7 </caseValues>
8 <caseValues>
9 <caseType>Nominative</caseType>
10 <plural>true</plural>
11 <value>Kunden</value>
12 </caseValues>
13 <caseValues>
14 <caseType>Accusative</caseType>
15 <plural>false</plural>
16 <value>Kunden</value>
17 </caseValues>
18 <caseValues>
19 <caseType>Accusative</caseType>
20 <plural>true</plural>
21 <value>Kunden</value>
22 </caseValues>
23 <caseValues>
24 <caseType>Genitive</caseType>
25 <plural>false</plural>
26 <value>Kunden</value>
27 </caseValues>
28 <caseValues>
29 <caseType>Genitive</caseType>
30 <plural>true</plural>
31 <value>Kunden</value>
32 </caseValues>
33 <caseValues>
34 <caseType>Dative</caseType>
35 <plural>false</plural>
36 <value>Kunden</value>
37 </caseValues>
38 <caseValues>
39 <caseType>Dative</caseType>
40 <plural>true</plural>
41 <value>Kunden</value>
42 </caseValues>
43 <fields>
44 <caseValues>
45 <caseType>Nominative</caseType>
46 <plural>false</plural>
47 <value>Kundennummer</value>
48 </caseValues>
49 <caseValues>
50 <caseType>Nominative</caseType>
51 <plural>true</plural>
52 <value>Kundennummern</value>
53 </caseValues>
54 <gender>Feminine</gender>
55 <name>account_number</name>
56 </fields>
57 <fields>
58 <label>Kunden-Code</label>
59 <name>Account_Code__c</name>
60 </fields>
61 <gender>Masculine</gender>
62</CustomObjectTranslation>