Skip to content

Commit

Permalink
Moji: Update translations
Browse files Browse the repository at this point in the history
  • Loading branch information
boxmoji committed Oct 9, 2024
1 parent f8c3518 commit 804eafa
Show file tree
Hide file tree
Showing 145 changed files with 66 additions and 48 deletions.
42 changes: 30 additions & 12 deletions guides/api-calls/api-versioning-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ Boxは、1年に1回、APIエンドポイントに新しく重大な変更を行

安定した各バージョンは最低12か月間サポートされます。つまり、新しいバージョンがリリースされると、以前のバージョンは非推奨となり、使用することはできますが、新機能が追加されなくなります。また、12か月経たずに新しいバージョンがリリースされることはありません。

アプリを更新して最新の安定したAPIバージョンにリクエストを実行することを強くお勧めします。ただし、アプリで使用している安定したバージョンがサポートされなくなると、HTTPエラーコード`404 - Not Found`を含むレスポンスが返されます。詳細については、[バージョン管理のエラー](#versioning-errors)を参照してください。
アプリを更新して最新の安定したAPIバージョンにリクエストを実行することを強くお勧めします。ただし、アプリで使用している安定したバージョンがサポートされなくなると、HTTPエラーコード`400 - Bad Request`を含むレスポンスが返されます。詳細については、[バージョン管理のエラー](#versioning-errors)を参照してください。

リクエストにバージョンが含まれていない場合、APIはデフォルトのBox APIバージョン`V2`になります。ただし、非推奨の変更を適用するためにこの動作を利用することはお勧めしません。アプリを更新する際は、リクエストごとにAPIのバージョンを指定してください。アプリにバージョンを認識させることで、サポートされている期間中は同じように動作することが保証される特定の機能セットにコードを固定します。
If your request doesn't include a version, the API defaults to the initial Box API version—the version available before year-based versioning was introduced. However, relying on this behavior is not recommended when adopting deprecated changes. To ensure consistency, always specify the API version with each request. By making your application version-aware, you anchor it to a specific set of features, ensuring consistent behavior throughout the supported timeframe.

## APIバージョンの呼び出し

Expand All @@ -91,9 +91,31 @@ curl --location 'https://api.box.com/2.0/sign_requests' \

## バージョン管理のエラー

### URLでの正しくないAPIバージョンの呼び出し
### Calling an incorrect API version in the header

Boxのドキュメントでは、APIのURLが示されています。たとえば、署名リクエストのエンドポイントへのアクセスには`https://api.box.com/2.0/sign_requests/`を使用します。お客様が誤って`https://api.box.com/3.0/sign_requests/`のような正しくないバージョンを呼び出すと、レスポンスでは`HTTP error code 404 - Not Found`エラーが返されます。
If the API version provided in the `box-version` header is incorrect, the response will return an `HTTP 400 - Bad Request error`. The error response will have the following structure:

```json
{
"type": "error",
"status": 400,
"code": "invalid_api_version",
"message": "Some error message",
"context_info": {
"conflicts": [
"box_version value must be in the format of YYYY.MM"
]
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/versioning-errors/"
}

```

The error message will contain information about the error and possible correct values for the `box-version` header. For example:

* `The 'box-version' header supports only one header value per request, do not use comas.` - when the header contains multiple values separated by commas.
* `Missing required box-version header.` - when the header is missing but required.
* `Unsupported API version specified in 'box-version' header. Supported API versions: [LIST_OF_SUPPORTED_VERSIONS_COMA_SEPARATED]` - when the version specified is not supported by the API.

### 非推奨のAPIの呼び出し

Expand All @@ -107,10 +129,6 @@ Box-API-Deprecated-Reason: https://developer.box.com/reference/deprecated

お客様はAPIレスポンスを監視し、このヘッダーが表示されたら新しいAPIバージョンへの移行を計画する必要があることに留意する必要があります。

### 存在しないバージョンの呼び出し

公式サポートが終了した古いAPIバージョン (`2023.0`など) をお客様が使用しようとすると、レスポンスでは`HTTP error code 404 - Not Found`が返されます。詳細については、[URLでの正しくないAPIバージョンの呼び出し](#calling-an-incorrect-api-version-in-the-url)を参照してください。

## Box SDKのバージョン管理の仕組み

このバージョン戦略は、[次世代のSDK](https://developer.box.com/sdks-and-tools/#next-generation-sdks)にのみ適用されます。Box SDKは**すべてのバージョンに対応**というSDKのアプローチをサポートしています。つまり、SDKの各リリースでは、現在サポートされている任意のバージョンのすべてのエンドポイントにアクセスできます。生成されたすべてのSDKはマネージャのアプローチを使用します。このアプローチでは、同じドメインを使用するすべてのエンドポイントを1つのマネージャにグループ化します。たとえば、`FolderManager`には、`create_folder`、`get_folder_by_id`、`update_folder_by_id`、`delete_folder_by_id`、`get_folder_items`、`copy_folder`のメソッドが含まれます。この分割は`x-box-tag`フィールドの値に基づいて行われます (このフィールドは公開APIサービスの仕様で各メソッドに割り当てられています)。ほとんどの場合、これはエンドポイントURLのルートに対応していますが、必ずしもそうとは限りません。たとえば、`FolderManager`には`https://api.box.com/2.0/folders`というルートURLを使用するメソッドが含まれますが、同じベースURLは`SharedLinkFoldersManager`のいくつかのメソッドでも使用されています。すべてのマネージャへの参照は、1つのBoxクライアントオブジェクトの下に保存されます。
Expand Down Expand Up @@ -222,12 +240,12 @@ Box-API-Deprecated-Reason: https://developer.box.com/reference/deprecated

## バージョン管理に関する考慮事項

リクエストの作成時には、以下の点を考慮してください。
When building your request, consider the following:

* バージョンを指定しないと、サービスによってデフォルトのバージョンが返されますが、これは最新バージョンではない場合があります。
* If you do not specify a version, the service will return the initial version—the version that existed before year-based versioning was introduced. If the initial version does not exist, the response will return an HTTP error code 400 - Bad Request.
* If the version header is specified but the requested version is unavailable, the response will return an HTTP error code 400 - Bad Request.

* バージョンヘッダーがない場合、デフォルトのリソースバージョンは、URLに含まれるバージョンによって決まります。
* バージョンヘッダーが指定されていても、リクエストされたバージョンを利用できない場合、レスポンスではHTTPエラーコード`404 - Not Found`が返されます。
You can check [Versioning Errors](#versioning-errors) for more information.

APIに含まれるリソースまたはリソースのプロパティが非推奨になると、その変更は以下の1つ以上の方法で伝えられます。

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/api-calls/permissions-and-errors/images/Report-Details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/applications/app-center/images/app-center.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/applications/app-types/images/app-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/applications/app-types/images/app-types-unselected.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/applications/app-types/images/app-types.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/applications/app-types/images/select-app-type.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/applications/app-types/images/skill-name.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/applications/images/my-apps-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/authentication/images/app-access-level.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/authentication/images/app-authorization.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/authentication/images/app-redirect-uri-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/authentication/images/app-redirect-uri-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/authentication/images/app-scopes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/authentication/images/custom-app-selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/authentication/images/developer-token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/authentication/images/jwt-three-options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/authentication/images/limited-access-naming.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/authentication/images/select-app-type.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/authentication/jwt-flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified guides/authentication/jwt/jwt-flow.png
Binary file modified guides/authentication/oauth2/oauth2-flow.png
Binary file modified guides/authentication/tokens/downscope.png
Binary file modified guides/authorization/images/admin_error.png
Binary file modified guides/authorization/images/app_authorization.png
Binary file added guides/authorization/images/app_enablement.png
Binary file modified guides/authorization/images/jwt_app_approval_flow.png
Binary file modified guides/authorization/images/oauth_app_approval_flow.png
Binary file modified guides/authorization/images/reauthorize_app.png
Binary file modified guides/authorization/images/something_went_wrong.png
Binary file modified guides/authorization/images/unable_to_retreive.png
4 changes: 2 additions & 2 deletions guides/box-ai/extract-metadata-structured.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ curl --location 'https://api.box.com/2.0/ai/extract_structured' \
```
レスポンスには、以下のように、指定したフィールドとその値が示されます。
応答には、以下のように、指定したフィールドとその値が示されます。
```bash
{
Expand Down Expand Up @@ -175,7 +175,7 @@ curl --location 'https://api.box.com/2.0/ai/extract_structured' \
```
レスポンスには、以下のように、メタデータテンプレートに含まれているフィールドとその値が示されます。
応答には、以下のように、メタデータテンプレートに含まれているフィールドとその値が示されます。
```bash
{
Expand Down
4 changes: 2 additions & 2 deletions guides/box-ai/extract-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ curl --location 'https://api.box.com/2.0/ai/extract' \

```

レスポンスには、以下のように、ファイル内に存在するフィールドとその値が含まれます。
応答には、以下のように、ファイル内に存在するフィールドとその値が含まれます。

```bash
{
Expand Down Expand Up @@ -159,7 +159,7 @@ curl --location 'https://api.box.com/2.0/ai/extract' \

```

その場合、レスポンスは、クエリに含まれているキーワードに基づいて作成されます。
その場合、応答は、クエリに含まれているキーワードに基づいて作成されます。

```bash
{
Expand Down
Binary file modified guides/box-ai/images/box-ai-app-scopes.png
Binary file modified guides/box-ai/images/box-ai-in-doc.png
Binary file added guides/box-ai/images/sample-invoice.png
Binary file modified guides/box-sign/images/multiple_signer_flow.png
Binary file modified guides/cli/images/app-authorized.png
Binary file modified guides/cli/images/cli-config-diagram.png
Binary file modified guides/cli/images/cli-env-setup.png
Binary file modified guides/cli/images/cli-grant-access.png
Binary file modified guides/cli/images/final-folder-structure.png
Binary file modified guides/embed/box-view/images/box-view-flow.png
Binary file modified guides/embed/embed-configuration.png
Binary file added guides/embed/ui-elements/images/ai-icon.png
Binary file added guides/embed/ui-elements/images/box-app-cors.png
Binary file modified guides/embed/ui-elements/images/downscope-2.png
Binary file added guides/internal-documentation/ui-elements/box.jpg
6 changes: 3 additions & 3 deletions guides/metadata/fields/date.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Boxウェブアプリでは日付が日付選択機能として表示されま

`date`フィールドは、[メタデータテンプレートの作成][g_create_template]時、または`addField`操作による[テンプレートの更新][g_update_template]時にメタデータテンプレートに追加できます。

`date`フィールドの必須属性は、`type``displayName`、および`key`です。
The required attributes for a `date` field are a `type`, a `displayName`, and a `key`.

```json
{
Expand All @@ -61,13 +61,13 @@ Boxウェブアプリでは日付が日付選択機能として表示されま

```

必要に応じて、UIでユーザーに表示される`description`を指定できます。また、このフィールドを`hidden`に設定して、ウェブアプリとモバイルアプリでユーザーに表示されないようにすることもできます。
Optionally, a `description` can be provided that is shown to a user in the UI, and the field can be set to `hidden` to hide it from users in the web and mobile apps.

## 日付フィールドの更新

`date`テンプレートフィールドは、このフィールドが属する[テンプレートを更新][g_update_template]することで更新できます。テンプレートの更新は、ファイルまたはフォルダにすでに割り当てられているテンプレートも確実に更新される**操作**によって行われます。

`date`メタデータフィールドを更新する際、関連する操作は、フィールドの`key``displayName``description`、および`hidden`の値を変更するのに使用できる`editField`操作のみです。
When updating a `date` metadata field, the only relevant operation is the `editField` operation, which can be used to change the field's `key`, `displayName`, `description`, and `hidden` values.

```json
[
Expand Down
10 changes: 5 additions & 5 deletions guides/metadata/fields/enum.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ fullyTranslated: true

<Message notice>

`enum`を使用すると、ユーザーは0個または1個の値を選択できます。ユーザーが複数の値を選択できるようにするには、[`multiSelect`][g_multi_select]テンプレートフィールドを使用します。
An `enum` allows a user to select zero or a single value. To allow a user to select multiple values, use the [`multiSelect`][g_multi_select] template field.

</Message>

## `enum`フィールドの作成

`enum`フィールドは、[メタデータテンプレートの作成][g_create_template]時、または`addField`操作による[テンプレートの更新][g_update_template]時にメタデータテンプレートに追加できます。

`enum`フィールドの必須属性は、`type``displayName``key`、およびオプションのリストです。
The required attributes for an `enum` field are a `type`, a `displayName`, a `key`, and a list of options.

```json
{
Expand All @@ -66,15 +66,15 @@ fullyTranslated: true

```

必要に応じて、UIでユーザーに表示される`description`を指定できます。また、このフィールドを`hidden`に設定して、ウェブアプリとモバイルアプリでユーザーに表示されないようにすることもできます。
Optionally, a `description` can be provided that is shown to a user in the UI, and the field can be set to `hidden` to hide it from users in the web and mobile apps.

## `enum`フィールドの更新

`enum`テンプレートフィールドは、このフィールドが属する[テンプレートを更新][g_update_template]することで更新できます。テンプレートの更新は、ファイルまたはフォルダにすでに割り当てられているテンプレートも確実に更新される**操作**によって行われます。

### 基本的なフィールド値の変更

`enum`メタデータフィールドを更新する際に可能な操作の1つとして、フィールドの`key``displayName``description`、および`hidden`の値を変更するのに使用できる`editField`操作があります。
When updating an `enum` metadata field, one of the possible operations is the `editField` operation, which can be used to change the field's `key`, `displayName`, `description`, and `hidden` values.

```json
[
Expand Down Expand Up @@ -219,7 +219,7 @@ fullyTranslated: true

### オプションの削除

`enum`フィールドからオプションを削除するには、`removeEnumOption`操作を使用します。この操作では、`fieldKey`に、変更する`enum`フィールドのキーを設定し、`enumOptionKey`に、削除するフィールドオプションのキーを設定します。
Removing an option from an `enum` field can be achieved through the `removeEnumOption` operation. The operation expects the `fieldKey` to be set to the key of the `enum` field to change, and an `enumOptionKey` to be set to the key of the field option to remove.

```json
[
Expand Down
6 changes: 3 additions & 3 deletions guides/metadata/fields/float.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ fullyTranslated: true

`float`フィールドは、[メタデータテンプレートの作成][g_create_template]時、または`addField`操作による[テンプレートの更新][g_update_template]時にメタデータテンプレートに追加できます。

`float`フィールドの必須属性は、`type``displayName`、および`key`です。
The required attributes for a `float` field are a `type`, a `displayName`, and a `key`.

```json
{
Expand All @@ -55,13 +55,13 @@ fullyTranslated: true

```

必要に応じて、UIでユーザーに表示される`description`を指定できます。また、このフィールドを`hidden`に設定して、ウェブアプリとモバイルアプリでユーザーに表示されないようにすることもできます。
Optionally, a `description` can be provided that is shown to a user in the UI, and the field can be set to `hidden` to hide it from users in the web and mobile apps.

## 浮動小数点フィールドの更新

`float`テンプレートフィールドは、このフィールドが属する[テンプレートを更新][g_update_template]することで更新できます。テンプレートの更新は、ファイルまたはフォルダにすでに割り当てられているテンプレートも確実に更新される**操作**によって行われます。

`float`メタデータフィールドを更新する際、関連する操作は、フィールドの`key``displayName``description`、および`hidden`の値を変更するのに使用できる`editField`操作のみです。
When updating a `float` metadata field, the only relevant operation is the `editField` operation, which can be used to change the field's `key`, `displayName`, `description`, and `hidden` values.

```json
[
Expand Down
14 changes: 7 additions & 7 deletions guides/metadata/fields/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ fullyTranslated: true

すべてのメタデータテンプレートには`field`オブジェクトのリストが含まれており、各フィールドは次のいずれかのタイプになります。

| | |
| ------------------------------------------------- | ---------------------- |
| [`string`](g://metadata/fields/string) | テキストフィールド |
| [`float`](g://metadata/fields/float) | 数値入力フィールド |
| [`date`](g://metadata/fields/date) | 日付選択フィールド |
| [`enum`](g://metadata/fields/enum) | 1つの値を選択するためのドロップダウンリスト |
| [`multiSelect`](g://metadata/fields/multi-select) | 複数の値を選択するためのドロップダウンリスト |
| | |
| ------------------------------------------------- | -------------------------------------------- |
| [`string`](g://metadata/fields/string) | テキストフィールド |
| [`float`](g://metadata/fields/float) | 数値入力フィールド |
| [`date`](g://metadata/fields/date) | 日付選択フィールド |
| [`enum`](g://metadata/fields/enum) | A dropdown list for selecting a single value |
| [`multiSelect`](g://metadata/fields/multi-select) | 複数の値を選択するためのドロップダウンリスト |

## 基本的なフィールドタイプ

Expand Down
Loading

0 comments on commit 804eafa

Please sign in to comment.