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

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

Audience コンポーネントのサフィックスは .audience で、audience フォルダに保存されます。

バージョン

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

特別なアクセスルール

Audience 型へのアクセスには、AudienceMetadata 権限が必要です。この権限は、ネットワークが有効化されている組織ではデフォルトで有効になります。

Audience 型の権限ベースの条件へのアクセスには、AudiencePermissionCriteria 権限が必要です。この権限は、API バージョン 45.0 以降で使用でき、ネットワークが有効化されている組織ではデフォルトで有効になります。

項目

項目名	項目の型	説明
audienceName	string	必須。利用者の名前。
container	string	必須。利用者を含むコミュニティまたは組織の名前。
criterion	AudienceCriterion[]	利用者の条件のリスト。
description	string	利用者の説明。
formula	string	利用者を決定するために使用する数式。この項目は、API バージョン 45.0 以降で使用できます。
formulaFilterType	FormulaFilterType(string 型の列挙)	利用者の数式の種類を示します。有効な値は、次のとおりです。 `AllCriteriaMatch` `AnyCriterionMatches` `CustomLogicMatches` (API バージョン 45.0 以降で使用可能)

AudienceCriterion

利用者の条件を表します。

項目名	項目の型	説明
criteriaNumber	int	数式で条件に関連付けられている数値 ((1 AND 2) OR 3 など) です。この項目は、API バージョン 45.0 以降で使用できます。
criterionValue	AudienceCriteriaValue	条件の値。
operator	AudienceCriterionOperator (string 型の列挙)	この条件に関連付けられている演算子。有効な値は、次のとおりです。 `Equal` `NotEqual` `GreaterThan` `GreaterThanOrEqual` `LessThan` `LessThanOrEqual` `Contains` `StartsWith` `Includes` (API バージョン 45.0 以降で使用可能) `NotIncludes` (API バージョン 45.0 以降で使用可能)
type	AudienceCriterionType (string 型の列挙)	有効な値は、次のとおりです。 `GeoLocation` `Domain` `Profile` `FieldBased` `Permission` (API バージョン 45.0 以降で使用可能) AudienceCriterion の各 type 項目値で使用可能な AudienceCriteriaValue 項目のリストについては、この表を参照してください。

AudienceCriteriaValue

利用者の条件の値を表します。AudienceCriterion の各 type 項目値で使用可能な AudienceCriteriaValue 項目のリストについては、この表を参照してください。

項目名	項目の型	説明
city	string	ユーザの市区郡。この項目は、AudienceCriterion の type 項目の値が `GeoLocation` の場合にのみ使用できます。
country	string	ユーザの国。この項目は、AudienceCriterion の type 項目の値が `GeoLocation` の場合にのみ使用できます。
domain	string	ユーザのドメイン。この項目は、AudienceCriterion の type 項目の値が `Domain` の場合にのみ使用できます。
entityField	string	オブジェクトの項目。この項目は、AudienceCriterion の type 項目の値が `FieldBased` の場合にのみ使用できます。
entityType	string	オブジェクトの種別。この項目は、AudienceCriterion の type 項目の値が `FieldBased` の場合にのみ使用できます。
fieldValue	string	項目の値。この項目は、AudienceCriterion の type 項目の値が `FieldBased` の場合にのみ使用できます。
isEnabled	string	ユーザに対して権限が有効化されているか (`true`)、否か (`false`) を示します。この項目は、API バージョン 45.0 以降で、AudienceCriterion の type 項目の値が `Permission` の場合にのみ使用できます。
permissionName	string	標準ユーザまたはカスタム権限の有効な API 参照名を示します。この項目は、API バージョン 45.0 以降で、AudienceCriterion の type 項目の値が `Permission` の場合にのみ使用できます。
permissionType	string	権限の種別。有効な値は、`Standard` および `Custom` です。この項目は、API バージョン 45.0 以降で、AudienceCriterion の type 項目の値が `Permission` の場合にのみ使用できます。
profile	string	ユーザのプロファイル。この項目は、AudienceCriterion の type 項目の値が `Profile` の場合にのみ使用できます。
subdivision	string	ユーザの下位区分。この項目は、AudienceCriterion の type 項目の値が `GeoLocation` の場合にのみ使用できます。

次の表では、AudienceCriterion のさまざまな type 項目値で使用可能な AudienceCriteriaValue 項目がまとめられています。

AudienceCriterion の type	AudienceCriteriaValue 項目
`GeoLocation`	city country subdivision
`Domain`	domain
`Profile`	profile
`FieldBased`	entityField entityType fieldValue
`Permission`	isEnabled permissionName permissionType

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

Audience コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Audience xmlns="http://soap.sforce.com/2006/04/metadata">
3    <audienceName>Audience Metadata</audienceName>
4    <container>Customer</container>
5    <criterion>
6        <criteriaNumber>1</criteriaNumber>
7        <criterionValue>
8            <country>United States</country>
9            <subdivision>Nevada</subdivision>
10        </criterionValue>
11        <operator>Equal</operator>
12        <type>GeoLocation</type>
13    </criterion>
14    <criterion>
15        <criteriaNumber>2</criteriaNumber>
16        <criterionValue>
17            <profile>customer community user</profile>
18        </criterionValue>
19        <operator>Equal</operator>
20        <type>Profile</type>
21    </criterion>
22    <criterion>
23        <criteriaNumber>3</criteriaNumber>
24        <criterionValue>
25            <domain>sampledomain.example.com</domain>
26        </criterionValue>
27        <operator>Equal</operator>
28        <type>Domain</type>
29    </criterion>
30    <criterion>
31        <criteriaNumber>4</criteriaNumber>
32        <criterionValue>
33            <entityField>Manager.Profile.CreatedBy.Contact.MailingCountry</entityField>
34            <entityType>User</entityType>
35            <fieldValue>USA</fieldValue>
36        </criterionValue>
37        <operator>StartsWith</operator>
38        <type>FieldBased</type>
39    </criterion>
40    <criterion>
41        <criteriaNumber>5</criteriaNumber>
42        <criterionValue>
43            <entityField>RecordTypeId</entityField>
44            <entityType>CollaborationGroup</entityType>
45            <fieldValue>CollaborationGroup.Group_RT2</fieldValue>
46        </criterionValue>
47        <operator>Equal</operator>
48        <type>FieldBased</type>
49    </criterion>
50    <criterion>
51        <criteriaNumber>6</criteriaNumber>
52        <criterionValue>
53            <isEnabled>true</isEnabled>
54            <permissionName>ManageUsers</permissionName>
55            <permissionType>Standard</permissionType>
56        </criterionValue>
57        <operator>Equal</operator>
58        <type>Permission</type>
59    </criterion>
60    <criterion>
61        <criteriaNumber>7</criteriaNumber>
62        <criterionValue>
63            <isEnabled>false</isEnabled>
64            <permissionName>NamespaceXYZ__CustomPermABC</permissionName>
65            <permissionType>Custom</permissionType>
66        </criterionValue>
67        <operator>Equal</operator>
68        <type>Permission</type>
69    </criterion>
70<formula>1 AND (2 OR 3 OR 4 OR 5 OR 6 OR 7)</formula>
71<formulaFilterType>CustomLogicMatches</formulaFilterType>
72</Audience>

使用方法

メタデータ API を使用して利用者を削除することはできません。

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

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