GoogleAppsSettings Metadata Type in SFDX

Architectural Overview#

GoogleAppsSettings controls the org-wide integration between Salesforce and Google Workspace (formerly Google Apps / G Suite). This metadata component enables administrative controls for activating Gmail buttons and links on standard contact and lead records, attaching Google Docs to records, and establishing domain verification for enterprise Google tenants.

In modern enterprise architectures where productivity suites integrate directly with CRM workflows, tracking GoogleAppsSettings in version control guarantees that sandboxes and scratch environments mirror production workspace integration settings.

Directory and File Conventions#

GoogleAppsSettings belongs to the Settings metadata domain and is represented as an individual XML file in source format:

Key Metadata Fields#

The GoogleAppsSettings schema contains administrative flags for Google Workspace integration:

Declarative XML and Package Manifest Examples#

Below is an enterprise configuration enabling Gmail and Docs with an authorized corporate domain:

<?xml version="1.0" encoding="UTF-8"?>
<GoogleAppsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableGmail>true</enableGmail>
    <enableGoogleApps>true</enableGoogleApps>
    <enableGoogleDocs>true</enableGoogleDocs>
    <googleAppsDomain>example.com</googleAppsDomain>
</GoogleAppsSettings>

Scratch Org Configuration (config/project-scratch-def.json)#

{
  "orgName": "Google Workspace Integration Scratch Org",
  "edition": "Enterprise",
  "settings": {
    "googleAppsSettings": {
      "enableGoogleApps": true,
      "enableGmail": true,
      "enableGoogleDocs": true
    }
  }
}

Package Manifest (package.xml)#

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>GoogleApps</members>
        <name>Settings</name>
    </types>
    <version>68.0</version>
</Package>

Retrieval and Deployment via SF CLI#

Commands to retrieve and deploy GoogleApps settings:

# Retrieve GoogleApps settings
sf project retrieve start --metadata "Settings:GoogleApps"

# Deploy GoogleApps settings to an org
sf project deploy start --metadata "Settings:GoogleApps" --target-org production-org

Senior Architect Best Practices and Gotchas#

• Domain Multi-Tenancy: When deploying to sandboxes, verify whether sandbox users share the production Google Workspace domain or require dedicated testing domains.
• Security and CSP: Modern Lightning Experience pages embedding Google Docs or Sheets require complementary Content Security Policy (CSP) and Trusted URLs configuration.
• Superseded Features: Evaluate whether user requirements are better served by the modern Salesforce Inbox or Einstein Activity Capture rather than legacy Google Apps buttons.

Frequently asked questions

What features are configured by GoogleAppsSettings?

It manages domain configuration, Gmail webmail buttons, Google Docs attachments, and Google Calendar sync services.

Where is GoogleAppsSettings stored in an SFDX project?

It is stored at force-app/main/default/settings/GoogleApps.settings-meta.xml under the Settings metadata type.

Can Google Apps integration be enabled in scratch orgs?

Yes. It can be specified under the settings block in project-scratch-def.json using the googleAppsSettings key.

What happens if an invalid domain is deployed in GoogleAppsSettings?

The deployment may succeed, but end-user authentication and integration actions against Google services will fail runtime validation.