Remote Catalog file reference
Look up the properties, validation rules, and CSV columns for the catalog item files that you deploy to the Remote Catalog from the Unity Editor.
Read time 4 minutesLast updated 9 days ago
When you create your Unity In-App Purchasing (IAP) Remote Catalog in the Unity Editor, you define your listings in files or in a file, and then deploy them from the Deployment window. For the steps, refer to Create your Remote Catalog.
.ucat.catalog.csvCatalog item properties
The following table describes the properties of a catalog item in the Inspector window. A file uses the same properties, so you can also edit the file directly.
.ucatProperty | Description |
|---|---|
| Script | The script that defines the catalog item. Unity sets this value. |
| Catalog Listing Id | The identifier you use to target this listing when you start a purchase. Unity sets this value from the file path. |
| SKU | The product's stock keeping unit (SKU). Unity sets this value from the file name. |
| Product Type | The type of IAP product. |
| Product Details | The information about the product, including:
|
| Pricing Details | The price information for the product, including:
|
| Image URL | The URL of the image to display for the product. |
| Webshop availability | Makes this listing available in your webshop catalog. |
| Store ID Overrides | Optional. Maps your listing to the Apple App Store, Google Play Store, Xbox Store, and Mac App Store, which have different naming requirements. Only use these fields if your SKU doesn't meet a store's requirements:
|
Catalog item validation rules
When you deploy a catalog item, Unity IAP validates its fields and reports any errors in the Deployment window. You can't deploy a catalog item until you fix its validation errors. Each field must meet the limits in the catalog schema, such as the required price and the maximum title length.
USDThe following rules also apply to catalog items that you define in a file or a file:
.ucat.catalog.csvField | Rule |
|---|---|
| Catalog Listing Id | Must start with |
| SKU | Optional. Defaults to the file name. |
| Badge | Optional. Unity IAP treats the badge as unset if its text is empty. |
| Store ID Overrides | Optional. Unity IAP ignores any override that has an empty value. |
| Purchase Limit | Optional. Set both a Period ( |
Catalog CSV columns
A file defines many catalog items in one file. Each row defines one listing for one language and currency. Unity IAP groups rows that share a into a single catalog item, and each item needs at least one row with the currency code.
.catalog.csvCatalogListingIdUSDThe following table describes the columns of a catalog CSV file:
Column | Description | Required |
|---|---|---|
| The catalog listing ID, which starts with | No |
| The product SKU. If empty, Unity IAP skips the listing with a warning and doesn't deploy it. | Yes |
| The product title for the row's language. | Yes |
| The product description. | No |
| The product subtitle. | No |
| The badge text. Leave empty for no badge. | No |
| The badge image URL. | No |
| The language code for the title, description, subtitle, and badge. Defaults to | No |
| The product type. Defaults to | No |
| The currency code for the row's price. Unity IAP skips the price if this column is missing. | No |
| The price amount. Unity IAP skips the price if this column is missing. | No |
| The price to display on your webshop. Use standard decimal currency format (for example, 9.99 converts to $9.99 in USD). | No |
| The product image URL. | No |
| The number of purchases each player can make per period. Set together with | No |
| The purchase limit period: | No |
Unity IAP reports a warning on the CSV item in the Deployment window for any row that uses an unknown product type or language, is missing a value, or duplicates a language or currency for the same product. When a product has duplicate rows for the same language or currency, Unity IAP uses the first row.
Sku