Documentation

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
.ucat
files or in a
.catalog.csv
file, and then deploy them from the Deployment window. For the steps, refer to Create your Remote Catalog.

Catalog item properties

The following table describes the properties of a catalog item in the Inspector window. A
.ucat
file uses the same properties, so you can also edit the file directly.

Property

Description

ScriptThe script that defines the catalog item. Unity sets this value.
Catalog Listing IdThe identifier you use to target this listing when you start a purchase. Unity sets this value from the file path.
SKUThe product's stock keeping unit (SKU). Unity sets this value from the file name.
Product TypeThe type of IAP product.
Product DetailsThe information about the product, including:
  • Title
  • Description
  • Language
  • Subtitle
  • Badge (Text and Image URL)
Pricing DetailsThe price information for the product, including:
  • Currency Code
  • Amount
  • Webshop Price (if it differs from the standard price)
Image URLThe URL of the image to display for the product.
Webshop availabilityMakes this listing available in your webshop catalog.
Store ID OverridesOptional. 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:
  • Apple Override
  • Google Override
  • Xbox Store Override
  • Mac App Store Override

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
USD
price and the maximum title length.
The following rules also apply to catalog items that you define in a
.ucat
file or a
.catalog.csv
file:

Field

Rule

Catalog Listing IdMust start with
catalog/
, followed by the
.ucat
file name without the extension. The part after
catalog/
follows the same character rules as the SKU.
SKUOptional. Defaults to the file name.
BadgeOptional. Unity IAP treats the badge as unset if its text is empty.
Store ID OverridesOptional. Unity IAP ignores any override that has an empty value.
Purchase LimitOptional. Set both a Period (
Hour
,
Day
, or
Month
) and a Count of 1 or more, or set Period to None for no limit. Refer to Limit purchases per player.

Catalog CSV columns

A
.catalog.csv
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
CatalogListingId
into a single catalog item, and each item needs at least one row with the
USD
currency code.
The following table describes the columns of a catalog CSV file:

Column

Description

Required

CatalogListingId
The catalog listing ID, which starts with
catalog/
. If empty, Unity IAP uses
catalog/
followed by the
Sku
value.
No
Sku
The product SKU. If empty, Unity IAP skips the listing with a warning and doesn't deploy it.Yes
Title
The product title for the row's language.Yes
Description
The product description.No
Subtitle
The product subtitle.No
BadgeText
The badge text. Leave empty for no badge.No
BadgeImageUrl
The badge image URL.No
Language
The language code for the title, description, subtitle, and badge. Defaults to
en-US
.
No
ProductType
The product type. Defaults to
Consumable
.
No
CurrencyCode
The currency code for the row's price. Unity IAP skips the price if this column is missing.No
Amount
The price amount. Unity IAP skips the price if this column is missing.No
WebshopPrice
The price to display on your webshop. Use standard decimal currency format (for example, 9.99 converts to $9.99 in USD).No
ImageUrl
The product image URL.No
PurchaseLimitCount
The number of purchases each player can make per period. Set together with
PurchaseLimitPeriod
.
No
PurchaseLimitPeriod
The purchase limit period:
Hour
,
Day
, or
Month
. Set together with
PurchaseLimitCount
. Leave both empty for no limit.
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
Sku
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.