この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

EmbeddedServiceDetail

ゲストユーザの各 EmbeddedServiceConfig リリースで定義された、基礎となる [組み込みサービス] 設定オブジェクトから項目を公開するメタデータカタログオブジェクトを表します。ゲストユーザには、[組み込みサービス] 設定オブジェクトへの直接アクセス権はありません。API バージョン 39.0 以降で利用できます。

サポートされている SOAP コール

describeSObjects()、query()

サポートされている REST HTTP メソッド

GET

項目

項目 詳細
AvatarImg
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
エージェントのアバター画像として使用する画像の URL。
ContrastInvertedColor
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
組み込みコンポーネントで使用する、ブランドのアクセント色。16 進値で表示されます。API でこの項目を変更しても、変更は組み込みコンポーネントに反映されません。
ContrastPrimaryColor
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
EmbeddedServiceBranding 設定オブジェクトの ContrastPrimaryColor 項目の値。
CustomMinimizedComponent
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
この組み込みチャットリリースの最小化された状態で使用するカスタム Aura コンポーネント。
CustomPrechatComponent
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
この組み込みチャットリリースの事前チャットページで使用するカスタム Aura コンポーネント。
DurableId
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
EmbeddedServiceConfig の開発者名。
FieldServiceConfirmCardImg
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
組み込み予定管理 (ベータ) の確認カードで使用する画像の URL。
FieldServiceHomeImg
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
組み込み予定管理 (ベータ) のホーム画面で使用する画像の URL。
FieldServiceLogoImg
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
組み込み予定管理 (ベータ) のホーム画面で使用するロゴの URL。
Font
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
組み込みチャットウィンドウのチャットテキストで使用するフォント。
FontSize
型
picklist
プロパティ
Filter、Group、Nillable、Restricted picklist、Sort
説明
組み込みコンポーネントのフォントサイズ。
可能な値は次のとおりです。
  • Small
  • Medium
  • Large
HeaderBackgroundImg
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
組み込みチャットのヘッダー背景で使用する画像の URL。この項目は、API バージョン 49.0 以降で削除されます。ヘッダーの背景画像はサポートされなくなりました。
Height
型
int
プロパティ
Filter、Group、Nillable、Sort
説明
組み込みコンポーネントの高さ。
IsFieldServiceEnabled
型
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
この組み込みサービスリリースで Field Service が有効化されているか (true)、否か (false) を示します。現在、組み込み予定管理はベータ版です。
IsLiveAgentEnabled
型
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
この組み込みサービスリリースでチャットが有効化されているか (true)、否か (false) を示します。
IsOfflineCaseEnabled
型
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
この組み込みチャットリリースでオフラインサポートが有効化されているか (true)、否か (false) を示します。
IsPrechatEnabled
型
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
EmbeddedServiceLiveAgent 設定オブジェクトの PrechatEnabled 項目の値。
IsQueuePositionEnabled
型
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
この組み込みチャットリリースで (エージェントを待機している間の顧客の順番を表示する) キューの位置が有効化されているか (true)、否か (false) を示します。
NavBarColor
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
EmbeddedServiceBranding 設定オブジェクトの NavBarColor 項目の値。
NavBarTextColor
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
この項目は、ヘッダーテキストの色を設定するために使用します。
OfflineCaseBackgroundImg
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
組み込みチャットのオフラインサポートケースフォームの背景で使用する画像の URL。
PrechatBackgroundImg
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
組み込みチャットの事前チャットフォームの背景で使用する画像の URL。
PrimaryColor
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
EmbeddedServiceBranding 設定オブジェクトの PrimaryColor 項目の値。
SecondaryColor
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
EmbeddedServiceBranding 設定オブジェクトの SecondaryColor 項目の値。
SecondaryNavBarColor
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
この項目は、サブヘッダーの色を設定するために使用します。
ShouldHideAuthDialog
型
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
フロー中に顧客に再ログインを要求するメッセージを非表示にするか (true)、否か (false) を指定します。非表示になっていると、直接ログインページに移動します。
ShouldShowExistingAppointment
型
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
組み込み予定管理 (ベータ) で、既存の予定にアクセスするためのボタンを顧客のホーム画面に表示するか (true)、否か (false) を指定します。
ShouldShowNewAppointment
型
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
組み込み予定管理 (ベータ) で、新しい予定を作成するためのボタンを顧客のホーム画面に表示するか (true)、否か (false) を指定します。
Site
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
EmbeddedServiceConfig 設定オブジェクトの Site 項目の値。
SmallCompanyLogoImg
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
組み込みチャットで使用するロゴ画像の URL。
WaitingStateBackgroundImg
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
顧客がサポートエージェントとの接続を待機している間、組み込みチャットの背景画像で使用する画像の URL。
Width
型
int
プロパティ
Filter、Group、Nillable、Sort
説明
組み込みコンポーネントの幅。

画像項目に加えた変更は、[設定] で入力した内容を上書きします。画像の URL は [設定] で設定することをお勧めします。

メモ