Simple JSON Import / Export

Using the Simple JSON file format to import/export content

Within the Localize dashboard we provide you with an ability to import and export phrases and translations in various file formats.

You can also import/export Glossary terms.

To see a general explanation of how importing and exporting works in Localize, click here.

📘

UTF-8 File Format

Be sure that you are using the UTF-8 file format when working with the external files you are creating for importing purposes.

📘

React-intl

The Simple JSON file format can be easily used in projects that use the react-intl library.

Importing Phrases

Before importing, make sure your file adheres to the file requirements below.

Navigate to the File Import / Export: Import tab in your dashboard.

  1. Drag-and-drop a file to import into the box, or select a file to import.
  2. Select SIMPLE JSON under File Format.
  3. Select the language you are importing.
  4. Specify the import type: Phrases or Glossary terms
  5. Click the Submit button.
  6. Wait for the file to be uploaded.
  7. Success! View the file details to see how many phrases were created, updated, etc.

After importing a source language file, Localize will show the phraseKey along with the phrase in the Localize dashboard.

Exporting Phrases

📘

Import First!

Simple JSON files for the source language must first be imported into the Localize dashboard so that the keys from your file are added as phraseKeys in the phrase in the Localize dashboard. Then upon subsequent exports, the phraseKeys will be maintained.

Exporting phrases for which there is no phraseKey will result in the source language string being used as the key which is probably not a desirable outcome!!!

Navigate to the File Import / Export: Export tab in your dashboard.

  1. Select SIMPLE JSON under File Format.
  2. Select a filter which will determine which phrases get exported:
    a. Published translations
    b. Machine translations
    c. Human translations
    d. No translations
    e. Needs human translations
  3. Select the language you are exporting.
  4. Specify the export type: Phrases or Glossary terms
  5. Click the Export button.
  6. Wait for your download to complete, then close the popup dialog.

📘

Exporting Selected Phrases

Alternatively, you can filter exactly which phrases that you want to export on the Phrases and/or Glossary pages. Find out how...


File Requirements

Simple JSON is a format that's used to exchange data between participants in a translation project.
Use the following sample for guidance when creating your Simple JSON file for importing into Localize.

The following data is required:

  • "key":"value": for each string in your app
    • key is a unique ID for the string
      • Keys can also be nested
    • value is the actual text of the string
{
  "new-user": {
    "submit-button": "Submit",
    "click-submit": "Click on the Submit button"
  },
  "welcome": "Welcome to our site!"
}
{
  "new-user": {
    "submit-button": "Enviar",
    "click-submit": "Haga clic en el botón Enviar"
  },
  "welcome": "¡Bienvenido a nuestro sitio!"
}

📘

Not available in Web projects

The Simple JSON file format is not available in Web-based projects, because it is a format traditionally used in mobile app development.

📘

Subscription Requirement

This advanced file format is only available in Business Plan subscriptions or higher.


Troubleshooting

If your import fails you can view the error here under Import History.

Updated 6 days ago


Simple JSON Import / Export


Using the Simple JSON file format to import/export content

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.