Important |
---|
The Unity Distribution Portal (UDP) is shutting down on February 17th, 2025. Access to the UDP Web console and services will be permanently deactivated on this date. To download your keystores and instructions on how to republish your games directly to app stores, visit the UDP overview page. If you have any questions about your account, submit a ticket with Unity Customer Support. |
The recommended best practice is to add and manage your IAP products in the UDP console. The IAP Catalog in the UDP console is the source of truth for what’s submitted to the store’s back-end systems. Additionally, the UDP console lets you:
Note: If you are using the UDP package only, you should still create at least one IAP item in the Unity Editor to test that it can sync with the UDP console correctly.
If you are using the Unity IAPAbbreviation of Unity In App Purchase
See in Glossary package (codeless implementation), you must add each IAP item in the Unity Editor and upload them all to the UDP console. If you are using the Unity IAP package and have implemented IAP in code, create the IAP items in the UDP console.
If you maintain an IAP Catalog in your game client, UDP keeps it synchronized between the Unity Editor and the UDP console.
In the UDP console, access your game through the My Games page. In the Game Info page, select the EDIT INFO button to enter edit mode. To save changes select SAVE. To discard your changes, select CANCEL. This section covers how to edit, create and delete IAP products from the UDP console.
To create new IAP items in the UDP console:
Note: If you have many IAP items to create, consider using the Bulk IAP Import feature to create all your IAP items at once, including localized description and pricing in multiple currencies.
If using the UDP package, any new IAP items you add in the Console are synced to your Unity project. You don’t need to rebuild your game to include them.
To edit IAP descriptions, proceed as follows.
Note: The above steps only edit your IAP item information for the language selected. If you have a large number of IAP items and languages to support, consider using Bulk IAP Import to import this information.
Hint: To set currencies as favourite currencies, select the star icon next to their currency code. This pins the currency to the top of the list. Deselect the star to unpin.
Note: If you have many IAP items and currencies to support, you can use the Convert function to automatically convert all your IAP prices into global currencies, based on the USD amount set for each IAP item. This overrides any local prices you have previously set.
Alternatively, use Bulk IAP Import to import all this information at once.
If you have already published your game on Google Play, you can import the basic information using your game’s Google Play URL:
&hl=it
.The Bulk IAP Import feature makes it easier to manage your IAP Catalog if you have a lot of IAP items. This lets you upload CSV files in the regular UDP format and in Google Play format to the UDP Console with all your IAP product details, including prices in multiple currencies and descriptions in multiple languages.
Unity recommends that you still add an IAP item in the Unity Editor for testing purposes to ensure you can purchase an IAP item in the sandbox environment.
Note: If your CSV file contains multiple languages, add the supported languages before you import the CSV file.
This section describes how to import your IAP items in bulk via CSV.
You should only use the Bulk IAP Import function to add new IAP products if you implemented UDP:
Unity recommends that you still add an IAP item in the Unity Editor for testing purposes to ensure you can purchase an IAP item in the sandbox environment.
For all implementations, you can use Bulk IAP Import to assign descriptions in more languages and prices in more currencies to your existing IAP products.
You can use Bulk IAP Import to entirely redefine your game’s IAP Catalog without having to rebuild your game.
You only need to have a UDP implementation in good working order.
With Unity IAP, you can only sync your IAP Catalog from the Editor to the UDP Console.
If you will upload your game’s IAP Catalog to the UDP Console via Bulk IAP Upload, you should prepare your game to fetch IAP product information from the UDP Console, rather than from the game client’s default IAP Catalog.
To allow your game to fetch the IAP Catalog from the UDP console, do not invoke any IAP product retrieval method in your code.
For more information, see Querying IAP inventory.
UDP provides a CSV template you can use for bulk import of IAP products. The template is in the regular UDP format for CSV files.
CSV files use commas (,) and semicolons (;) to separate data values. Commas separate primary data values, and semicolons separate subvalues.
Each IAP item must appear entirely on a single line within the CSV file.
You must enter data in the exact format of the template provided. The UDP console displays an error message if you upload a file that contains errors, such as invalid price syntax or missing languages.
Note: Uploading a CSV file entirely overwrites this revision’s IAP catalog. The UDP console only uses the information contained in your CSV file; any other IAP information you previously entered via the UDP console is lost.
To re-use or modify an existing IAP Catalog:
The EXPORT CATALOG button is only shown if you have IAP products in your IAP Catalog, and is only visible in edit mode. The image below shows this button in the In-App Purchases section.
UDP also supports CSV files in Google Play format.
To import IAP products using a Google Play CSV file:
Google Play sets pricing by country, UDP sets pricing by currency. Therefore the import maps countries to currencies. If for an IAP product you’ve set different prices across countries using the same currency (for example, EUR in European countries) UDP uses the first country in the list for the currency. If there are several countries with USD listed, the US locale is used.
UDP does not support Google Play’s pricing templates. This setting is ignored. UDP only uses the local prices provided in the CSV file.
UDP uses USD as its default currency. If you don’t have USD pricing on Google Play, UDP converts your Google Play default pricing and currency into USD and uses this as the UDP default pricing.
Local prices that are set in your CSV file are maintained in their respective currencies.
For countries that aren’t explicitly set in the CSV file, UDP converts your Google Play default pricing and currency into their respective currencies.
The type of IAP products (consumable / non-consumable) cannot be determined from your CSV file; you need to tell UDP the type of each IAP product.
UDP does not support Auto-Translate. This setting is ignored. UDP only uses the localized descriptions provided in the CSV file.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.