Localization for In-App Automation

Localizing your messages helps you reach your audience with content specific to their language settings without creating independent messages for each language.

About localization

Airship’s localization feature provides a way to send a single message with multiple localizations. You can prepare localizations based on language information or LocaleThe combination of a language and country. A user’s locale is determined by their device settings. for more specific, regional localizations. Airship delivers localized messages to your audience according to language and country information gathered by the Airship SDK.

For example, if you prepared a German localization, users with their language set to German will receive the German localization of your message. If you want to make your message more regionally specific, you could add German localizations for both Germany and Austria. Users with their language preferences set to German would receive different messages depending on whether their country/region settings are set to Germany or Austria.


You can create localized content using:

  • The Message and In-App Automation composers.
  • The /push or /schedules APIs, with a localizations array in your request

All message types for the App channel are supported: push notifications, in-app messages, and Message Center messages. In the Message composer, you also have the option of selecting a content template.

Localization for In-App Automation includes support for Custom HTML messages.

This document is for the In-App Automation composer. For the Message composer and the APIS, see: Localization.

Create localized content

To localize a message with In-App Automation, you will create an CSV file containing the content for your language variants, then upload it in the composer, where you can preview and edit each version of the message. Airship generates localized messages for each language or locale in your CSV. Localization for In-App Automation requires minimum SDKs: iOS 11.0, Android 10.0.

Format localization CSV

First you must create a CSV containing translations for each language and country combination that you want to localize your message for. The first row in your CSV contains your column headers. Subsequent rows in the CSV represent your localizations, organized by language and country code. Remember to leave a row with empty id.language and id.country values; this row represents the default localization for the message and goes to users who do not match any of the language/country combinations in your CSV. The only required value in a localization CSV is id.language, for all rows except the default localization row.

See: Localization CSV Format.

Localized CSV Example
id.language,id.country,header,body,button1,button1.link
,,Hi there!,Whatcha doin?,Not much,https://www.example.com/nada
de,DE,Guten tag,Was machst du gerade?,Nicht viel,https://www.example.com/de/nada

Upload localization CSV

Follow these steps to enable localization and upload your CSV in the In-App Automation composer.

 Note

These steps cover enabling localization and adding content only — see the In-App Automation composer documentation for the full process.

In the Settings step, enable Localization:

In the Content step, upload your CSV:

  1. Click Choose File and select the CSV file containing your localizations.

  2. Click Create Localizations.

  3. Select from the dropdown menu to view content for each localization and edit as necessary. Available fields and options vary per message style.

    • Footer: Fullscreen messages include a Footer field, which is designed to link to your Terms and Conditions, Privacy Policy, or additional information to help the user make a more informed decision about the actions they could take in this message. The footer inherits the styling of the body text and functions as a button. Enter text for the footer.

    • Media: Enter an HTTPS URL that will be accessible by your mobile audience. If your Airship plan includes CDN support you can also upload media or select from previously uploaded media. Contact Support if you are interested in enabling CDN media hosting.
      1. Select Upload and click Insert Media.

        1. Click Choose file and select a file to upload, or select from previous uploads.

          • The default sort order is most recent upload first.
          • You can search by file name or keyword.
          • A file preview appears after upload or selection. Click   to preview audio and video files.
        2. (Optional) Add or edit keywords for the file to help organize your uploads.

          • Enter a term in the search field below the preview and select from results, or click Add keyword: [term].
          • Click   to remove a keyword.
        3. Click Insert selected media.

      2. Buttons: Enter button label text and click Add button. Banner and modal messages support up to two buttons. Fullscreen messages support up to five buttons. If more than one button is added, choose a button layout: separate, joined, or stacked.

      3. Custom KeysAdditional key-value pairs in your push notification payload for use by custom code in your app. You can use custom keys to pass additional campaign identifiers for analytics, pass user information to the device, control the look and feel of the app, provide image links, etc. : Enter a key and value. Click Add Another for additional keys.

    When you have finished adding localizations, click   in the header and complete the rest of the steps in the composer.

     Tip

    You can Target Specific Users by locale to align your audience with your localizations. Matching your audience with your message’s languages or locales ensures that your audience does not receive the default message. See also: Segmenting Your Audience.

    Upload localized Custom HTML

    You can localize Custom HTML messages for In-App Automation. You will need to format your HTML with data-ua-id attributes representing the parts of your message you want to localize. See: Format Custom HTML for localization. You will also need a CSV file containing your translations.

    Follow these steps to upload your localization CSV and HTML in the In-App Automation composer. After enabling localization and selecting the message style, this section covers the Content step only.

     Note

    These steps cover selecting the message style, enabling localization, and adding content only — see the In-App Automation composer documentation for the full process.

    In the Style step, select Custom HTML.

    In the Settings step, enable Localization:

    In the Content step, upload your HTML and CSV:

    1. For Upload HTML, click Choose File and select your HTML file.

    2. For Upload CSV, click Choose File and select the CSV file containing your localizations. Your localization CSV should also include any actions that you want to occur when a user taps buttons or interacts with your message.

    3. Click Create Localizations to generate a preview of the HTML. Use the dropdown menu to review your localizations.

    Click   in the header when you are ready to complete the rest of the steps in the composer.

    Format Custom HTML for localization

    When building your Custom HTML message, you will assign a data-ua-id attribute with a unique string value to any element that you want to localize. You will then represent your data-ua-id attributes as column headings in your localization CSV; Airship uses these data-ua-id values to associate localized text or values with your Custom HTML. For example, you can populate localized text for an h2 element with data-ua-id="flooble" by placing a flooble heading in your CSV.

    By default, Airship treats elements with data-ua-id as text, but you can also add additional “type” attributes to elements to tell Airship how to render localized values in your HTML message.

    • data-ua-text — Airship inserts the localized value as a plain text node into the parent element, with new lines converted into <br> elements.
    • data-ua-link — Indicates that the element supports “actions”. This places an anchor tag (<a>) immediately inside the element, wrapping the contents of the element. You determine the type of action and the action value in your CSV. You can combine this with other attribute types, wrapping the total contents of the element in an anchor tag.
    • data-ua-image — Airship will insert an <img> tag in the parent element, using the translated value as the src.
    • data-ua-video — Airship will insert a <video> tag in the parent element using the translated value as the video’s src. The video tag also includes a controls attribute.

    Localization actions For Custom HTML

    You can assign an action to any element in your custom HTML that has a data-ua-link attribute. You assign actions by adding a column in your CSV with the data-ua-id of an element and .<action_type>. For example, flooble.deep_link would represent a deep link action for an element with a data-ua-id of flooble; the value in each row would be the deep link for each localization.

    You must set your HTML actions in your localization CSV. You cannot set HTML actions in the composer. (You can set and edit actions in the composer for non-HTML messages.)

    • deep_link - Deep Link action.
    • link - Link (external URL) action; the corresponding value must be a valid URL.
    • share - Share action; the corresponding value is the text provided to the share dialog.
    • push_opt_in - Push Opt-In action; the corresponding value must be “true” to enable.
    • location_opt_in - Location Opt-In action; the corresponding value must be “true” to enable.
    • app_rating - App Rating action; the corresponding value must be “true” to enable.
    • app_rating.title - Sets the title of the App Rating modal; this key is optional and ignored if app_rating is not “true”.
    • app_rating.body - Sets body of App Rating modal; this key is optional and ignored if app_rating is not “true”.