# General Translation Platform: TranslationResult
URL: https://generaltranslation.com/ja/docs/platform/core/reference/types/translation-result.mdx
---

title: TranslationResult
description: General Translation の翻訳メソッドが返す、成功またはエラーを表す結果です。TranslationResult 型の API リファレンス。

---

[`translate`](/docs/platform/core/reference/gt-class-methods/translation/translate) や [`translateMany`](/docs/platform/core/reference/gt-class-methods/translation/translate-many) などの翻訳メソッドの結果です。成功結果とエラー結果からなる判別可能なユニオン型です。

## 概要 [#overview]

`TranslationResult` は、`success` ブール値を判別子とするユニオン型です。`success` で絞り込むと、翻訳結果またはエラーのどちらかにアクセスできます。

```typescript
type TranslationResult = RequestSuccess | TranslationError;
```

## メンバー [#members]

| メンバー                                     | 説明                                | 型        |
| ---------------------------------------- | --------------------------------- | -------- |
| [`RequestSuccess`](#request-success)     | 翻訳成功時の情報で、翻訳済みコンテンツとロケールを含みます。    | `object` |
| [`TranslationError`](#translation-error) | 翻訳失敗時の情報で、エラーメッセージとステータスコードを含みます。 | `object` |

### `RequestSuccess` [#request-success]

**型** `object`

`success` が `true` の場合に返されます。翻訳済みコンテンツと、解決された対象 `ロケール` が含まれます。

```typescript
type RequestSuccess = TypedResult & {
  success: true;
  locale: string; // 解決されたターゲットロケール
};
```

### `TranslationError` [#translation-error]

**型** `object`

`success` が `false` のときに返されます。人が読める形式の `error` メッセージと、数値の `code` が含まれます。

```typescript
type TranslationError = {
  success: false;
  error: string; // エラーメッセージ
  code: number; // ステータスコード
};
```

## 例 [#example]

```typescript
import { GT } from 'generaltranslation';
import { TranslationResult } from 'generaltranslation/types';

const gt = new GT({ apiKey: 'your-api-key', projectId: 'your-project-id' });

const result: TranslationResult = await gt.translate('Hello', 'es');

if (result.success) {
  console.log(`Translation: ${result.translation}`); // result.translation と result.locale が利用可能
} else {
  console.error(`Translation failed: ${result.error} (${result.code})`); // result.error と result.code が利用可能
}
```