Localization

Localization lets you serve guides and surveys in different languages without creating a new guide or survey for each language. Supported languages are configured per project.

To create localized versions of your guides and surveys, you must:

• Update the SDK to record the user's locale.
• Update your project settings to specify which languages to support.
• Specify how each supported language behaves.
• Create the translated versions of your guides and surveys.

Update the Guides and Surveys SDK to record locale

Update the SDK to record each user's locale during the Guides and Surveys SDK initialization. With an accurate user locale, the SDK serves the correct translation of your guide or survey.

Make the following change in your SDK:

const currentLocale = getLocale(); // "en" or "en-US"

amplitude.add(window.engagement.plugin({ locale: currentLocale }));

Update project settings to support multiple languages

Navigate to Project Settings > Guides and Surveys to configure localization.

On this tab, you can:

• Enable or disable localization
• View the default language
• Define the languages available for your guides and surveys
• Set the fallback behavior when a translation file is unavailable or out of date

Guides & Surveys supports ISO 639 language codes, and the following locales:

• English: en-US, en-GB, en-AU, en-CA, en-IN
• Spanish: es-ES, es-MX, es-AR, es-CO
• French: fr-FR, fr-CA
• Portuguese: pt-BR, pt-PT
• Chinese: zh-CN (Simplified), zh-TW (Traditional), zh-HK (Hong Kong, Traditional)
• German: de-DE, de-AT, de-CH
• Arabic: ar-SA, ar-EG, ar-MA

To add a supported language

1. In the Supported languages section, click Add language.
2. In the menu, search for or scroll to select the languages you need. You can select as many as you need.
3. Click Apply.

Configure fallback behavior

Fallback behavior controls what appears when localized content isn't available. You can configure two types of fallback:

• When translation is unavailable: If a translation for a guide or survey isn't uploaded, choose whether the content appears in the default language or doesn't appear at all.
• When translation is outdated: If the default content changes but the translated content doesn't reflect the change, choose whether to show the default language, show the outdated translated version, or hide the content.

Add localized content to a guide or survey

You can add localized versions to existing guides or surveys, or include localized content as you create new ones.

To add localized content to a guide or survey

1. Open an existing guide or survey, or click Create Guide or Create Survey.
2. For an existing guide or survey, click Setup.
3. For a new guide or survey, create and save the default content, then click Setup.
4. Scroll to the Localization section.

Translatable strings

You can localize the following parts of guides and surveys:

Translate content

You can add localized content to your guide or survey in several ways:

• Use the web interface to add or edit translations. Amplitude recommends this method.
• Use AI localization to translate your content automatically. Amplitude recommends this method for quick, automated translations.
• Use the .xliff file to add or edit translations. Amplitude recommends this method if you integrate with a custom translation workflow.
• Use the localization API to add or edit translations. Amplitude recommends this method for automated translation workflows. The API takes longer to set up, but suits larger teams or teams that support many languages.

Preview a translation

When you preview a localized guide or survey, the preview bar displays translation-related issues that may prevent the guide or survey from showing.