ドキュメント

In-App Purchasing

IAP Client API

IAP SDK API

Webshop Admin API

Webshop Client API

In-App Purchasing

Webshop カタログスキーリファレンス

Web ショップでの製品の表示をコントロールできるカタログフィールドがあります。
読み終わるまでの所要時間 8 分最終更新 2ヶ月前
Webshop は、プロジェクトのアプリ内課金 (IAP) カタログにプロダクトをレンダリングします。各プロダクトは標準の IAP カタログ項目で、カテゴリ、解像度像度画像、プロモーション処置、ディスプレイ順序、プロダクトごとのバッジなど、ウェブショップ固有のフィールドで拡張でき、ショップでプロダクトがどのように表示されるかをコントロールします。
このリファレンスでは、Webshop が各製品に対して読み取るフィールドを示します。各 IAP 製品が持つ基本カタログフィールドと、Webshop の拡張子フィールドです。Webshop 拡張子フィールドは、Webshop カタログに含める製品だけに適用されます。カタログの入手先と製品ディスプレイの仕組みについては、カタログと Webshop での支払い を参照してください。製品を作成する方法については、エディターでのカタログの作成 を参照してください。

プロダクトフィールド

これらはすべてのカタログ製品の基本フィールドです。

フィールド

Type (タイプ)

必須

説明

uSKU
stringはい製品の一意の識別子 (SKU)。
type
stringはい製品タイプ。
Consumable
、
NonConsumable
、または 
Subscription
。
imageUrl
stringいいえプロダクトカードに表示されるプロダクト画像の URL。
productDetails
arrayはいローカライズされたディスプレイ詳細。言語ごとに 1 エントリー。ローカライズ版製品詳細 を参照してください。
pricing
arrayはい通貨ごとの価格。価格設定 を参照してください。
storeIdOverrides
arrayいいえ別のストア固有のプロダクト ID。各エントリーには、
store
(
apple
または 
google
) と
value
があります。

ローカライズされた製品の詳細

productDetails
の各エントリーでは、1 つの言語で製品が説明されます。

フィールド

Type (タイプ)

必須

説明

language
stringはいこのエントリーが適用される言語。
title
stringはいプロダクトのディスプレイ名
description
stringはいプレイヤー向けの製品説明。
subtitle
stringいいえタイトルとともに表示される任意のセカンダリ行。
badge
objectいいえプロダクトカードに表示されるチップ。
text
（必須、最大 32 文字） と、テキストの横に表示されるアイコンの任意の
imageUrl
が含まれます。販売中かどうかにかかわらず、すべての製品にバッジを付けることができます。

価格設定

pricing
の各エントリーは、 1 つの通貨で価格を設定します 。配列は、
USD
に少なくとも 1 つのエントリーを含む必要があります。

フィールド

Type (タイプ)

必須

説明

currencyCode
stringはいISO 4217 通貨コード。例えば 
USD
や 
GBP
。
amount
integerはいプロダクトに課金される金額。
webshopPrice
integerいいえウェブショップで表示される価格。ウェブ固有の価格を設定する。
金額はマイクロ単位の整数です。1,000,000 は通貨の 1 単位です。例えば、
9990000
は 9.99 です。手動での価格設定ではなく、カタログツールでの価格設定 — エディターでカタログを作成する を参照してください。

Webshop 拡張子フィールド

これらのフィールドは、ウェブショップ固有のディスプレイオプションで基本カタログプロダクトを拡張します。Webshop カタログの製品に対してのみ効果を発揮します。

フィールド

Type (タイプ)

必須

説明

categories
文字列の配列いいえ製品が属するカテゴリ ID（最大 16、一意の ID）。それぞれが、Webshop 用に定義したカテゴリと一致する必要があります。
hdImages
arrayいいえ製品詳細ダイアログ用の高解像度画像 (最大 8 個)。各エントリーには、
url
（必須）と任意の
altText
があります。
promotion
objectいいえカードの昇格処理。
type
は 
Sale
、
Bonus
、または 
Limited
です。オプションの 
startsAt
フィールドと 
endsAt
フィールド（RFC 3339 date-times）は、処理が表示されるときにスケジュールします。
sortIndex
integerいいえショップ全体のプロダクトのディスプレイ順値が小さいほど最初に表示されます。

例

以下の製品には、 基本カタログフィールドと Webshop 拡張子フィールドの両方が含まれています 。
{  "uSKU": "com.example.gems.medium",  "type":"Consumable",  "imageUrl": "https://cdn.example.com/gems-medium.png",  "productDetails": [    {      "language": "en",      "title":"ミディアムジェムパック",      "description": "ゲームで使う宝石の便利な隠し場所",      "subtitle":"500 gems",      "badge": { "text":"Best value", "imageUrl": "https://cdn.example.com/gem-icon.png" }    }  ],  "pricing": [    { "currencyCode":"USD", "amount":9990000, "webshopPrice":"25270591"  ],  "categories": ["gems"],  "hdImages": [    { "url": "https://cdn.example.com/gems-medium-hd.png", "altText":"宝石の山" }  ],  "promotion": { "type":"Sale", "endsAt":"2026-07-01T00:00:00Z" },  "sortIndex":10}