# General Translation Platform: ファイルを公開
URL: https://generaltranslation.com/ja/docs/platform/openapi/reference/files/publish-files.mdx
---
title: ファイルを公開
description: General Translation プロジェクトの翻訳済みファイルを公開済みにして、配信できるようにします。ファイル公開の API リファレンス。

method: POST
---

翻訳済みファイルを General Translation CDN で公開または非公開にします。配信を制御するには、ファイルごとに `publish` を設定します。結果はファイルごと・ロケールごとに返されます。

## 概要 [#overview]

```http
POST https://api2.gtx.dev/v2/project/files/publish
```

**権限** `project:files:write` · **レート制限** デフォルト (200/分) 

CDN が配信する翻訳を制御します。プロジェクトで CDN が有効になっている必要があります。

## 仕組み [#how-it-works]

* プロジェクトで CDN が有効になっている必要があります。そうでない場合、リクエストは `400` エラーになります。
* 各ファイルについて、ソースファイルの公開状態が更新されます。その後、そのファイルの完了済みの各翻訳が公開または非公開にされ、対応する CDN キャッシュエントリが作成または削除されます。
* `publish` が `true` の場合、翻訳データが欠けているか、公開するにはサイズが大きすぎると、そのロケールは失敗として報告されます。以前に公開されていたサイズ超過のファイルも非公開になります。
* `publish` が `false` の場合、翻訳は非公開にされ、CDN キャッシュから削除されます。
* 処理はファイル単位かつロケール単位で行われるため、レスポンスには処理対象となった各翻訳ごとに 1 つの結果エントリが含まれます。ソースファイルが見つからない場合は、リクエスト全体を失敗させるのではなく、失敗結果として報告されます。

## リクエスト [#request]

### ヘッダー

| ヘッダー              | 説明                           | 必須  |
| ----------------- | ---------------------------- | --- |
| `x-gt-api-key`    | プロジェクトまたは組織の API キー。         | はい  |
| `x-gt-project-id` | プロジェクト ID。組織のキーを使用する場合に必要です。 | いいえ |

### リクエスト本文

**コンテンツタイプ** `application/json`

| フィールド             | 説明                          | Type       | 任意  | デフォルト |
| ----------------- | --------------------------- | ---------- | --- | ----- |
| [`files`](#files) | 公開または公開解除するファイルの配列。空にできません。 | `object[]` | いいえ | —     |

#### `files` [#files]

**型** `object[]` · **必須**

各要素は、ファイルとその公開状態を指定します。

| Field       | Description              | Type      | Optional | Default   |
| ----------- | ------------------------ | --------- | -------- | --------- |
| `fileId`    | 不変のファイル識別子。              | `string`  | いいえ      | —         |
| `versionId` | このコンテンツのバージョン識別子。        | `string`  | いいえ      | —         |
| `publish`   | `true` で公開、`false` で非公開。 | `boolean` | いいえ      | —         |
| `branchId`  | ファイルが紐付けられているブランチ。       | `string`  | はい       | デフォルトブランチ |

## レスポンス [#response]

**ステータス** `200 OK`

```json title="Response"
{
  "results": [
    {
      "fileId": "file_...",
      "versionId": "ver_...",
      "locale": "es",
      "branchId": "br_...",
      "success": true
    }
  ]
}
```

## エラー [#errors]

| ステータス | 原因                                       |
| ----- | ---------------------------------------- |
| `400` | リクエストボディが無効であるか、プロジェクトで CDN が有効化されていません。 |
| `401` | API キーがないか、無効です。                          |
| `403` | API キーに `project:files:write` 権限がありません。   |
| `429` | レート制限を超えました。                             |

## 例 [#example]

```bash
curl -X POST https://api2.gtx.dev/v2/project/files/publish \
  -H "x-gt-api-key: gtx-api-..." \
  -H "Content-Type: application/json" \
  -d '{
    "files": [
      {
        "fileId": "file_...",
        "versionId": "ver_...",
        "publish": true
      }
    ]
  }'
```