Metadata API Developer Guide
jGoogleAppsSettings
This type extends the Metadata metadata type and inherits its fullName field.
In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.
File Suffix and Directory Location
A GoogleAppsSettings component file has the suffix .settings and is stored in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.
Version
GoogleAppsSettings components are available in API version 46.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| enableGmailButtons | boolean | Indicates whether the Gmail Buttons setting is enabled (true) or not (false). |
| enableGmailButtonsAndLinks | boolean | Indicates whether Gmail Buttons and Links are enabled (true) or not (false). |
| enableGmailLinks | boolean | Indicates whether the Gmail Links setting is enabled (true) or not (false). |
| enableGoogleDocs | boolean | Indicates whether the Add Google Docs to Salesforce setting is enabled (true) or not (false). |
| enableGoogleDocsTab | boolean | Indicates whether the Add Google Docs button on the Libraries tab is enabled (true) or not (false). |
| enableGoogleTalk | boolean | Indicates whether the Google Talk Sidebar Component is enabled (true) or not (false). |
| googleAppsDomain | string | Specifies the domain registered for your organization’s Google Apps account. |
Declarative Metadata Sample Definition
The following is an example of a GoogleAppsSettings component.
1<?xml version="1.0" encoding="UTF-8"?>
2<GoogleAppsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <enableGmailButtons>false</enableGmailButtons>
4 <enableGmailButtonsAndLinks>false</enableGmailButtonsAndLinks>
5 <enableGmailLinks>false</enableGmailLinks>
6 <enableGoogleDocs>false</enableGoogleDocs>
7 <enableGoogleDocsTab>false</enableGoogleDocsTab>
8 <enableGoogleTalk>false</enableGoogleTalk>
9 <googleAppsDomain>example.com</googleAppsDomain>
10 <googleAppsDomainLinked>false</googleAppsDomainLinked>
11 <googleAppsDomainValidated>false</googleAppsDomainValidated>
12</GoogleAppsSettings>Example Package Manifest
The following is an example package manifest used to deploy or retrieve the Google Apps settings metadata for an organization:
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>GoogleApps</members>
5 <name>Settings</name>
6 </types>
7 <version>46.0</version>
8</Package>Wildcard Support in the Manifest File
The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.