Interface IEconomyPurchasesApi
Represents a collection of functions to interact with the API endpoints
Namespace: Unity.Services.Apis.Economy
Assembly: Unity.Services.Apis.dll
Syntax
public interface IEconomyPurchasesApi : IApiAccessor
Methods
MakeVirtualPurchase(string, string, PlayerPurchaseVirtualRequest, string, string, string, CancellationToken)
Make virtual purchase
Declaration
ApiOperation<PlayerPurchaseVirtualResponse> MakeVirtualPurchase(string projectId, string playerId, PlayerPurchaseVirtualRequest playerPurchaseVirtualRequest, string configAssignmentHash = null, string unityInstallationId = null, string analyticsUserId = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | ID of the project. |
string | playerId | ID of the player. |
Player |
playerPurchaseVirtualRequest | The virtual purchase request. |
string | configAssignmentHash | Configuration assignment hash that should be used when processing this request. (optional) |
string | unityInstallationId | Unique identifier that identifies an installation on the client’s device. The same player can have different installationIds if they have the game installed on different devices. It is available to all Unity packages that integrate with the Services SDK Core package. (optional) |
string | analyticsUserId | A unique string that identifies the player and is consistent across their subsequent play sessions for analytics purposes. It is the primary user identifier and it comes from the Core package. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
RedeemAppleAppStorePurchase(string, string, PlayerPurchaseAppleappstoreRequest, string, string, string, CancellationToken)
Redeem Apple App Store purchase
Declaration
ApiOperation<PlayerPurchaseAppleappstoreResponse> RedeemAppleAppStorePurchase(string projectId, string playerId, PlayerPurchaseAppleappstoreRequest playerPurchaseAppleappstoreRequest, string configAssignmentHash = null, string unityInstallationId = null, string analyticsUserId = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | ID of the project. |
string | playerId | ID of the player. |
Player |
playerPurchaseAppleappstoreRequest | The Apple App Store purchase request. |
string | configAssignmentHash | Configuration assignment hash that should be used when processing this request. (optional) |
string | unityInstallationId | Unique identifier that identifies an installation on the client’s device. The same player can have different installationIds if they have the game installed on different devices. It is available to all Unity packages that integrate with the Services SDK Core package. (optional) |
string | analyticsUserId | A unique string that identifies the player and is consistent across their subsequent play sessions for analytics purposes. It is the primary user identifier and it comes from the Core package. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
RedeemGooglePlayPurchase(string, string, PlayerPurchaseGoogleplaystoreRequest, string, string, string, CancellationToken)
Redeem Google Play purchase
Declaration
ApiOperation<PlayerPurchaseGoogleplaystoreResponse> RedeemGooglePlayPurchase(string projectId, string playerId, PlayerPurchaseGoogleplaystoreRequest playerPurchaseGoogleplaystoreRequest, string configAssignmentHash = null, string unityInstallationId = null, string analyticsUserId = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | ID of the project. |
string | playerId | ID of the player. |
Player |
playerPurchaseGoogleplaystoreRequest | The Google Play purchase request. |
string | configAssignmentHash | Configuration assignment hash that should be used when processing this request. (optional) |
string | unityInstallationId | Unique identifier that identifies an installation on the client’s device. The same player can have different installationIds if they have the game installed on different devices. It is available to all Unity packages that integrate with the Services SDK Core package. (optional) |
string | analyticsUserId | A unique string that identifies the player and is consistent across their subsequent play sessions for analytics purposes. It is the primary user identifier and it comes from the Core package. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |