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

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

キューコンポーネントのファイルサフィックスは .queue で、コンポーネントは対応するパッケージディレクトリの queues ディレクトリに保存されます。このコンポーネントは、ケース、リード、サービス契約 (エンタイトルメントが有効である場合)、およびカスタムオブジェクトをサポートします。

バージョン

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

特別なアクセスルール

Summer '20 以降、この型にアクセスできるのは、認証された内部ユーザと外部ユーザのみとなります。

項目

このメタデータ型はキューを定義する有効な値を表します。

項目名	項目の型	説明
doesSendEmailToMembers	boolean	新しいレコードがキューに追加されたときに、メールがキューメンバーに送信されるか (`true`)、否か (`false`) を示します。
email	string	キューの所有者のメールアドレス。
name	string	必須。キューの名前。ユーザインターフェースの [表示ラベル] に対応します。
queueMembers	QueueMembers[]	キューに追加されるキューメンバーを表します。メンバーは直接追加することも、ロールや属している公開グループで選択することもできます。API バージョン 42.0 以降で利用できます。
queueRoutingConfig	string	ルーティング設定名。ルーティング設定でオムニチャネルを使用する組織に適用されます。API バージョン 42.0 以降で利用できます。
queueSobject	QueueSobject[]	サポートされているエンティティ種別を示します。

QueueMembers

キューに追加されるキューメンバーを表します。メンバーをユーザとして直接追加したり、所属するロールと公開グループでメンバーを選択したりできます。API バージョン 42.0 以降で利用できます。

項目名	項目の型	説明
publicGroups	PublicGroups[]	組織の公開グループを表します。必要に応じて、公開グループを使用してキューメンバーを追加できます。
roleAndSubordinates	RoleAndSubordinates[]	ロールと、組織のロール階層のそれらの下位ロールを表します (カスタマーロールとパートナーロールを含む)。必要に応じて、ロールとその下位階層を使用してキューメンバーを追加できます。
roleAndSubordinatesInternal	RoleAndSubordinatesInternal[]	カスタマーロールとパートナーロールを除く、組織のロール階層内の内部ロールとその下位ロールを表します。必要に応じて、ロールとその下位階層を使用してキューメンバーを追加できます。
roles	Roles[]	組織のロールを表します。必要に応じて、ロールを使用してキューメンバーを追加できます。
users	Users[]	組織のユーザを表します。ユーザは、キューメンバーとして直接追加できます。

PublicGroups

組織の公開グループを表します。必要に応じて、公開グループを使用してキューメンバーを追加できます。API バージョン 42.0 以降で利用できます。

項目名	項目の型	説明
publicGroup	string	公開グループを表します。

RoleAndSubordinates

ロールと、組織のロール階層のそれらの下位ロールを表します (カスタマーロールとパートナーロールを含む)。ロールとそれらの下位ロールの階層は、キューメンバーを追加するために使用できます。API バージョン 42.0 以降で利用できます。

項目名	項目の型	説明
roleAndSubordinate	string	カスタマーロールとパートナーロールを含む、ロールとその下位ロールを表します。

RoleAndSubordinatesInternal

カスタマーロールとパートナーロールを除く、組織のロール階層内の内部ロールとその下位ロールを表します。ロールとそれらの下位ロールの階層は、キューメンバーを追加するために使用できます。API バージョン 42.0 以降で利用できます。

項目名	項目の型	説明
roleAndSubordinateInternal	string	カスタマーロールとパートナーロールを除く、ロールとその下位ロールを表します。

Roles

組織のロールを表します。ロールは、キューメンバーを追加するために使用できます。API バージョン 42.0 以降で利用できます。

項目名	項目の型	説明
role	string	ロールを表します。

Users

組織のユーザを表します。ユーザは、キューメンバーとして直接追加できます。API バージョン 42.0 以降で利用できます。

項目名	項目の型	説明
user	string	ユーザを表します。

QueueSobject

QueueSobject ではキューがサポートするエンティティ種別を表します。

項目名	項目の型	説明
sobjectType	string	有効な値は、次のとおりです。 `Case` `ContactRequest` `Lead` `ServiceContract` `Task` (API バージョン 48.0 以降で使用可能)。カスタムオブジェクト (`ObjA_c` など)

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

ケース、リードおよび ObjA という名前のカスタムオブジェクトをサポートするキューの定義を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Queue xmlns="http://soap.sforce.com/2006/04/metadata">
3    <doesSendEmailToMembers>true</doesSendEmailToMembers>
4    <email>member@company.com</email>
5    <fullName>Your Name</fullName>
6    <name>memberQueue</name>
7    <queueSobject>
8        <sobjectType>Case</sobjectType>
9    </queueSobject>
10    <queueSobject>
11        <sobjectType>Lead</sobjectType>
12    </queueSobject>
13    <queueSobject>
14        <sobjectType>ObjA__c</sobjectType>
15    </queueSobject>
16</Queue>

キューの別の定義を次に示します。このキューには、直接追加されたまたは公開グループとロールによって追加されたキューメンバーが含まれます。クエリは Name 項目ではなく DeveloperName 項目を使用して値を取得するため、一意の名前が返されます。クエリは重複する名前の末尾に文字も追加するため、これらのグループとロールを独立して参照できます。

1<?xml version="1.0" encoding="UTF-8"?>
2<Queue xmlns="http://soap.sforce.com/2006/04/metadata">
3    <doesSendEmailToMembers>false</doesSendEmailToMembers>
4    <name>queue1</name>
5    <members>
6        <publicGroups>
7            <publicGroup>All Internal Users</publicGroup>
8        <publicGroups>
9        <queueRoleAndSubordinates>
10            <queueRoleAndSubordinate>role1</queueRoleAndSubordinate>
11            <queueRoleAndSubordinate>role2</queueRoleAndSubordinate>
12            <queueRoleAndSubordinate>role3</queueRoleAndSubordinate>
13        </queueRoleAndSubordinates>
14        <roles>
15            <role>role1</role>
16        </roles>
17        <users>
18            <user>s@sm.com</user>
19            <user>std@sm.com</user>
20        </users>
21    </members>
22    <queueRoutingConfig>my_omni_routing_config</queueRoutingConfig>
23    <queueSobject>
24        <sobjectType>Case</sobjectType>
25    </queueSobject>
26    <queueSobject>
27        <sobjectType>Lead</sobjectType>
28    </queueSobject>
29</Queue>

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

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