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

ファイルのサフィックスおよびディレクトリの場所

Territory2 コンポーネントのサフィックスは territory2 で、対応する Territory2Model のフォルダの下位にある territories フォルダに保存されます。

バージョン

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

特別なアクセスルール

Territory2Model オブジェクトは、SOAP API に State 項目があります。状態は計画中、有効、アーカイブ済みのほか、コピー中などプロセスが進行中であることを示すものも多数あります。「テリトリーの管理」権限のないユーザは、有効状態のモデルに属するテリトリーにのみアクセスできます。すべてのテリトリー管理エンティティに対する deploy() コールには、メタデータ API で必要な「すべてのデータの編集」権限のほかに「テリトリーの管理」権限が必要です。「テリトリーの管理」権限のないユーザが retrieve() を実行すると、有効状態の Territory2Model に属するエンティティのみが返されます。「テリトリーの管理」権限なしにコールを実行してもデータの一部しか取得されないためお勧めしません。

項目

項目名	項目の型	説明
accountAccessLevel	string	このテリトリーのユーザが、このテリトリーに割り当てられている (通常ならアクセスできない) 取引先にアクセスできるかどうかを指定します。有効な値は、次のとおりです。 `Read` `Edit` `All` 組織の取引先に対する共有モデルが「公開/参照・更新可能」の場合、有効な値は `Edit` および `All` のみです。この項目に値が設定されていない場合は、組織の共有設定で認められている、Territory2Settings で指定されたデフォルトのアクセスレベルが使用されます。
caseAccessLevel	string	このテリトリーのユーザが、このテリトリーに割り当てられている (通常ならアクセスできない) ケースにアクセスできるかどうかを指定します。有効な値は、次のとおりです。 `None` `Read` `Edit` 組織のケース/商談に対する共有モデルが「公開/参照・更新可能」の場合は、値を指定しません。この項目に値が設定されていない場合は、組織の共有設定で許可されている、Territory2Settings で指定されたデフォルトのアクセスレベルが使用されます。
contactAccessLevel	string	このテリトリーのユーザが、このテリトリーに割り当てられている (通常ならアクセスできない) 取引先責任者にアクセスできるかどうかを指定します。有効な値は、次のとおりです。 `None` `Read` `Edit` 取引先責任者に対する組織の共有モデルが「公開/参照・更新可能」または「親レコードに連動」の場合は値を指定しません。
customFields	FieldValue	Territory2 オブジェクトで定義され、このテリトリーで使用されるカスタム項目の値。このメタデータは、CustomObject で個別に取得されます。次の点に注意してください。 Territory2 オブジェクトおよび Territory2Model オブジェクトは、ロングテキストエリア項目、リッチテキストエリア項目、およびテキストで暗号化されたカスタム項目の値を処理しません。項目は、その API 名を使用して参照されます。Location のような複合項目種別は、いくつかの要素で構成される列項目として表示されます。たとえば、nnn_Latitude__s、nnn_Longitude__s などで構成され、「nnn」は項目名、サフィックスは地理位置情報コンポーネントです。必須カスタム項目の値は、`deploy()` 操作中に適用されます。
description	string	テリトリーの説明です。
name	string	必須。テリトリーのユーザインターフェース表示ラベル。
opportunityAccessLevel	string	このテリトリーのユーザが、このテリトリーに割り当てられている (通常ならアクセスできない) 商談にアクセスできるかどうかを指定します。有効な値は、次のとおりです。 `None` `Read` `Edit` 組織のケース/商談に対する共有モデルが「公開/参照・更新可能」の場合は、値を指定しません。この項目に値が設定されていない場合は、組織の共有設定で許可されている、Territory2Settings で指定されたデフォルトのアクセスレベルが使用されます。
parentTerritory	string	テリトリーの上位テリトリーの名前。上位テリトリーを指定する場合は、開発者名を使用します。「完全修飾」名は使用しないでください。値の型を `<value xsi:nil="true"/>` に指定すると、値のないカスタム項目が取得されます。また、`<value xsi:nil="true"/>` 構文を使用して、カスタム項目の既存の値を削除することもできます。
ruleAssociations	Territory2RuleAssociation	オブジェクト割り当てルールおよびテリトリーへの関連付けを表します。ルールの開発者名を使用します。
territory2Type	string	必須。テリトリーが属するテリトリー種別。

FieldValue

Territory2 オブジェクトのカスタム項目の値を表します。API バージョン 32.0 以降で利用できます。

項目名	項目の型	説明
name	string	必須。テリトリーのユーザインターフェース表示ラベル。
value	あらゆる型	項目の値。`null` にすることもできます。項目種別は、XML で指定し、項目値によって異なります。

Territory2RuleAssociation

オブジェクト割り当てルールのテリトリーへの関連付けを表します。API バージョン 32.0 以降で利用できます。

項目名	項目の型	説明
inherited	boolean	必須。ルールが上位のテリトリーから継承されたルールか (`true`)、現在のテリトリーのローカルルールか (`false`) を示します。ルールの継承は、テリトリーモデル階層内で、ルールが作成された上位テリトリーからルールの下位テリトリー (ある場合) に受け継がれます。ローカルルールは、1 つのテリトリー内で作成され、そのテリトリーにのみ影響します。
ruleName	string	必須。テリトリーに関連付けられたルールの名前。メタデータ API はルールがテリトリーと同じモデルに属すると想定するため、ruleName は完全修飾名である必要はありません。

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

次の例は、Territory2 コンポーネントの定義を示しています。

1<?xml version="1.0" encoding="UTF-8"?>
2<Territory2 xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
3    <name>USA</name>
4    <description>United States sales</description>
5    <accountAccessLevel>Edit</accountAccessLevel>
6    <opportunityAccessLevel>Read</opportunityAccessLevel>
7    <caseAccessLevel>Edit</caseAccessLevel>
8    <contactAccessLevel>Edit</contactAccessLevel>
9    <parentTerritory>Worldwide_Sales</parentTerritory>
10    <territory2Type>Geo</territory2Type>
11    <ruleAssociations>
12        <ruleName>AccRule1</name>
13        <inherited>True</inherited>
14     </ruleAssociations>
15     <ruleAssociations>
16        <ruleName>AccRule2</name>
17        <inherited>False</inherited>
18     </ruleAssociations>
19     <customFields>
20        <name>Activation_DateTime__c</name>
21        <value xsi:type="xsd:dateTime">2014-07-16T05:05:00.000Z</value>
22     </customFields>
23     <customFields>
24        <name>AutoNumber__c</name>
25        <value xsi:type="xsd:string">T# 000001</value>
26     </customFields>
27     <customFields>
28        <name>DeactivationDate__c</name>
29        <value xsi:type="xsd:date">2016-07-12</value>
30     </customFields>
31     <customFields>
32        <name>External_Id__c</name>
33        <value xsi:type="xsd:string">AB2345</value>
34     </customFields>
35     <customFields>
36        <name>ManagersPhone__c</name>
37        <value xsi:nil="true"/>
38     </customFields>
39</Territory2>

package.xml のサンプルを次に示します。FY13 および FY14 は、テリトリーモデルの名前を表し、異なるモデル内でルールに同一の開発者名を指定できることを示しています。モデル名の代わりにワイルドカード記号 (*) を使用すると、組織内のすべてのモデルの全ルールが取得されます。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">    
3    <types>
4        <members>FY13</members>
5        <members>FY14</members>
6        <name>Territory2Model</name>
7    </types>    
8
9    <types>
10        <members>FY13.USA</members>
11        <members>FY13.Worldwide_Sales</members>
12        <members>FY14.APAC</members>
13        <members>FY14.USA</members>
14        <name>Territory2</name>
15    </types>
16        
17    <version>45.0</version>
18</Package>

使用方法

deploy() 操作中は、Territory2 で定義されたトリガが起動されません。
Territory Management 2.0 のコンポーネントは、パッケージ化や変更セットをサポートしておらず、CRUD コールでサポートされていません。

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

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