---
title: ZEPETO.Currency
slug: world-sdk-guide-ja/zepetocurrency
docTags: 
createdAt: 2026-09-04T05:53:49.117Z
---

| 型                                             | 説明                                                                                                               |
| --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| [BalanceRecord](./#balancerecord)             | 特定の通貨の残高情報。                                                                                                      |
| [BalanceResponse](./#balanceresponse)         | `BalanceResponse` クラスは、API 呼び出しの結果と残高情報を提供します。                                                                   |
| [BalanceListResponse](./#balancelistresponse) | `BalanceListResponse` クラスは、API 呼び出しの結果と残高情報のリストを提供します。                                                           |
| [CurrencyService](./#currencyservice)         | `CurrencyService` は、ZEPETO World の通貨に関連する操作を管理します。 このサービスにより、プレイヤーは ZEPETO の公式通貨 (ZEM) と World 内通貨の両方の残高を確認できます。 |
| [CurrencyError](./#currencyerror)             | 通貨関連のリクエストが失敗した理由を示すエラーコード。                                                                                      |

## BalanceRecord

`class`

特定の通貨の残高情報。

### プロパティ

| 名前         | 型        | 説明                                                |
| ---------- | -------- | ------------------------------------------------- |
| currencyId | `string` | World 内通貨の ID。ZEPETO の公式通貨 (ZEM) の場合は空文字列が設定されます。 |
| quantity   | `bigint` | その通貨におけるプレイヤーの残高。                                 |

## BalanceResponse

`class` · extends `ProductBaseResponse`

`BalanceResponse` クラスは、API 呼び出しの結果と残高情報を提供します。

### プロパティ

| 名前       | 型                                 | 説明    |
| -------- | --------------------------------- | ----- |
| currency | [BalanceRecord](./#balancerecord) | 残高情報。 |

## BalanceListResponse

`class` · extends `ProductBaseResponse`

`BalanceListResponse` クラスは、API 呼び出しの結果と残高情報のリストを提供します。

### プロパティ

| 名前         | 型                            | 説明                                           |
| ---------- | ---------------------------- | -------------------------------------------- |
| currencies | `Dictionary<string, bigint>` | World 内通貨の ID と、各通貨におけるプレイヤーの残高を対応付けたコレクション。 |

## CurrencyService

`class`

`CurrencyService` は、ZEPETO World の通貨に関連する操作を管理します。
このサービスにより、プレイヤーは ZEPETO の公式通貨 (ZEM) と World 内通貨の両方の残高を確認できます。

### メソッド

### GetUserCurrencyBalancesAsync

`static GetUserCurrencyBalancesAsync() → BaseRequest<BalanceListResponse>`

定義されているすべての World 内通貨の残高情報を非同期で取得するメソッドです。

**戻り値:** `BaseRequest<BalanceListResponse>` — `BaseRequest` オブジェクト。非同期処理が完了すると、`responseData` プロパティから `BalanceListResponse` オブジェクトにアクセスできます。

### GetUserCurrencyBalanceAsync

`static GetUserCurrencyBalanceAsync(currencyId: string) → BaseRequest<BalanceResponse>`

指定された通貨 ID に基づいて、特定の World 内通貨の残高を非同期で取得するメソッドです。

| パラメーター     | 型        | 説明         |
| ---------- | -------- | ---------- |
| currencyId | `string` | 取得する通貨の ID |

**戻り値:** `BaseRequest<BalanceResponse>` — `BaseRequest` オブジェクト。非同期処理が完了すると、`responseData` プロパティから `BalanceResponse` オブジェクトにアクセスできます。

### GetOfficialCurrencyBalanceAsync

`static GetOfficialCurrencyBalanceAsync() → OfficialCurrencyBalanceRequest`

ZEPETO の公式通貨 (ZEM) の残高を非同期で取得するメソッドです。

**戻り値:** `OfficialCurrencyBalanceRequest` — `OfficialCurrencyBalanceRequest` オブジェクト。非同期処理が完了すると、`responseData` プロパティから `BalanceResponse` オブジェクトにアクセスできます。

## CurrencyError

`enum`

通貨関連のリクエストが失敗した理由を示すエラーコード。

| 名前           | 値  | 説明                                  |
| ------------ | -- | ----------------------------------- |
| Unknown      | -1 | エラー: 不明なエラー。                        |
| NetworkError | 0  | エラー: 接続の切断や不安定な接続など、ネットワークに関連するエラー。 |