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

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

重要

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

EmbeddedServiceMenuSettings コンポーネントは、developer_name.EmbeddedServiceMenuSettings フォルダーに保存されます。

バージョン

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

項目

項目名	項目の型	説明
branding	string	関連付けられた BrandingSet の開発者名。
embeddedServiceCustomLabels	EmbeddedServiceCustomLabel[]	特定のチャネルメニューリリースで組み込みコンポーネントに表示されるカスタマイズされた表示ラベルを表します。
embeddedServiceCustomizations	EmbeddedServiceCustomization[]	この組み込みサービスリリースで使用されるカスタマイズ。各カスタマイズは静的リソースに関連付けられています。API バージョン 50.0 以降で利用できます。
embeddedServiceMenuItems	EmbeddedServiceMenuItem[]	顧客が自社のビジネスに連絡できる方法を示すチャンネルメニュー項目を表します。
isEnabled	boolean	`true` (デフォルト) の場合、リリースは有効です。`false` の場合、リリースは無効です。
masterLabel	string	必須。チャネルメニューのリリースの名前。
site	string	必須。このチャネルメニューのリリースに接続されたエクスペリエンスサイトまたは Web サイトの名前。

EmbeddedServiceCustomLabel

このチャネルメニューのリリースで使用されるカスタム表示ラベルを表します。

項目名	項目の型	説明
customLabel	string	チャネルメニューに表示されるカスタム表示ラベル。
feature	EmbeddedServiceFeature (string 型の列挙)	カスタム表示ラベルを使用する機能。チャネルメニューのリリースの場合、値は `ChannelMenu` になります。
labelKey	EmbeddedServiceLabelKey (string 型の列挙)	この組み込みコンポーネントの表示ラベルの種別。この値は、表示ラベルグループ (チャットの状態の下位の状態またはページ種別) 内の表示ラベルに対応します。

EmbeddedServiceCustomization

組み込みサービス機能に関連付けられているカスタマイズを返します。API バージョン 50.0 以降で利用できます。

項目名	項目の型	説明
customizationName	string	必須。組み込みサービスに適用されるカスタマイズの名前。この名前は、アンダースコアと英数字のみを使用でき、EmbeddedServiceConfig 設定で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。
description	string	カスタマイズの説明。
embeddedServiceResources	EmbeddedServiceResource[]	必須。カスタマイズの javascript ファイルを含む静的リソースへの参照。

EmbeddedServiceResource

組み込みサービスチャット機能のカスタマイズに関連付けられている静的リソースを返します。API バージョン 50.0 以降で利用できます。

項目名	項目の型	説明
resource	string	必須。カスタマイズの javascript ファイルを含む静的リソースの ID。
resourceType	EmbeddedServiceResourceType (string 型の列挙)	必須。カスタマイズする組み込みサービス機能。チャット機能のみがサポートされます。有効な値は、次のとおりです。 `ChatInvitation`

EmbeddedServiceMenuItem

チャネルメニュー内の項目を表します。

項目名	項目の型	説明
channel	string	チャネル種別の ID。channelType が `Phone` または `CustomURL` の場合、この項目は `null` になります。
channelType	EmbeddedServiceChannelType (string 型の列挙)	コミュニケーションチャネルの種別。値は次のとおりです。 `EmbeddedServiceConfig` `MessagingChannel` `Phone` `CustomURL`
customUrl	string	メニューに表示されるカスタム URL。shouldOpenUrlInSameTab 項目で、URL を開く場所を決定します。
displayOrder	int	メニュー内の項目の順序 (1 や 2 など)。
embeddedServiceCustomLabels	EmbeddedServiceCustomLabel[]	チャネルメニューの項目で使用するカスタム表示ラベルを表します。
iconUrl	string	メニュー項目のアイコン URL。アイコンは、電話、SMS、カスタム URL、およびチャットのメニュー項目にのみ使用できます。
isDisplayedOnPageLoad	boolean	`true` の場合、ページ読み込み時にメニュー項目が表示されます。API バージョン 49.0 以降で利用できます。
itemName	string	ユーザーインターフェースに表示される、メニュー項目の一意のカスタム名。
osOptionsHideInIOS	boolean	`true` の場合、iOS でメニュー項目が非表示になります。
osOptionsHideInLinuxOS	boolean	`true` の場合、Linux オペレーティングシステムでメニュー項目が非表示になります。
osOptionsHideInMacOS	boolean	`true` の場合、Mac オペレーティングシステムでメニュー項目が非表示になります。
osOptionsHideInOtherOS	boolean	`true` の場合、iOS、Linux、Mac、および Windows を除くオペレーティングシステムでメニュー項目が非表示になります。
osOptionsHideInWindowsOS	boolean	`true` の場合、Windows オペレーティングシステムでメニュー項目が非表示になります。
phoneNumber	string	channelType が `Phone` であるメニュー項目の電話番号。
shouldOpenUrlInSameTab	boolean	メニュー項目の channelType が `CustomURL` の場合、この項目はリンクを同じタブで開くか (`true`)、新しいタブで開くか (`false`) を示します。

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

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

1<?xml version="1.0" encoding="UTF-8"?>
2<EmbeddedServiceMenuSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <embeddedServiceCustomLabels>
4        <customLabel>CM_Container_Header_Primary_Greeting_3MsRM0000004CB5_6181150</customLabel>
5        <labelKey>CM_Container_Header_Primary_Greeting</labelKey>
6    </embeddedServiceCustomLabels>
7    <embeddedServiceCustomLabels>
8        <customLabel>CM_Container_Header_Secondary_Greeting_3MsRM0000004CB5_4637097</customLabel>
9        <labelKey>CM_Container_Header_Secondary_Greeting</labelKey>
10    </embeddedServiceCustomLabels>
11    <embeddedServiceMenuItems>
12        <channel>Chat</channel>
13        <channelType>EmbeddedServiceConfig</channelType>
14        <displayOrder>1</displayOrder>
15        <embeddedServiceCustomLabels>
16            <customLabel>CM_Container_MenuItems_WebChatUnavailable_3miRM0000004CuZ_8003848</customLabel>
17            <labelKey>CM_Container_MenuItems_WebChatUnavailable</labelKey>
18        </embeddedServiceCustomLabels>
19        <embeddedServiceCustomLabels>
20            <customLabel>CM_Container_MenuItems_WebChatAvailable_3miRM0000004CuZ_5823055</customLabel>
21            <labelKey>CM_Container_MenuItems_WebChatAvailable</labelKey>
22        </embeddedServiceCustomLabels>
23        <itemName>Chat1</itemName>
24        <osOptionsHideInIOS>false</osOptionsHideInIOS>
25        <osOptionsHideInLinuxOS>true</osOptionsHideInLinuxOS>
26        <osOptionsHideInMacOS>false</osOptionsHideInMacOS>
27        <osOptionsHideInOtherOS>false</osOptionsHideInOtherOS>
28        <osOptionsHideInWindowsOS>true</osOptionsHideInWindowsOS>
29        <shouldOpenUrlInSameTab>false</shouldOpenUrlInSameTab>
30    </embeddedServiceMenuItems>
31    <embeddedServiceMenuItems>
32        <channelType>Phone</channelType>
33        <displayOrder>2</displayOrder>
34        <itemName>Phone1</itemName>
35        <osOptionsHideInIOS>true</osOptionsHideInIOS>
36        <osOptionsHideInLinuxOS>false</osOptionsHideInLinuxOS>
37        <osOptionsHideInMacOS>true</osOptionsHideInMacOS>
38        <osOptionsHideInOtherOS>false</osOptionsHideInOtherOS>
39        <osOptionsHideInWindowsOS>false</osOptionsHideInWindowsOS>
40        <phoneNumber>1234567890</phoneNumber>
41        <shouldOpenUrlInSameTab>false</shouldOpenUrlInSameTab>
42    </embeddedServiceMenuItems>
43    <embeddedServiceMenuItems>
44        <channelType>CustomURL</channelType>
45        <customUrl>https://google.com</customUrl>
46        <displayOrder>3</displayOrder>
47        <itemName>url1</itemName>
48        <osOptionsHideInIOS>false</osOptionsHideInIOS>
49        <osOptionsHideInLinuxOS>false</osOptionsHideInLinuxOS>
50        <osOptionsHideInMacOS>false</osOptionsHideInMacOS>
51        <osOptionsHideInOtherOS>false</osOptionsHideInOtherOS>
52        <osOptionsHideInWindowsOS>false</osOptionsHideInWindowsOS>
53        <shouldOpenUrlInSameTab>false</shouldOpenUrlInSameTab>
54    </embeddedServiceMenuItems>
55    <isEnabled>true</isEnabled>
56    <masterLabel>ChannelMenuSettings</masterLabel>
57    <site>SnapInCommunity</site>
58</EmbeddedServiceMenuSettings>

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

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