利用者
コミュニティの利用者を表します。利用者は、その利用者をコミュニティでのターゲティングに割り当てて使用できるさまざまな条件で構成されます。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
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 型の列挙) | 利用者の数式の種類を示します。有効な値は、次のとおりです。
|
AudienceCriterion
利用者の条件を表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| criteriaNumber | int | 数式で条件に関連付けられている数値 ((1 AND 2) OR 3 など) です。この項目は、API バージョン 45.0 以降で使用できます。 |
| criterionValue | AudienceCriteriaValue | 条件の値。 |
| operator | AudienceCriterionOperator (string 型の列挙) | この条件に関連付けられている演算子。有効な値は、次のとおりです。
|
| type | AudienceCriterionType (string 型の列挙) | 有効な値は、次のとおりです。
|
AudienceCriteriaValue
利用者の条件の値を表します。AudienceCriterion の各 type 項目値で使用可能な 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 項目 |
|---|---|
| GeoLocation |
city country subdivision |
| Domain | domain |
| Profile | profile |
| FieldBased |
entityField entityType fieldValue |
| Permission |
isEnabled permissionName permissionType |
使用方法
メタデータ API を使用して利用者を削除することはできません。
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。