Zlokalizuj wiadomości

W tej dokumentacji opisano użycie pól lokalizacji FCM (*_loc_key i *_loc_args) do dostarczania powiadomień, które automatycznie dostosowują się do ustawień języka użytkownika na Androidzie i iOS. Dzięki temu serwer może wysyłać pojedynczy ładunek niezależny od języka, a tłumaczenie jest przekazywane do urządzenia klienta.

FCM Omówienie lokalizacji

Aby zlokalizować aplikację, możesz wysłać klucz odpowiadający wpisowi zasobu tekstowego w aplikacji użytkownika. System operacyjny urządzenia obsługuje wyszukiwanie i wstawianie argumentów dynamicznych.

Krok 1. Zdefiniuj w aplikacjach zlokalizowane zasoby tekstowe

Aby rozpocząć lokalizację w FCM, musisz upewnić się, że masz niezbędne tłumaczenia dostępne w projektach na Androida i iOS.

Konfiguracja Androida

Zdefiniuj zasoby tekstowe: wpisz domyślne ciągi tekstowe w pliku res/values/strings.xml. Użyj specyfikatorów formatu (%1$s, %2$d itp.) dla wszystkich wartości dynamicznych, które chcesz przekazać w parametrze *_loc_args.

Domyślne (res/values/strings.xml):

<resources>
    <string name="welcome_title">Welcome, %1$s!</string>
    <string name="new_message_body">You have %1$d new message(s) from %2$s.</string>
</resources>

Dodaj tłumaczenia: utwórz katalogi dla poszczególnych języków, używając kodów języków ISO (np. values-fr dla francuskiego, values-es dla hiszpańskiego), i przetłumacz klucze.

Francuski (res/values-fr/strings.xml):

<resources>
    <string name="welcome_title">Bienvenue, %1$s!</string>
    <string name="new_message_body">Vous avez %1$d nouveau(x) message(s) de %2$s.</string>
</resources>

Więcej informacji znajdziesz w tych zasobach:

• Zasoby tekstowe – deweloperzy aplikacji na Androida

• Lokalizacja aplikacji – deweloperzy aplikacji na Androida

Konfiguracja iOS

Zdefiniuj zasoby tekstowe: zdefiniuj podstawowe ciągi tekstowe w pliku Localizable.strings (zwykle w folderze Base.lproj lub katalogu ciągów tekstowych). W przypadku wartości dynamicznych używaj specyfikatorów formatu (%@, %ld itp.). Klucze są często definiowane wielkimi literami.

Domyślny (angielski Localizable.strings):

"WELCOME_TITLE" = "Welcome, %@!";
"NEW_MESSAGE_BODY" = "You have %ld new message(s) from %@.";

Dodaj tłumaczenia: utwórz foldery .lproj dla poszczególnych języków (lub dodaj lokalizacje za pomocą katalogu ciągów tekstowych) i przetłumacz klucze.

Francuski (fr.lproj/Localizable.strings):

"WELCOME_TITLE" = "Bienvenue, %@!";
"NEW_MESSAGE_BODY" = "Vous avez %ld nouveau(x) message(s) de %@.";

Więcej informacji znajdziesz w tych zasobach:

• Lokalizacja – dokumentacja Apple dla deweloperów

• Zasoby tekstowe – dokumentacja dla deweloperów Apple

Krok 2. Utwórz ładunek wiadomości FCM

Podczas wysyłania powiadomienia za pomocą interfejsu FCM HTTP v1 API serwer tworzy pojedynczy ładunek, który używa kluczy zasobów (*_loc_key) i danych dynamicznych (*_loc_args) jako tablicy ciągów znaków.

Przykładowy ładunek HTTP v1 FCM

Klucze lokalizacji są umieszczane w blokach zastępowania dla konkretnych platform (android.notification i apns.payload.aps.alert).

{
  "message": {
    "token": "DEVICE_REGISTRATION_TOKEN",

    "android": {
      "notification": {
        // Android keys match strings.xml resource names
        "title_loc_key": "welcome_title",
        "title_loc_args": ["Alice"],
        "body_loc_key": "new_message_body",
        "body_loc_args": ["3", "Bob"]
      }
    },

    "apns": {
      "payload": {
        "aps": {
          "alert": {
            // iOS uses 'title-loc-key' and 'loc-key' (for the body)
            "title-loc-key": "WELCOME_TITLE",
            "title-loc-args": ["Alice"],
            "loc-key": "NEW_MESSAGE_BODY",
            "loc-args": ["3", "Bob"]
          }
        }
      }
    }
  }
}

Najważniejsze kwestie dotyczące argumentów ładunku

• Kolejność ma znaczenie: ciągi znaków w parametrze *_loc_args muszą być w dokładnie takiej kolejności, jakiej wymagają obiekty zastępcze w pliku zasobów tekstowych (np. %1$s, %2$s).

• Tylko ciągi znaków: wszystkie elementy w tablicy *_loc_args muszą być ciągami znaków, nawet jeśli reprezentują liczby (jak "3" w przykładzie). Ostateczną konwersję typu przeprowadza moduł formatowania ciągów znaków systemu operacyjnego klienta na podstawie specyfikatora formatu (%ld lub %1$d).

Krok 3. Przetwarzanie i wyświetlanie po stronie klienta

Gdy urządzenie otrzyma powiadomienie, automatycznie zostaną wykonane te czynności:

1. Sprawdzanie języka: urządzenie identyfikuje główny język użytkownika (np. niemiecki, włoski).

2. Wyszukiwanie klucza: system operacyjny używa wartości *_loc_key (welcome_title), aby wyszukać odpowiedni przetłumaczony ciąg znaków w plikach zasobów aplikacji dla ustawień regionalnych urządzenia.

3. Wstawianie argumentów: system operacyjny pobiera tablicę z *_loc_args (["Alice"]) i wstawia wartości do zlokalizowanego ciągu znaków, przestrzegając reguł formatowania języka (interpunkcja, kolejność słów itp.).

Dzięki temu każdy użytkownik otrzyma wiadomość dostosowaną do jego ustawień języka, z zachowaniem prawidłowej struktury językowej, a jednocześnie zachowany zostanie standardowy ładunek z serwera.

Przykład: powiadomienie z opcjami lokalizacji

Ten przykładowy kod wysyła powiadomienie do tematu Tech, w tym opcje lokalizacji, aby klient mógł wyświetlać zlokalizowane wiadomości. Oto przykład efektu wizualnego na urządzeniu użytkownika:

var topicName = 'industry-tech';

var message = {
  android: {
    ttl: 3600000,
    notification: {
      bodyLocKey: 'STOCK_NOTIFICATION_BODY',
      bodyLocArgs: ['FooCorp', '11.80', '835.67', '1.43']
    }
  },
  apns: {
    payload: {
      aps: {
        alert: {
          locKey: 'STOCK_NOTIFICATION_BODY',
          locArgs: ['FooCorp', '11.80', '835.67', '1.43']
        }
      }
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message": {
    "topic":"Tech",
    "android": {
      "ttl":"3600s",
      "notification": {
        "body_loc_key": "STOCK_NOTIFICATION_BODY",
        "body_loc_args": ["FooCorp", "11.80", "835.67", "1.43"]
      }
    },
    "apns": {
      "payload": {
        "aps": {
          "alert": {
            "loc-key": "STOCK_NOTIFICATION_BODY",
            "loc-args": ["FooCorp", "11.80", "835.67", "1.43"]
          }
        }
      }
    }
  }
}'

Więcej informacji znajdziesz w sekcjach AndroidNotification i ApnsConfig w dokumentacji referencyjnej HTTP v1, gdzie znajdziesz szczegółowe informacje o kluczach dostępnych w blokach dotyczących konkretnych platform w treści wiadomości. Klucze obsługiwane przez APNS znajdziesz w dokumentacji kluczy ładunku firmy Apple.