# General Translation Python SDKs: msg
URL: https://generaltranslation.com/ja/docs/python/reference/functions/msg.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: General Translation Python で、メッセージとその翻訳オプションをエンコードされた文字列として登録します。msg の API リファレンス。

メッセージとその翻訳オプションをまとめて保持するエンコードされた文字列を返すため、後でデコードして解決できます。メッセージをある場所で組み立て、別の場所で解決する場合に使用します。

## 概要 [#overview]

`msg` は、ソース文字列と任意の変数または予約済みオプションを指定して呼び出します。キーワード引数がない場合は、メッセージをそのまま返します。オプションがある場合は、[`m_fallback`](/docs/python/reference/functions/m-fallback)、[`decode_msg`](/docs/python/reference/functions/decode-msg)、および [`decode_options`](/docs/python/reference/functions/decode-options) で読み取れる、エンコード済みの `{interpolated}:{base64options}` 文字列を返します。

```python
from gt_i18n import msg

msg("Save", _context="button")
```

シグネチャ:

```python
msg(message: str, **kwargs: object) -> str
```

`gt_i18n` から `msg` をインポートします。`msg` はフレームワークのパッケージからは再エクスポートされません。

## 動作の仕組み [#how-it-works]

* **オプションなしの場合のショートカット。** `kwargs` が空なら、`message` は変更せずそのまま返されます。
* **補間。** 人が読めるプレフィックス用に、ユーザー変数 (予約済みのキーは除外) でメッセージを補間します。
* **エンコード。** メッセージハッシュを計算し (または渡された `__hash` を再利用し) 、すべての `kwargs` に `__source` と `__hash` を加えた JSON オプションのペイロードを base64 エンコードして、`"{interpolated}:{encoded}"` を返します。
* **エラー時の安全性。** 補間に失敗した場合は、元のメッセージを返します。

## パラメータ [#parameters]

| パラメータ                 | 説明                                                    | 型       | 任意  | デフォルト |
| --------------------- | ----------------------------------------------------- | ------- | --- | ----- |
| [`message`](#message) | ICU MessageFormat のソース文字列。                            | `str`   | いいえ | —     |
| [`kwargs`](#kwargs)   | 補間変数と予約済みの GT オプション (`_context`、`_id`、`_max_chars`) 。 | キーワード引数 | はい  | —     |

### `message` [#message]

**型** `str` · **必須**

登録する ICU MessageFormat のソース文字列です。

### `kwargs` [#kwargs]

**Type** キーワード引数 · **任意**

補間変数と、ハッシュに組み込まれる予約済みオプション `_context`、`_id`、`_max_chars`。エンコードされたペイロードには、すべてのキーが保持されます。

## 戻り値 [#returns]

**Type** `str`

オプションが指定されていない場合はメッセージをそのまま返し、指定されている場合はエンコードされた `{interpolated}:{base64options}` 文字列を返します。

## 例 [#example]

```python
from gt_i18n import msg, decode_msg, decode_options

encoded = msg("Hi, {name}!", name="Bob", _id="greet")
decode_msg(encoded)      # "Hi, Bob!"
decode_options(encoded)  # {"name": "Bob", "_id": "greet", "__source": "Hi, {name}!", "__hash": "..."}
```

## Sitemap

See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.