Localization

Localization enables you to serve guides and surveys in different languages without creating a new guide or survey for each language.

Feature availability

Guides and Surveys localization is available to accounts with access to Guides and Surveys that are on Growth or Enterprise plans. For more information, see the Pricing page.

Enable localization

Enabling localization on Guides or Surveys requires updates to your SDK implementation and Project settings.

SDK updates

Specify the user's locale during SDK initialization.

const currentLocale = getLocale() // "en" or "en-US"
 
amplitude.add(window.engagement.plugin({locale: currentLocale}))

const currentLocale = getLocale() // "en" or "en-US"
 
engagement.init(apiKey,  { locale: currentLocale }) // for use with third-party Analytics SDKs

Project settings

Navigate to Project Settings > Guides and Surveys.

On this tab, you can:

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

The default language is English and, for now, only Amplitude support can change it. Once you have enabled localization, add all the languages you want to support. Furthermore, the project settings let you configure what happens when a translation is outdated or missing for a specific language.

Add translation to a guide or survey

The languages you set in Project settings appear as languages in the Localization section on the Setup tab in your guide or survey.

To add a translation:

1. Complete the guide or survey's steps in the default language.

2. Download the translation template. This template is a .xliff file that contains translatable strings from each step of your guide or survey.

3. Create translations to your target languages with the template file, and upload a translated .xliff file for each language. If you don't upload a file for a language, Guides and Surveys follows the Project setting for a missing translation.

4. After you upload a translation file, use the language picker on the canvas to toggle between available languages.

   Update translations

   Make updates to translations inline, on the appropriate step of the guide or survey. Amplitude adds updates you make here to the template file to ensure it stays in sync.

Preview a translation

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

Translatable strings

Localization is supported for the following copy:

• Guide step title
• Guide step description
• Survey step title
• Survey step description
• Checklist title
• Checklist description
• Button text (primary and secondary)
• Checklist done button label
• Snooze label
• Survey text prompt
• Survey rating lower label
• Survey rating upper label
• Survey list required message
• Survey list "other" option label
• Survey list "other" option placeholder
• Survey list input options
• Video URL