Version: 2019.4
Unity IAP
Configuring for Apple App Store and Mac App Store
How do you use documentation throughout your workflow? Share your experience with us by taking this survey.

Setting up Unity IAP

Note: Screen shots and menu choices may differ between release versions.

Overview

This document explains how to activate In-App Purchasing (IAP).

The Unity IAPAbbreviation of Unity In App Purchase
See in Glossary
package provides coded and codeless approaches that you set up to: - Allow users to buy items in your games. - Connect to stores so that you can obtain revenue from these purchases.

Here is an overview of the steps:

  • Define your In-app purchase strategy for this game.
  • Setup your project as a Unity service.
  • Activate IAP to automatically install the package.
  • Configure settings.
  • Create and catalog your the in-game items that you want to sell.
  • Use the Codeless IAP button to give users a way to buy items. Then, once you have the logic working, consider customizing the button look and feel. Or use the scripted IAP for a rich API to enhance this process.  Demo
  • Connect your app to the relevant app-stores, such as Google, Apple, or Android.
  • Add items to the stores.

Put it all together:

  • Configure your IAP using guidance from this doc, support, and the IAP forum.
  • Test everything.
  • Make it live.

You can also do many of these steps, or fine tune what you create, with the In-App Purchasing API.

Getting Started

Note: The Samsung Galaxy store is now obsolete and is no longer supported in the Unity In-App Purchasing package 4.0.0 and higher. This guide to configure the Samsung Galaxy store only applies to the IAP package version 3.1.0 and earlier. If you’re using the Unity IAP package 4.0.0 and higher and want to implement a Samsung Galaxy store, use the Unity Distribution Platform instead.

  1. Open your Unity project in the Unity Editor.
  2. Choose Window\General\Services. The services window will appear.
  3. Create a Project ID, then connect the project to an organization.
  4. Answer the COPPA(Children’s Online Privacy Protection Act) COPPA is a US law that applies to apps that collect personal information and are targeted to children under the age of 14. More info
    See in Glossary
    compliance questions.
  5. The services window will display a list of services. Click In-App Purchasing.
Services
Services
  1. The Project Settings window appears.
Project Settings
Project Settings
  1. Click the toggle next to In-App Purchasing Settings to ON.

This will automatically install the IAP package from the package manager, providing you with new features and menu items to help you manage IAP.

Next Steps

Define your In-App Purchase strategy

Your task will be to create items for players to buy and obtain their identifiers.

To make this happen behind the scenesA Scene contains the environments and menus of your game. Think of each unique Scene file as a unique level. In each Scene, you place your environments, obstacles, and decorations, essentially designing and building your game in pieces. More info
See in Glossary
, you must tie product identifiers (strings) to each item you are selling, using a specified format. Some stores require that you customize the Product ID for their stores.

Planning:

  • Define your strategy to determinhe when/how users can buy things
  • Define your pricing strategy
  • Define the types of products (subscriber, consumable, non consumable)

Where to learn more

IAP Samples

  1. From the IAP Project Settings Page, click Open Package Manager from Options.
  2. Navigate to In App Purchasing. On the right information panel, find Samples.
  3. Expand Samples, then click Import.
Samples
Samples

Forum tutorials

See the Unity forum.

Unity Learn IAP classes

Refer to the Unity Learn IAP classes for more guidance.

Troubleshooting

How to resolve compilation errors during upgrades

Important notes if you are upgrading from Unity IAP version 2.x to future versions.

If updating from Unity IAP (com.unity.purchasing + the Asset Store plugin) versions 2.x to future versions, complete the following actions in order to resolve compilation errors:

  • Move IAPProductCatalog.json and BillingMode.jsonfrom Assets/Plugins/UnityPurchasing/Resources/ to Assets/Resources/
  • Move AppleTangle.cs and GooglePlayTangle.cs FROM: ‘Assets/Plugins/UnityPurchasing/generated’ TO: Assets/Scripts/UnityPurchasing/generated.
  • Remove all remaining Asset StoreA growing library of free and commercial assets created by Unity and members of the community. Offers a wide variety of assets, from textures, models and animations to whole project examples, tutorials and Editor extensions. More info
    See in Glossary
    plugin folders and files in Assets/Plugins/UnityPurchasing from your project.

Common Unity IAP integration compiler errors

The following error messages may indicate that Unity IAP is disabled in the Unity Cloud Services window, or that Unity is disconnected from the Internet: * CS0246 * System.Reflection.ReflectionTypeLoadException * UnityPurchasing/Bin/Stores.dll * UnityEngine.Purchasing

To resolve these errors:

Reload the Services window by closing, then reopening it. Once reloaded, ensure that the Unity IAP service is enabled. If this doesn’t work, try disconnecting and reconnecting to the Internet, then sign back into Unity Services and re-enable Unity IAP.

Note: You must have an Owner or Manager role for the project.

Unity IAP
Configuring for Apple App Store and Mac App Store