# gt-react: General Translation React SDK: msg
URL: https://generaltranslation.com/ja/docs/react/api/strings/msg.mdx
---
title: msg
description: msg()文字列関数のAPIリファレンス
---

{/* 自動生成: 直接編集しないでください。代わりに content/docs-templates/ のテンプレートを編集してください。 */}


## 概要

`msg` 関数は、文字列を翻訳対象としてマークし、エンコードする関数です。

```jsx
const encodedString = msg('Hello, world!');
```

エンコードされた文字列は、翻訳を取得するために [`useMessages`](/docs/react/api/strings/use-messages) フックに渡す必要があります。

<Callout>
  **エンコード:**
  `msg` は入力文字列をエンコードするため、JSX などで直接使うことはできません。
  元の文字列を取得したい場合は、[`decodeMsg`](#decodemsg) でデコードする必要があります。
</Callout>


## デコード [#decodemsg]

元の文字列を取得するには、[`decodeMsg`](#decodemsg) でデコードする必要があります

```jsx
import { msg, decodeMsg } from 'gt-react';
const encodedString = msg('Hello, world!');
const decodedString = decodeMsg(encodedString);
console.log(decodedString); // "Hello, world!"
```


## リファレンス

### パラメータ

| 名前         | 型                                                                              | 説明                            |
| ---------- | ------------------------------------------------------------------------------ | ----------------------------- |
| `content`  | `string`                                                                       | エンコードする文字列。                   |
| `options?` | [`InlineTranslationOptions`](/docs/react/api/types/inline-translation-options) | `msg` の動作をカスタマイズするための翻訳オプション。 |

### 戻り値

エンコードされた文字列。補間変数がある場合は、その値に置き換えられます。

***

## 挙動

### 本番環境

CD プロセスでは、`msg` 関数内のコンテンツはすべて、アプリケーションのデプロイ前に翻訳されます。
これにより、すべてのロケールで高速に読み込めますが、翻訳できるのはビルド時に判明しているコンテンツに限られます。

翻訳の生成後は、設定に応じて (1) CDN に保存されるか、(2) アプリのビルド出力に保存されます。
その後、翻訳済みコンテンツがユーザーに配信されます。
翻訳が見つからない場合は、元のコンテンツにフォールバックします。

必ず[こちらのデプロイガイド](/docs/react/tutorials/quickdeploy)に従ってください。

### 開発

開発中は、`msg` 関数が必要に応じてコンテンツを翻訳します。
これは、アプリが各言語でどのように表示されるかをプロトタイプで確認するのに便利です。
この動作を有効にするには、環境に Dev API キーを追加してください。

開発中にオンデマンド翻訳が行われる際は、遅延が発生します。
ただし、本番ビルドでは、コンテンツを明示的にオンデマンド翻訳しない限り、この遅延は発生しません。

***

## 例

### 基本的な使い方

`msg` を使って、文字列を翻訳対象として指定できます。

```jsx copy
import { msg, useMessages } from 'gt-react';

const encodedString = msg('Hello, world!');

export default function TranslateGreeting() {
  const m = useMessages();
  return (
    <p>
      {m(encodedString)}
    </p>
  );
}
```

注: &quot;Hello, world!&quot; はユーザーが優先する言語に翻訳されます。


### 変数の使用 [#variables]

辞書の翻訳に変数を渡せます。

```jsx copy
import { msg, useMessages } from 'gt-react';

const encodedString = msg('Hello, {name}!', { name: 'Alice' });

export default function TranslateGreeting() {
  const m = useMessages();

  return (
    <p>
      {m(encodedString)}
    </p>
  );
}
```

注: &quot;Alice&quot; は変数であるため、ユーザーが優先する言語には翻訳されません。


### ICU メッセージ形式を使用する

`gt-react` は ICU メッセージ形式をサポートしており、変数のフォーマットも可能です。

```jsx copy
import { msg, useMessages } from 'gt-react';

const encodedString = msg('There are {count, plural, =0 {no items} =1 {one item} other {{count} items}} in the cart', { count: 10 });

export default function TranslateGreeting() {
  const m = useMessages();
  return (
    <p>
      {m(encodedString)}
    </p>
  );
}
```

<Callout>
  ICU メッセージ形式 は、変数を柔軟に書式設定できる強力な形式です。
  詳しくは、[ICU メッセージ形式 のドキュメント](https://unicode-org.github.io/icu/userguide/format_parse/messages/)を参照してください。
</Callout>

***


## 注意事項

* `msg` 関数は、文字列を翻訳対象としてマークするための関数です。
* `msg` を使った文字列の翻訳は、runtime ではなくビルドプロセス中に行われます (development 時を除く) 。

## 次のステップ

* 文字列の翻訳については、[`useMessages`](/docs/react/api/strings/use-messages)を参照してください。