UDP reference
UDP console reference
This section provides a high-level overview of the UDP console’s information architecture.
The UDP console contains a navigation bar that lets you navigate between the following sections of the UDP console:
- Get Started
- My Games
- Reporting
- Partner Stores
- Resources
Get Started
The Get Started tab of the UDP console contains useful information on how to use the UDP console, including: * Tutorial videos * A walkthrough guide to help you track your progress * Store-specific information * FAQ
My Games
The My Games tab displays your UDP projects. From here you can switch between UDP projects, create a new game, and archive and restore games.
When you select a game, the following tabs are available:
- Game Info
- Publish
- Status
Each game card displays the status of the game. The “Published” status indicates the game has completed all of the available steps to be repacked and submitted to the store.
Game Info
Use the Game Info page to view and edit your game information. To view the Game Info page for a game, select the card in the My Games tab.
The Game Info page contains the following sections:
- Game Description
- Binary
- Ads
- Premium Price
- In-App Purchases
- Sandbox Testing
- App Signature
- Integration Information
The Game Info page contains a progress bar to show you how close you are to being able to release your game. Additionally, the tabs in the side menu are shown as ticked when you have added the necessary info for that section.
Game description
Use the Game Description section to enter information that will be displayed for your game in app stores.
The table below describes a superset of all the participating stores’ requirements. Not all stores use all of the properties described. The UDP console flags which fields are mandatory and which are optional. Additionally, some stores have specific syntax requirements. These are indicated in the UDP console.
| Свойство: | Описание |
|---|---|
| Import from Google Play | If you have already published your game on Google Play, you can import the basic information using your game’s Google Play URL. |
| Game Title | The title of your game (this field is synced with the Editor). |
| Genre | Indicates the category that your game belongs to. You can choose from Action, Adventure, Arcade, Board, Card, Casino, Casual, Educational, Music, Puzzle, Racing, Role Playing, Simulation, Sports, Strategy, Trivia, and Word. |
| Device | Choose between Smartphone, Tablet, or Universal. |
| Game Icon | The game icon to show on the app stores. |
| Short Description | Short description (max 60 char) of your game to show on the app stores. |
| Описание | Full-length description (4,000 char) of your game to show on the app stores. |
| Game Banners | An image used by stores to feature your game. For example, it can be a placement in a carousel. The landscape banner is mandatory, the portrait banner is optional. |
| Keywords | Define up to 4 keywords (30 char each). These are used for search purposes in the app stores. |
| Feature Video | Add a video trailer for your game. Note: For videos, some stores only accept MP4 files while others only accept a Youtube link. Unity recommends you upload both. |
| Screenshots | Add screenshots of your game, including the cover image (thumbnail) to lay over the MP4 video when it is not playing. Add at least four images per orientation that you use. Some app stores only accept either portrait or landscape images, but not both. If you do upload both portrait and landscape images to UDP, select your preferred orientation in the Preference field. UDP will inform you if the screenshots do not meet the stores’ requirements. |
| Preference | Certain stores only accept portrait or landscape images. For such stores, specify which orientation of image to use. |
| Ratings | Select the audience which the game is suitable for. |
You can specify metadata for each of your supported languages. To add new languages, select the language dropdown while in edit mode and select Manage Languages.
Binary
Use the Binary section to upload your APK file and OBB files:
| Свойство: | Описание |
|---|---|
| APK File | Your UDP game build. If you pushed your UDP build via Cloud Build, you don’t need to upload it again. For UDP to accept your APK file, the APK file: - Must contain a versionName - Must have an Initialize() method - Must have a Purchase() method (for games with IAP) If you upload a new APK version which contains a different package name, you will receive an error. This also prevents publishing the new APK version. |
| Version code | This field is only displayed once you’ve uploaded your game to UDP. |
| Minimum Android Version Support | Minimum supported Android version for your game. This field is only displayed once you’ve uploaded your game to UDP. |
| What’s New | Describe what’s changed with this version of your game. UDP publishes this information in the stores. This field is only displayed once you’ve uploaded your game to UDP. |
| OBB File (Main) | The main extension file for additional resources that your game or app might need. |
| OBB File (Patch) | Optional file to make small updates to the main expansion file. |
| Does your game use Google Play Services? | Knowing about your Google Play Services usage helps UDP better guide you during the submission stage. |
OBB files are not pushed during a CloudBuild deployment, so if your game uses them you must upload them manually to the UDP console.
Note: You can only change the APK files and OBB files in the default language view (English).
Ads
The table below describes the Ads section.
| Свойство: | Описание |
|---|---|
| Does your game contain ads | Select whether or not your game contains ads. This information is useful for UDP to better guide you during submission. |
| What ad mediation solutions does your game use? (Optional) | If your game contains ads, select which mediation solutions your game uses. |
| What ad networks does your game use? (Optional) | If your game contains ads, select which ad networks your game uses. |
Certain stores expect you to implement their proprietary ad network in games you submit to them.
UDP asks if your game contains ads to better inform your submissions to the stores, especially if UDP can ascertain that your submission will be rejected from a store because of this.
Stores which might reject your game display a warning icon in the Publish section, and a tooltip to explain the issue that might occur. UDP otherwise does not modify your game’s ad implementation in any way.
Tests of the most common mediation layers and ad networks indicate that games repacked for the UDP stores generally have no problem receiving ad campaigns. Feel free to ask UDP Support about your ad setup and its suitability for distribution via UDP. Make sure you mention which mediation SDK and ad networks your game uses, to get a better-informed answer faster.
Premium price
The Premium price is the price it costs players to download your game.
| Свойство: | Описание |
|---|---|
| Manage amounts and currencies | Set the cost of the game in USD. Select Convert to automatically convert the USD price into the other listed currencies.You can also edit prices manually for specific currencies. |
Note: You can only submit premium games to stores which support premium games.
In-App Purchases
Use the In-App Purchases section to add and manage IAP items.
If using the UDP package, UDP automatically keeps your game’s IAP Catalog synchronized between the Unity Editor and the UDP console.
| Свойство: | Описание |
|---|---|
| Search box | Filter the list of IAP items by text. |
| Type dropdown | Filter the list of IAPs by type, that is, consumable or non-consumable. |
| Sort dropdown | Choose how to sort the list of IAP items. |
| Add Item | Click to add a new IAP item. This opens a window to enter the IAP details. |
| Manage amounts and currencies | Click to set prices for additional currencies. |
| Convert | Converts the USD price of your IAP item into global currencies. This overwrites any manually set prices for other currencies. |
| Favourite Currencies | Select to open the Favourite currencies window. 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. |
IAP Item window
Use the IAP Item window to add and edit details for IAP products. To open this window select Add Item. The table below describes the windows of the Add IAP Item window.
| Field | Описание |
|---|---|
| Product ID | The unique ID used to identify the IAP product. Product IDs must follow these requirements: - Start with a letter or a digit - Contain only letters, digits, dots (.) and underscores (_) - Must not use capitalized letters |
| Имя | The name of the IAP product. |
| Currency | Displays the currency the price is shown in. |
| Price | The price of the IAP product in USD. You must specify a price to enable players to purchase products in your game. |
| Consumable | Select this option for consumable IAP items. |
| Описание | A short description of the IAP product. |
Sandbox Testing
The Sandbox Testing section displays the test status for your game. Use this section to create user credentials for testing in the sandbox environment and view the status of the tests. The table below describes the fields of this section.
| Field | Описание |
|---|---|
| Test status | Displays the test status for the game. |
| UDP Initialization | Displays the test status for the Initialization check. This checks to ensure the Initialize() method is called (for all games). |
| IAP Transaction | Displays the test status for the IAP transactions check. Purchase() method is called (for IAP games only) |
| Sandbox Test Account | The email address for the sandbox test account. It is used as the login name for the UDP sandbox environment only. |
| Password | The password for the test account. |
App Signature
UDP uses an App-signing private key to sign the repacked APK files that are submitted to the stores.
Unity recommends that you select Export and upload the key and certificate and use your own App signing private key. If your game is released on Google Play, use the same key as on Google Play. This significantly decreases the chance of your game being flagged by Google Play Protect when users install it.
Note: If your game is flagged, you can appeal to Google here.
The table below describes the App Signature section of the Game Info tab.
| Свойство: | Описание |
|---|---|
| Let UDP create and manage App signing private key | UDP generates a different App signing private key for each store the game is repacked for. This option leaves your game more vulnerable to Google Play Protect warnings. |
| Export and upload the key and certificate (recommended) | UDP uses the App signing private key you upload to sign the repacked builds. If you select this option, it applies to all stores you submit your game to. |
| Steps | Displays the steps to export and upload your private key. |
Note: App signature generation is only supported for Android SDK Version 18 and above. If your game uses a lower SDK version than this, use the RSA algorithm signature or increase the game’s Minimum API Level.
Changing keys
You can switch from using the UDP key to your own key at any time. This change only applies for stores that the game has not been repacked for (and therefore signed). If you have previously repacked for a store using the UDP key, that store will always use the UDP key.
You can only switch from using your own key to the UDP key if you have not repacked your game (and your own key) for any store.
UDP-generated keys
UDP uses company information to generate a keystore for the repacked APK files when the following conditions are met:
- The APK file uploaded by the developer does not contain the keystore file.
- The game has not been repacked in the partner store.
If these conditions are not met, UDP uses an existing UDP keystore if available, or it uses the developer information to generate a new signature file.
Integration Information
This information is synced with the Editor. The following fields are editable:
| Field | Описание |
|---|---|
| Unity Project ID | The Unity project ID linked to the UDP client. To unlink a Unity project from the UDP client, delete the ID in this field and select Save. Note: Only owners and managers can edit this field. |
| Callback URL | URL of the game server. UDP uses this to send notifications for payment results. |
Release window
The Release window lets you release versions of your game. This is displayed when you select Release in the Game Info page.
The Release window contains fields to specify the version’s:
- Tag
- Release notes
The tag and release notes of all your revisions are visible in:
- The Game Info section, when expanding the Revision drop-down
- The Status section, which is organized by Release
Note: You can only publish the latest revision to the stores.
Learn more about:
Publish Panel
Use the Publish panel to sign up to stores and publish your games. Each store has its own section in the page.
The table below describes the Publish page.
| Field | Описание |
|---|---|
| Publish | Publishes the selected games. |
| Only show stores that accept the game’s pricing model | Hides stores that don’t support your game’s pricing model from the Publish page. |
| All Stores | Selects all visible stores for publishing. |
| Store checkbox | Select the checkbox for a store to only publish to selected stores. |
| Premium | The Premium label is displayed for stores which support premium games. |
| IAP | The IAP label is displayed for stores which support IAP. |
| Info icon | The info icon states whether the store is fully or partially integrated with UDP. |
| Sign up | Sign up to the selected store. |
| Countries | Select Countries to choose which countries you want to publish your game to. This opens a window containing a list of countries which the store supports. Select the checkboxes to enable your game for a country and select Save. This option is only displayed when you’ve signed up for the store. |
| Продвинутое | Select to configure advanced properties for a specific store. This option is only displayed when you’ve signed up for the store. |
Target steps
In the Publish tab, each store contains a dropdown to let you select the target step for the given store. The following options are available:
| Target step | Описание |
|---|---|
| Repack Game | UDP unpacks the generic UDP build and repacks your game with the SDK from the selected store. This uses the IAP catalog from the last build you submitted to the store. |
| Submit to Store | UDP repacks and submits your game, its metadata and its IAP catalog to the production environment of the selected stores. The first time you publish your game, you must submit it to create an IAP catalog on the stores’ servers. |
Advanced settings
To configure store-specific settings before you submit your game, select Advanced for the store in the Publish tab. You can configure the following properties specifically for a store:
| Свойство: | Функция: | Affected store |
|---|---|---|
| Target SDK | The version of the store SDK that you publish your game to. By default, UDP repacks for the latest version of the store SDK. | Все |
| CP ID | Merchant ID on the Huawei AppGallery Connect console. | Huawei |
| Product ID | Product ID on the Huawei AppGallery Connect console. | Huawei |
| App ID | Application ID on the Huawei AppGallery Connect console. | Huawei |
| Configuration version on the Huawei AppGallery Connect console. | Version of the game | Huawei |
| PubKey | Public key on the Huawei AppGallery Connect console. | Huawei |
| App Secret | App secret on the Huawei AppGallery Connect console. | Huawei |
| privacyPolicy | Privacy statement address on the Huawei AppGallery Connect console. | Huawei |
| Premium Price | The price players will pay to download your game. | All stores which support premium games |
| In-App Purchases | The name of your IAP items. | Все |
| GRAC certificate | A GRAC certificate is required to distribute games rated 18+ in Korea. Upload the certificate here, if required. | Samsung |
| Approval Number from SAPPRFT (aka ISBN) | Enter the SAPPRFT approval number for games you publish in China. If you don’t have a publishing licence for this, deselect China from the country list. | Xiaomi Huawei |
| Registration Number from MCPRC | Ministry of Culture Record number for games you publish in China. | Huawei |
| Launch Manually | Set to launch the game manually on the store. | Samsung Huawei |
| Launch on | Specify a date and time to launch your game on the store. | Samsung Huawei |
| Renew authentication | Select to renew your authentication token for the selected store. | Huawei |
| Package Name | Displays the name of the package. This cannot be edited once it’s been registered. | QooApp Viveport |
| URL for Privacy Policy | Enter the URL for your game’s privacy policy. | Viveport |
| URL for EULA/Terms of Use | Enter the URL for your game’s EULA/Terms of use. | Viveport |
Detail
If your submission is missing anything, the UDP console displays error or warning messages. Select Detail to expand for more information on the problem.
Errors are displayed in a red panel. You must fix errors before you can submit your game. Select Modify to go to the erroneous area to fix the issue.
You can also choose to only submit to stores where there are no errors.
Warnings are displayed in a yellow panel. You can dismiss the warnings you decide to ignore.
Status panel
When UDP starts processing your game, visit the Status panel to monitor progress and check the submission history of your game.
The Status panel displays an overview of your game’s history.
| Field | Описание |
|---|---|
| Revisions repacked | Total number of repacked APK builds created with UDP. Note: If a game has been repacked three times for the same stores, this counts as three. |
| Revisions submitted | Total number of submissions made via UDP. Note: If a game was submitted five times to a store, this counts as five. |
| Submissions accepted | Number of submissions that have been accepted to app stores. |
| Submissions rejected | Number of revisions that have been rejected by app stores. |
For each game revision, the Status panel displays the following details:
| Field | Описание |
|---|---|
| Store | The store(s) that the game was submitted to. |
| Status | The status of the revision. Not all stores can provide visibility until ‘Live’. The Status section only provides the information it can get from the store. |
| Countries | The number of countries which your game is enabled for, for each store. Select the number in this column to view the countries. |
| Action | Perform additional actions, such as download revisions of your game or go to store to complete publishing steps. |
Your game can have the following statuses:
- Repacked: your game was successfully repacked with the SDK of the selected store
- Published: your game has passed all the steps required for the store when repacking and submitting to that store
- Pending: your game is being repacked with the SDK of the selected store
- Failed: your game could not be repacked with the SDK of the selected store
- Canceled: your game submission was cancelled by you or someone from your Organization
Reporting dashboard
The Reporting tab displays performance information for your published games. Monitor the performance of your published games from the Reporting dashboard, which is accessible from the top navigation bar.
You can filter the information presented on the Reporting dashboard by game and/or by store.
If you don’t select anything in the All Games and All Stores filters for the whole Reporting dashboard, you can view breakdowns on an individual chart level (where applicable). On supported charts, select the by store or by game filters to view performance on specific stores or for individual games.
The Reporting dashboard is divided into five panels, all subject to the Games and Stores filters. For the panels which are subject to the date filter, you can export chart data as CSV files and images. To download the data as a CSV file or image, select the corresponding icon for the chart.
Note: The Huawei AppGallery only returns revenue information to UDP if you’ve set up server-side validation using QueryOrder. If you used callback notifications, no revenue-related charts or information is available for Huawei.
Metrics and definitions
The Reporting dashboard tracks the following data from the UDP stores where your games are published:
| Metric | Описание |
|---|---|
| Gross revenue | Amount collected from players in USD (e.g. if IAP price= 0.99 then= $0.99) |
| Players | The number of unique users who downloaded and started the game. This is calculated by unique devices. |
| Spenders | The number of paying players. That is, the number of unique users who have made at least one successful payment. |
| Days since 1st activity | The number of days since a game reached 10 players on an app store. |
| New Players | Number of players who started the game for the first time during the selected time period. |
| DAU | Daily active users. The number of unique users who launched the game at least once on that day. |
| MAU | Monthly Active Users. The number of unique users who launched the game at least once during the last 30 days. |
| IAP Revenue | Gross revenue from IAP, in USD. |
| Average Revenue per Transaction | This is defined as Revenue / Number of Transactions, in USD. |
| ARPPU | Average revenue per paying user, in USD. This is defined as Gross Revenue / Number of Paying Players. |
| ARPU | Average revenue per user, in USD. This is defined as Gross Revenue / Number of Players. |
| Spender Conversion Rate | This is defined as Number of Paying Players / Number of Players. |
| Transactions | Number of successful transactions which resulted in a payment (OrderID was successful and verified by the UDP server). |
| Revenue by IAP | Breakdown of gross revenue by IAP, in USD. |
| Transaction Volume by IAP | Breakdown of transactions by IAP. |
| Premium Revenue | Gross revenue generated by premium games, in USD. |
| Sessions | Number of times the game was launched, on any device. |
| Day 1 Retention (%) | This is defined as Percentage of Players that are still active 1 day after their first game launch. |
| Day 7 Retention (%) | This is defined as Percentage of Players that are still active 7 days after their first game launch. |
| Day 30 Retention (%) | This is defined as Percentage of Players that are still active 30 days after their first game launch. |
Note: The Reporting dashboard contains estimated data; you can get exact numbers directly from the stores. The data shown is in UTC time and is until the previous day to display the most accurate, complete data.
All Time
This panel displays the following lifetime metrics:
- Gross revenue (in USD)
- Players
- Spenders
- Days since 1st activity
Yesterday
This panel displays the following metrics from the last full 24h day (basis UTC):
- Gross revenue (in USD) with $ or % comparison to the previous day
- New players
- DAU with % comparison with average DAU value of last 7 days
- MAU with % comparison with average MAU value of last 7 days
IAP Performance
This panel displays the following metrics for the selected date range:
- IAP Revenue
- Average Revenue per Transaction
- ARPPU
- ARPU
- Spender Conversion Rate
- Transactions
- Revenue by IAP. You can view up to 5 IAPs in the chart, and select which ones to view via the drop-down selector. This chart contains presets for:
- Most revenue
- Most transactions
- Highest price points
- Lowest price points
- Transaction Volume by IAP. You can view up to 5 IAPs in the chart, and select which ones to view via the drop-down selector. This chart contains presets for:
- Most revenue
- Most transactions
- Highest price points
- Lowest price points
Premium Revenue
This panel displays, for the selected date range:
- Premium Revenue (revenue from paid downloads)
Game Health
This panel displays the following metrics for the selected date range:
- DAU - per day and average over the period
- MAU - per day and average over the period
- New Players - per day and total over the period
- Sessions - per day and total over the period
- Day 1 Retention Rate - per day and average over the period
- Day 7 Retention Rate - per day and average over the period
- Day 30 Retention Rate - per day and average over the period
Partner Stores
The Partner Stores tab displays information about the stores you can distribute your game to using UDP.
Select the More link for more information on a store, such as overview, FAQs, and other useful links specific to each store.
Resources
The Resources tab displays useful information to help you get started, including:
- A link to the UDP documentation
- A Get Started guide
- Guides to different app stores
Company Information
Use the Company Information window to add information to display for your company in the app stores. On the UDP console, choose your organization and select the pencil icon to edit the profile.
| Field | Описание |
|---|---|
| Company Name | The name of your company as you want players to see it. |
| Location | The location you want to define as your studio’s headquarters. |
| Company Size | Use the drop-down to specify the number of people in your company. |
| Official Website | The official website of your company. |
| Support Email Address | The support email that players can use to contact your company. |
| About | Any additional information about your company / studio. |
CSV reference
Data values for CSV files
Each row in a CSV file of In-App Purchases can contain the following values. Do not pass empty values.
| Field | Описание |
|---|---|
| product_id | Represents the ID of a unique IAP product. product_id needs to start with a lowercase letter or a digit and must be composed of only lowercase letters (a-z), digits (0–9), underscores (_), and periods (.) |
| language; product_name; description | When setting the language value, use the language code listed in TABLE A. UDP uses en-US as the default language. Use semicolon(;) to separate language, product_name and description. To include localized versions of the item’s product name and description, you must list the default language, product_name, and description, followed by the languages, product_names, and descriptions for each locale. In the following example, the product has en-US (ENGLISH) as the default language and zh-CN (CHINESE) as a localization: en-US;Product 1;This is my first product; zh-CN; 产品1; 产品描述1. Note: After uploading the file, only the fields corresponding to languages already defined in the Game Info section will be imported. If you intend to support multiple languages, define them on the UDP Console before importing your IAP catalog. |
| consumable | This value must be set to TRUE or FALSE (case insensitive). |
| currency; price | When setting the currency value, use the currency code listed in TABLE B. The price must be positive. The default currency is USD. The price of each IAP product must immediately follow its corresponding currency. For example: USD;0.99;CNY;6 |
TABLE A - Language codes
| Language | Code |
|---|---|
| AFRIKAANS | af |
| AMHARIC | am |
| BULGARIAN | bg |
| CATALAN | ca |
| CHINESE | zh-CN |
| CHINESE (HONG KONG) | zh-HK |
| CHINESE (TAIWAN) | zh-TW |
| CROATIAN | hr |
| CZECH | cs |
| DANISH | da |
| DUTCH | nl |
| ENGLISH (UK) | en-GB |
| ENGLISH | en-US |
| ESTONIAN | et |
| FILIPINO | fil |
| FINNISH | fi |
| FRENCH (CANADA) | fr-CA |
| FRENCH | fr-FR |
| GERMAN | de |
| GREEK | el |
| HINDI | hi |
| HUNGARIAN | hu |
| INDONESIAN | id |
| ITALIAN | it |
| JAPANESE | ja |
| KOREAN | ko |
| LATVIAN | lv |
| LITHUANIAN | lt |
| MALAY | ms |
| NORWEGIAN | no |
| POLISH | pl |
| PORTUGUESE (BRAZIL) | pt-BR |
| PORTUGUESE (PORTUGAL) | pt-PT |
| ROMANIAN | ro |
| RUSSIAN | ru |
| SERBIAN | sr |
| SLOVAK | sk |
| SLOVENIAN | sl |
| SPANISH (LATIN AMERICA) | es |
| SPANISH | es-ES |
| SWAHILI | sw |
| SWEDISH | sv |
| THAI | th |
| TURKISH | tr |
| UKRAINIAN | uk |
| VIETNAMESE | vi |
| ZULU | zu |
TABLE B - Currency codes
| Code | Code | Code |
|---|---|---|
| AED | IDR | PEN |
| ARS | ILS | PHP |
| AUD | INR | PKR |
| BGN | IQD | PLN |
| BHD | ISK | QAR |
| BND | JOD | RON |
| BIF | JPY | RUB |
| BRL | KES | SAR |
| CAD | KHR | SDG |
| CHF | KRW | SEK |
| CNY | KWD | SGD |
| CZK | LAK | THB |
| DKK | LKR | TND |
| DZD | LYD | TRY |
| EGP | MAD | TWD |
| EUR | MMK | TZS |
| GBP | MXN | USD |
| GHS | MYR | UYU |
| HKD | NOK | VND |
| HRK | NZD | ZAR |
| HUF | OMR | |
Example 1
product_id,language; product_name; description,consumable,currency; price com.mystudio.mygame.product1,en-US;Product 1;This is my first product; zh-CN; 产品1; 产品描述1,TRUE,USD;0.99;CNY;6;EUR;0.79 com.mystudio.mygame.product2,en-US;Product 2;This is my second product; zh-CN; 产品2; 产品描述2,FALSE,USD;1.99;CNY;12;EUR;1.59 com.mystudio.mygame.product3,en-US;Product 3;This is my third product; zh-CN; 产品3; 产品描述3,TRUE,USD;4.99;CNY;30;EUR;3.99
Example 2
product_id,language; product_name; description,consumable,currency; price com.mystudio.mygame.product1,en-US;Product 1;This is my first product,TRUE,USD;0.99 com.mystudio.mygame.product2,en-US;Product 2;This is my second product,FALSE,USD;1.99 com.mystudio.mygame.product3,en-US;Product 3;This is my third product,TRUE,USD;4.99