あなたの世界を作りなさい
経済
ギフティングAPI
10分
ZEPETO World内の他のユーザーに衣服アイテムを贈るために、ギフティングAPIを使用できます。
ただし、APIを使用する際には、送信者のアイテムが差し引かれます。
ウィンドウ → パッケージマネージャー → ZEPETO.Worldパッケージを最初にバージョン1.21.14以上をインストールしてください。
その後、バージョン1.0.7以上の‘ZEPETO.Module’パッケージをインストールしてください。
ZEPETOアプリがバージョン3.46.000以上で動作していることを確認してください。

ギフティングAPIを使用するには、以下のインポート文を追加してください。
TypeScript
1import { GiftBackgroundType, ShopService, ItemGiftResponse } from 'ZEPETO.Module.Shop';
ギフティングAPIに興味がある場合は、ドキュメントを参照してください:
📘 次のガイドを参照してください。 [ZEPETO.Module.Shop API]
- Unityエディタでは、成功と失敗の両方のケースをテストできます。ギフティングが成功しても、通貨は差し引かれず、ギフトは受取人に配信されません。
- QRコードやテストリンクを介したモバイルテスト中に、成功した取引は実際の通貨の差し引きが行われ、ギフトは受取人に配信されます。
- キャンバスにギフト送信ボタンを追加してください。
- 以下のようにサンプルコードを書いてください。
TypeScript
1import { ZepetoScriptBehaviour } from 'ZEPETO.Script';
2import { GiftBackgroundType, ShopService, ItemGiftResponse } from 'ZEPETO.Module.Shop';
3import { Button } from 'UnityEngine.UI';
4import { ErrorCode } from 'ZEPETO.Module';
5
6export default class SendGift extends ZepetoScriptBehaviour {
7
8 public itemId : string;
9 public targetUserId : string;
10 public sendGiftButton : Button;
11
12 Start() {
13 this.sendGiftButton.onClick.AddListener(()=>{
14 ShopService.ShowGiftPopup(
15 this.itemId,
16 this.targetUserId,
17 GiftBackgroundType.Type01,
18 "こんにちは、これはあなたのためです!",
19 (response: ItemGiftResponse) => { // onComplete コールバック
20 console.log(`ギフトが正常に送信されました! ZEPETOコイン残高 ${response.coin}, ZEM残高 ${response.zem}`);
21 },
22 (error: ErrorCode) => { // onFailure コールバック
23 console.error("ギフト送信エラー:", error);
24 }
25 );
26 });
27 }
28}
- スクリプトを書いた後、インスペクターでボタンを接続し、ギフトを受け取る人のユーザーIDとアイテムIDを入力してください。
📘 Zepeto PlayerのUserIdを取得する方法については、以下のガイドを参照してください。[ZEPETOプレーヤー]
- 成功または失敗のケースをテストするために、QRコードを作成し、モバイルデバイスでテストしてください。
- ただし、送信者の商品の金額が差し引かれることに注意してください。
- ボタンをクリックすると、ギフト送信のためのポップアップUIが表示されます。

- ギフトが正常に送信された場合、成功を示すトーストUIが表示され、サンプルスクリプトがログを生成します。


- さらに、targetUserのためのギフトが届きました。

- ケースがErrorCodeに該当する場合、エラーメッセージがToast UIに表示され、サンプルスクリプトが対応するエラーコードを出力します。

