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

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


## 概要

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

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

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

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


## デコード [#decodemsg]

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

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


## リファレンス

### パラメーター

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

### 戻り値

エンコードされた文字列。補間変数がある場合は、その値が埋め込まれます。

***

## 挙動

### 本番環境

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

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

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

### 開発

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

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

***

## 例

### 基本的な使い方

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

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

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-next';

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

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

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

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


### ICUメッセージ形式の使用

`gt-next` は ICU メッセージ形式に対応しており、変数のフォーマットも可能です。

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

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 ではなくビルドプロセス中に行われます (開発時を除く) 。

## 次のステップ

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