Namespace UnityEngine.Purchasing
Classes
AmazonApps
Class for constants referencing Amazon
AmazonAppStoreStoreExtensions
Access Amazon store specific functionality.
AppleAppStore
Class containing store information for iOS and tvOS builds.
AppleProductMetadata
Product definition used by Apple App Store. This is a representation of SKProduct Apple documentation
BaseIAPButton
A GUI component for exposing the current price and allow purchasing of In-App Purchases. Exposes configurable elements through the Inspector.
CodelessIAPButton
A GUI component for exposing the current price and allow purchasing of In-App Purchases. Exposes configurable elements through the Inspector.
CodelessIAPButton.OnProductFetchedEvent
Type of event fired after a successful fetching the product information from the store.
CodelessIAPButton.OnPurchaseCompletedEvent
Type of event fired after a successful purchase of a product.
CodelessIAPButton.OnPurchaseFailedEvent
Type of event fired after a failed purchase of a product.
CodelessIAPButton.OnTransactionsRestoredEvent
Type of event fired after a restore transactions was completed.
CodelessIAPStoreListener
Initializes Unity IAP with the Product
s defined in the default IAP ProductCatalog.
Automatically initializes at runtime load when enabled in the GUI. enableCodelessAutoInitialization
Manages IAPButton
s and IAPListener
s.
ConfigurationBuilder
Builds configuration for Unity Purchasing, consisting of products and store specific configuration details.
FakeAmazonExtensions
THIS IS A FAKE, NO CODE WILL BE EXECUTED!
Access Amazon store specific functionality.
FakeGooglePlayStoreConfiguration
Access Google Play store specific configurations.
FakeGooglePlayStoreExtensions
THIS IS A FAKE, NO CODE WILL BE EXECUTED!
Access GooglePlay store specific functionality.
FakeUDPExtension
Mock implementation of the interface for UDP purchasing extensions.
GetAppleProductMetadataExtension
Extension class to ProductMetadata to add a method to retrieve the Apple Product Metadata
GetGoogleProductMetadataExtension
Extension class to ProductMetadata to add a method to retrieve the Google Product Metadata
GooglePlay
Class for constants referencing GooglePlay
GoogleProductMetadata
Product definition used by Google Play Store. This is a representation of SkuDetails Google documentation
IAPButton
A GUI component for exposing the current price and allow purchasing of In-App Purchases. Exposes configurable elements through the Inspector.
IAPButton.OnPurchaseCompletedEvent
Type of event fired after a successful purchase of a product.
IAPButton.OnPurchaseFailedEvent
Type of event fired after a failed purchase of a product.
IAPButton.OnTransactionsRestoredEvent
Type of event fired after a restore transactions was completed.
IAPConfigurationHelper
Helps to set up ConfigurationBuilder.
IAPListener
An invisible GUI component for initializing Unity IAP and processing lifecycle events.
IAPListener.OnProductsFetchedEvent
Type of event fired after a successful fetching the products from the store.
IAPListener.OnPurchaseCompletedEvent
Type of event fired after a successful purchase of a product.
IAPListener.OnPurchaseFailedEvent
Type of event fired after a failed purchase of a product.
IDs
Maps store specific Product identifiers to one or more store identifiers.
The name is deliberately terse for use as a collection initializer.
InvalidProductTypeException
An error was found when an invalid Product.definition.type.definition.type
is provided.
LocaleExtensions
Class that facilitates localization code extensions.
LocalizedProductDescription
A description of an IAP product. Includes both a title and a longer description, plus an optional locale for specifying the language of this description. Characters wider than one byte are escaped as \uXXXX for serialization to work around a bug in Unity's JSONUtility deserialization prior to Unity 5.6.
MacAppStore
Class containing store information for MacOS builds.
MiniJson
Extension class for MiniJson to Encode and Decode JSON.
NullProductIdException
An error was found when an unexpectedly null Product.definition.id.definition.id
is provided.
NullReceiptException
An error was found when an unexpectedly null Product.receipt.receipt
is provided.
PayoutDefinition
Definition of a purchase payout
Price
Represents a price in a format that is serialized as both a decimal and a double.
Product
May be purchased as an In App Purchase.
ProductCatalog
The product catalog represents a list of IAP products, with enough information about each product to do a batch export for Apple's Application Loader or the Google Play CSV import format. To retreive the standard catalog, use ProductCatalog.LoadDefaultCatalog().
ProductCatalogItem
Represents a single product from the product catalog. Each item contains some common fields and some fields that are specific to a particular store.
ProductCatalogPayout
Represents the definition of a payout in the product catalog.
ProductCollection
Provides helper methods to retrieve products by store independent/store specific id.
ProductDefinition
Product definition used by Apps declaring products for sale.
ProductMetadata
Metadata for the product, namely that which is relevant to the store subsystem
PurchaseEventArgs
A purchase that succeeded, including the purchased product along with its purchase receipt.
PurchaseFailedEventArgs
A purchase that failed including the product under purchase, the reason for the failure and any additional information.
ReceiptParserException
Error found during receipt parsing.
StandardPurchasingModule
Module for the standard stores covered by Unity; Apple App store, Google Play and more.
StoreCallbackExtensionMethods
This class is an extension class on IStoreCallback to add the functionality to FindProductById
StoreID
Represents a pair of store identifier and product id for the store.
StoreSubscriptionInfoNotSupportedException
An error was found when an unsupported app store Product.receipt.receipt
is provided.
SubscriptionInfo
A container for a Product’s subscription-related information.
SubscriptionManager
Use to query in-app purchasing subscription product information, and upgrade subscription products. Supports the Apple App Store, Google Play store, and Amazon AppStore. Note Amazon support offers no subscription duration information. Note expiration dates may become invalid after updating subscriptions between two types of duration.
TimeSpanUnits
A period of time expressed in either days, months, or years. Conveys a subscription's duration definition. Note this reflects the types of subscription durations settable on a subscription on supported app stores.
UDP
Class containing store information for Unity Distribution Portal builds.
UnifiedReceipt
I can unpack JSON Product.receipt values.
See also https://docs.unity3d.com/Manual/UnityIAPPurchaseReceipts.html
var unifiedReceipt = JsonUtility.FromJson<UnifiedReceipt>(purchEvtArg.purchasedProduct.receipt)
Debug.LogFormat("{0} {1} {2}", unifiedReceipt.Payload, unifiedReceipt.Store, unifiedReceipt.TransactionID);
UnityPurchasing
The core abstract implementation for Unity Purchasing.
WindowsStore
Class containing store information for Universal Windows Platform builds.
Interfaces
IAmazonConfiguration
Access Amazon store specific configurations.
IAmazonExtensions
Access Amazon store specific functionality.
IAndroidStoreSelection
Store configuration for Android stores.
IAppleConfiguration
Access Apple store specific configurations.
IAppleExtensions
Access iOS specific functionality.
IDetailedStoreListener
IExtensionProvider
Interface providing access to various store extensions.
IGooglePlayConfiguration
Access Google Play store specific configurations.
IGooglePlayStoreExtensions
Access GooglePlay store specific functionality.
IMicrosoftConfiguration
Common interface for Universal Windows Platform configuration.
IMicrosoftExtensions
Common interface for Universal Windows Platform purchasing extensions.
INativeStore
An interface to native underlying store systems. Provides a base for opaquely typed communication across a language-bridge upon which additional functionality can be composed. Is used by most public IStore implementations which themselves are owned by the purchasing core.
IProductCatalogImpl
For testing
IStoreController
Used by Applications to control Unity Purchasing.
IStoreExtension
Common interface for all purchasing extensions.
IStoreListener
Implemented by Application developers using Unity Purchasing.
ITransactionHistoryExtensions
IAP transaction history and debugging extension.
IUDPExtensions
Common interface for all UDP store purchasing extensions.
Enums
AndroidStore
The type of Android store being run.
AndroidStoreMeta
A meta enum to bookend the app Stores for Android. Mapped from AndroidStore
values.
Is distinct from AndroidStore to avoid non-unique Enum.Parse and Enum.ToString lookup conflicts.
Note these must be synchronized with constants in the AppStore
enum.
AppleStorePromotionVisibility
This enum is a C# representation of the Apple object SKProductStorePromotionVisibility
.
https://developer.apple.com/documentation/storekit/skproductstorepromotionvisibility?changes=latest__7
Converted to a string (ToString) to pass to Apple native code, so do not change these names.
AppStore
The type of Native App store being used.
AppStoreMeta
A meta enum to bookend the app Stores for Android. Mapped from AppStore
's values.
Is distinct from AppStore
to avoid non-unique Enum.Parse and Enum.ToString lookup conflicts.
CodelessButtonType
The type of a CodelessIAPButton
, can be either a purchase or a restore button.
FakeStoreUIMode
The various kinds of Fake Store UI presentations. Requires UIFakeStore variant of FakeStore to function.
GooglePlayProrationMode
The Google Play proration mode used when upgrading and downgrading subscription. See more
IAPButton.ButtonType
The type of this button, can be either a purchase or a restore button.
InitializationFailureReason
Reasons for which purchasing initialization could fail.
PayoutType
Type of the purchase payout.
ProductCatalogPayout.ProductCatalogPayoutType
Types of Product Payouts. Mirrors the PayoutType
enum.
ProductType
Types of a product, relevant to the store subsystem.
PurchaseFailureReason
The various reasons a purchase can fail.
PurchaseProcessingResult
Informs Unity Purchasing as to whether an Application has finished processing a purchase.
Result
For representing boolean values which may also be not available.
StoreSpecificPurchaseErrorCode
The various reasons a purchase can fail. These codes are store-specific, so that developers can have access to to a wider range of debugging information.
SubscriptionPeriodUnit
Used internally to parse Apple receipts. Corresponds to Apple SKProductPeriodUnit.
TranslationLocale
The locales supported by Google for IAP product translation.