Google: Updates language settings For more information, see Manage language settings (https: developers google com workspace gmail api guides language-settings) If successful, the return object contains the `display Language` that was saved for the user, which may differ from the value passed into the request This is because the requested `display Language` may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead

← Gmail users settings operations · Get started

Operation google.gmail_users_settings_updatelanguage

Provider route: PUT /gmail/v1/users/{userId}/settings/language. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/google with npm, or alter-sdk-google with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GoogleIntegration } from "@alter-ai/google";

async function execute(input: Parameters<GoogleIntegration["gmailUsersSettings"]["gmailUsersSettingsUpdateLanguage"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GoogleIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.gmailUsersSettings.gmailUsersSettingsUpdateLanguage(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_google import GoogleIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GoogleIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.gmail_users_settings.gmail_users_settings_update_language(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.userId	string	Required within parent	User’s email address. The special value “me” can be used to indicate the authenticated user. Default: me
query	object	Optional	Additional keys: not allowed
query.fields	string	Optional	Selector specifying which fields to include in a partial response.
query.prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
query.quotaUser	string	Optional	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
body	Model	Required within parent	Expand Gets language settings For more information, see Manage language settings (https: developers google com workspace gmail api guides language-settings) — response body

Referenced models: Gets language settings For more information, see Manage language settings (https: developers google com workspace gmail api guides language-settings) — response body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Gets language settings For more information, see Manage language settings (https: developers google com workspace gmail api guides language-settings) — response body

Referenced models: Gets language settings For more information, see Manage language settings (https: developers google com workspace gmail api guides language-settings) — response body

Schemas

Gets language settings For more information, see Manage language settings (https: developers google com workspace gmail api guides language-settings) — response body

Field	Type	Presence	Description and constraints
$	object	Root	Language settings for an account. These settings correspond to the "Language settings" feature in the web interface.
displayLanguage	string	Optional	The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example `en-GB`, `fr` or `ja` for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the Gmail settings for all available options, as described in the language settings help article. For a table of sample values, see [Manage language settings](https://developers.google.com/workspace/gmail/api/guides/language-settings). Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default).

Policy, approvals and errors

SDK function policy ID: google.gmail_users_settings_updatelanguage. Catalog operation: gmail.users.settings.updateLanguage. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["https://www.googleapis.com/auth/gmail.settings.basic"]

Official provider source