Metadata API Developer Guide
jNewer Version Available
EmbeddedServiceBranding
Represents the branding for each Snap-ins
deployment.
This type extends the Metadata
metadata type and inherits its fullName field.
File Suffix and Directory Location
EmbeddedServiceBranding components are stored in the developer_name.EmbeddedServiceBranding file in the EmbeddedServiceBranding folder.
Version
EmbeddedServiceBranding is available in API version 39.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| contrastInvertedColor | string | Accent branding color used in the snap-in, displayed as a hexadecimal value. Changes made to this field in the API aren’t reflected in the snap-in. |
| contrastPrimaryColor | string | Accent branding color used in the snap-in, displayed as a hexadecimal value. |
| embeddedServiceConfig | string | Required. The Snap-ins configuration that this branding applies to. |
| font | string | Font used in the text of the snap-in. |
| height | int | Height of the snap-in. Available in API version 43.0 and later. |
| masterLabel | string | Required. The name of the embedded service configuration node. |
| navBarColor | string | Color used for the navigation bar in the snap-in, displayed as a hexadecimal value. |
| primaryColor | string | Primary branding color used in the snap-in, displayed as a hexadecimal value. |
| secondaryColor | string | Secondary branding color used in the snap-in, displayed as a hexadecimal value. |
| width | int | Width of the snap-in. Available in API version 43.0 and later. |
Declarative Metadata Sample Definition
The following is an example of an EmbeddedServiceBranding file.
1<?xml version="1.0" encoding="UTF-8"?>
2<EmbeddedServiceBranding xmlns="http://soap.sforce.com/2006/04/metadata">
3 <contrastInvertedColor>#ffffff</contrastInvertedColor>
4 <contrastPrimaryColor>#333333</contrastPrimaryColor>
5 <embeddedServiceConfig>EswConfig001</embeddedServiceConfig>
6 <font>Salesforce Sans</font>
7 <height>498</height>
8 <masterLabel>EmbeddedServiceBranding_Parent04IRM000000002a_16033cd2c16</masterLabel>
9 <navBarColor>#222222</navBarColor>
10 <primaryColor>#222222</primaryColor>
11 <secondaryColor>#005290</secondaryColor>
12 <width>320</width>
13</EmbeddedServiceBranding>Wildcard Support in the Manifest File
This metadata type doesn’t support the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.