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

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

親種別

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

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

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

バージョン

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

特別なアクセスルール

このメタデータ型にアクセスするには、少なくとも次のいずれか 1 つの設定が必要です。

ビデオ通話: Org Pref (VideoVisits) 組織設定
Industries Einstein: インテリジェントフォームリーダー (EinsteinDocReader)
Industries Einstein: センチメントインサイトアカウント (IESentimentAnalysis)
自然言語処理: キーワード抽出およびエンティティ検出 (NLPServiceEnabled) 組織設定、NLP: キーワード抽出 (KeyPhrasePrefEnabled) 組織設定
自然言語処理 (NLPServicePrefEnabled) 組織設定

項目

項目名	説明
ComprehendServiceType	項目の型 VirtualVisitComprehendServiceType (string 型の列挙) 説明音声をテキストに変換するため、または変換された音声テキストを分析するために使用されるサービスの種別を指定します。有効な値は、次のとおりです。 `ComprehendMedicalService` `ComprehendService`
DeveloperName	型 string プロパティ Filter、Group、Sort 説明 API のオブジェクトの一意の名前。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初が文字である、空白を使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。管理パッケージでこの項目を使用することにより、パッケージインストール時の名前の競合を回避します。この項目を使用して、開発者は管理パッケージのオブジェクト名を変更できます。変更はサブスクライバーの組織に反映されます。表示ラベルは [レコードタイプ名] です。この項目は自動的に生成されますが、API を使用してレコードを作成する場合は独自の値を指定できます。
ExperienceCloudSiteUrl	項目の型 string 説明ポータルユーザーやゲストユーザーがビデオ通話コンポーネントを使用できるデジタルエクスペリエンスサイトの URL。
ExternalRoleIdentifier	項目の型 string 説明ユーザーによるビデオ通話への参加を許可し、通話に参加するために必要な特定の機能への一時的なアクセスを付与するために使用されるロールの ID。
FullName	型 string プロパティ Create、Group、Nillable 説明メタデータ API の VirtualVisitConfig 型の完全名。完全名には、名前空間プレフィックスを含めることができます。クエリ結果に含まれるレコードが 1 件以下の場合にのみこの項目を照会します。それ以外の場合は、エラーが返されます。複数のレコードが存在する場合、複数のクエリを使用してレコードを取得します。この制限により、パフォーマンスが確保されます。
isProtected	項目の型 boolean 説明メタデータ型の動作に現在は影響を与えていない自動生成された値。
masterLabel	項目の型 string 説明必須。 VirtualVisitConfig のわかりやすい名前であり、VirtualVisitConfig の作成時に定義します。
messagingRegion	項目の型 string 説明待機室とメッセージングチャネルのデータを処理および保存する領域。API バージョン 57.0 以降で使用できます。
namedCredential	項目の型 string 説明ビデオ通話ベンダーのアカウントを認証および承認するために使用される指定ログイン情報レコード。
storageBucketName	項目の型 string 説明ミーティングトランスクリプトを保存するストレージバケットの名前。
usageType	項目の型 VirtualVisitUsageType (string 型の列挙) 説明ビデオ通話構成レコードが作成される Salesforce 機能の名前。有効な値は、次のとおりです。 `CHIME` `ENTITY_DETECTION` `INTELLIGENT_FORM_READER` `KEY_PHRASE_EXTRACTION` `SENTIMENT_ANALYSIS`
videoCallApptTypeValue	項目の型 string 説明ビデオ予定種別を表すサービス予定オブジェクトの [デフォルトの予定種別] 選択リスト値。複数の値を区切るには、セミコロンを使用します。
videoControlRegion	項目の型 string 説明ビデオ通話に関連する API コールを実行する領域。API バージョン 57.0 以降で使用できます。
visitRegion	項目の型 VirtualVisitVisitRegion (string 型の列挙) 説明ビデオ通話の音声データとビデオデータを処理する領域。有効な値は、次のとおりです。 `af-south-1` `ap-east-1` `ap-northeast-1` `ap-northeast-2` `ap-northeast-3` `ap-south-1` `ap-southeast-1` `ap-southeast-2` `ca-central-1` `eu-central-1` `eu-north-1` `eu-south-1` `eu-west-1` `eu-west-2` `eu-west-3` `me-south-1` `sa-east-1` `us-east-1` `us-east-2` `us-west-1` `us-west-2`

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

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

1<?xml version="1.0" encoding="UTF-8"?>
2 <VirtualVisitConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3     <usageType>CHIME</usageType>
4     <visitRegion>us-east-1</visitRegion>
5     <masterLabel>vvconfig1</masterLabel>
6     <experienceCloudSiteUrl>videocall_c@testcloudurl.com</experienceCloudSiteUrl>
7     <namedCredential>SampleNamedCredential</namedCredential>
8     <comprehendServiceType>ComprehendService</comprehendServiceType>
9     <storageBucketName>comprehendbucket</storageBucketName>
10     <isProtected>false</isProtected>
11 </VirtualVisitConfig>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2 <Package xmlns="http://soap.sforce.com/2006/04/metadata">
3     <namespacePrefix>[namespacePrefix]</namespacePrefix>
4     <fullName>deployPackage</fullName>
5     <types>
6         <members>*</members>
7         <name>VirtualVisitConfig</name>
8     </types>
9     <types>
10         <members>*</members>
11         <name>NamedCredential</name>
12     </types>
13     <version>55.0</version>
14 </Package>

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

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