Update Google Play e-commerce docs

Author: hach-que

docs/changelog.mdx

@@ -25,7 +25,7 @@ This release adds support for Unreal Engine 5.7, EOS SDK 1.18.1.2, and routes vo
   - Free Edition users will need to update their engine version when updating to this release.
 - Added support for EOS SDK 1.17.1.3, 1.18.0.4 and 1.18.1.2.
   - Free Edition users will need to download and install the newer EOS SDK from the Epic Games Developer Portal when upgrading to this release. If you need to use an older EOS SDK version, please use the Paid Edition instead.
-- Voice chat audio is now routed through Unreal Engine, in preparation for supporting proximity voice chat in a _future release_.
+- Voice chat audio is now captured and emitted through Unreal Engine, in preparation for supporting proximity voice chat in a _future release_.
 - Added the "Voice Chat Debugger" tool in the editor, which can be accessed from the "Tools" menu. This shows you the state of all voice chat channels and participants, and allows you to easily toggle voice chat settings while testing with play-in-editor.
 - Fixed an issue where voice chat did not activate the microphone correctly on iOS.
 - Fixed an issue where packaging with Anti-Cheat would fail if the staging directory was read-only.

docs/ossv1/ecom/entitlements.mdx

@@ -3,9 +3,9 @@ title: Retrieving entitlements
 description: Fetching the e-commerce entitlements that the user owns.
 ---
 
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import Blueprint from '@site/src/Blueprint';
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import Blueprint from "@site/src/Blueprint";
 
 E-commerce functionality is provided via the `IOnlineStoreV2`, `IOnlineEntitlements` and `IOnlinePurchase` interfaces. Retrieving the owned entitlements is done via the `IOnlineEntitlements` interface.
 
@@ -25,7 +25,7 @@ For Steam users, entitlements include both owned DLC and inventory items in the
 <TabItem value="google-play">
 
 :::caution
-You can not retrieve entitlements on Google Play, because all purchases are consumable and therefore do not persist as entitlements.
+You can not retrieve entitlements on Google Play.
 :::
 
 </TabItem>
@@ -70,9 +70,9 @@ When your callback fires, you'll want to handle any errors and then deregister t
 
 ```cpp
 void UMyClass::HandleQueryEntitlementsComplete(
-    bool bWasSuccessful, 
-    const FUniqueNetId& UserId, 
-    const FString& Namespace, 
+    bool bWasSuccessful,
+    const FUniqueNetId& UserId,
+    const FString& Namespace,
     const FString& Error)
 {
     // Deregister the event handler.
@@ -100,7 +100,9 @@ void UMyClass::HandleQueryEntitlementsComplete(
 
 To retrieve the entitlements, use the "Query Entitlements" blueprint node then the "Get All Entitlements" blueprint node.
 
-<Blueprint height="500px" blueprint={`
+<Blueprint
+  height="500px"
+  blueprint={`
 Begin Object Class=/Script/BlueprintGraph.K2Node_GetSubsystem Name="K2Node_GetSubsystem_2"
    CustomClass=Class'"/Script/OnlineSubsystemBlueprints.OnlineEntitlementsSubsystem"'
    NodePosX=16
@@ -184,11 +186,12 @@ Begin Object Class=/Script/BlueprintGraph.K2Node_CallFunction Name="K2Node_CallF
    CustomProperties Pin (PinId=9A0235C349B03628CE3F5A8857EAB1E1,PinName="Namespace",PinToolTip="Namespace\\nString",PinType.PinCategory="string",PinType.PinSubCategory="",PinType.PinSubCategoryObject=None,PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=None,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,LinkedTo=(K2Node_AsyncAction_2 90BACF3749F0E979F5878489089D5413,),PersistentGuid=00000000000000000000000000000000,bHidden=False,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,)
    CustomProperties Pin (PinId=7A867BAA4BDD29ABD57E50AD618C3BD1,PinName="OutUserEntitlements",PinToolTip="Out User Entitlements\\nArray of Online Entitlement Object References",Direction="EGPD_Output",PinType.PinCategory="object",PinType.PinSubCategory="",PinType.PinSubCategoryObject=Class'"/Script/OnlineSubsystemBlueprints.OnlineEntitlement"',PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=Array,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,PersistentGuid=00000000000000000000000000000000,bHidden=False,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,)
 End Object
-`} />
+`}
+/>
 
 </TabItem>
 </Tabs>
 
 ## Consuming an entitlement
 
-Refer to [Purchasing offers](purchasing.mdx) on how to consume entitlements. The process for consuming entitlements differs between different platforms and stores.
+Refer to [Purchasing offers](purchasing.mdx) on how to consume entitlements. The process for consuming entitlements differs between different platforms and stores.

docs/ossv1/ecom/offers.mdx

@@ -3,9 +3,9 @@ title: Retrieving offers
 description: Fetching the available e-commerce offers for purchase.
 ---
 
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import Blueprint from '@site/src/Blueprint';
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import Blueprint from "@site/src/Blueprint";
 
 E-commerce functionality is provided via the `IOnlineStoreV2`, `IOnlineEntitlements` and `IOnlinePurchase` interfaces. Retrieving the available offers is done via the `IOnlineStoreV2` interface.
 
@@ -42,8 +42,7 @@ When querying offers for Google Play, there are a few things to note:
 - The `QueryCategories` operation isn't supported, because Google Play offers don't have categories.
 - The `QueryOffersByFilter` operation isn't supported, because Google Play only supports retrieving in-app purchases by product ID.
 - You must use `QueryOffersById` to fetch offers on Google Play.
-- The Google Play integration only supports consumable in-app purchases.
-- The Google Play integration does not support non-consumable in-app purchases.
+- The Google Play integration supports consumable and non-consumable in-app purchases.
 - The Google Play integration does not support subscriptions.
 
 </TabItem>
@@ -80,7 +79,7 @@ StoreV2->QueryOffersByFilter(
     FOnQueryOnlineStoreOffersComplete::CreateLambda([
         StoreV2Wk = TWeakPtr<IOnlineStoreV2, ESPMode::ThreadSafe>(StoreV2)](
         bool bWasSuccessful,
-        const TArray<FUniqueOfferId>& OfferIds, 
+        const TArray<FUniqueOfferId>& OfferIds,
         const FString& Error)
         {
             if (auto StoreV2 = StoreV2Wk.Pin())
@@ -89,7 +88,7 @@ StoreV2->QueryOffersByFilter(
                 {
                     TArray<FOnlineStoreOfferRef> Offers;
                     StoreV2->GetOffers(Offers);
-                    
+
                     // Offers now contains a list of offers. You can call
                     // GetOffers from anywhere to get the cached list of
                     // offers.
@@ -104,7 +103,9 @@ StoreV2->QueryOffersByFilter(
 
 To query for the available offers, use the "Query Offers by Filter" blueprint node followed by "Get Offers".
 
-<Blueprint height="500px" blueprint={`
+<Blueprint
+  height="500px"
+  blueprint={`
 Begin Object Class=/Script/BlueprintGraph.K2Node_GetSubsystem Name="K2Node_GetSubsystem_0"
    CustomClass=Class'"/Script/OnlineSubsystemBlueprints.OnlineStoreV2Subsystem"'
    NodePosY=-175
@@ -182,7 +183,8 @@ Begin Object Class=/Script/BlueprintGraph.K2Node_IfThenElse Name="K2Node_IfThenE
    CustomProperties Pin (PinId=5443BFB64039F236E187E796A3BB5571,PinName="then",PinFriendlyName=NSLOCTEXT("K2Node", "true", "true"),Direction="EGPD_Output",PinType.PinCategory="exec",PinType.PinSubCategory="",PinType.PinSubCategoryObject=None,PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=None,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,LinkedTo=(K2Node_CallFunction_2 BBAD002F48A01855476AA1BA94459D5F,),PersistentGuid=00000000000000000000000000000000,bHidden=False,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,)
    CustomProperties Pin (PinId=F450808447C8D03E27EB9582DF78D443,PinName="else",PinFriendlyName=NSLOCTEXT("K2Node", "false", "false"),Direction="EGPD_Output",PinType.PinCategory="exec",PinType.PinSubCategory="",PinType.PinSubCategoryObject=None,PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=None,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,PersistentGuid=00000000000000000000000000000000,bHidden=False,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,)
 End Object
-`} />
+`}
+/>
 
 </TabItem>
 </Tabs>
@@ -220,7 +222,7 @@ StoreV2->QueryOffersById(
     FOnQueryOnlineStoreOffersComplete::CreateLambda([
         StoreV2Wk = TWeakPtr<IOnlineStoreV2, ESPMode::ThreadSafe>(StoreV2)](
         bool bWasSuccessful,
-        const TArray<FUniqueOfferId>& OfferIds, 
+        const TArray<FUniqueOfferId>& OfferIds,
         const FString& Error)
         {
             if (auto StoreV2 = StoreV2Wk.Pin())
@@ -229,7 +231,7 @@ StoreV2->QueryOffersById(
                 {
                     TArray<FOnlineStoreOfferRef> Offers;
                     StoreV2->GetOffers(Offers);
-                    
+
                     // Offers now contains a list of offers. You can call
                     // GetOffers from anywhere to get the cached list of
                     // offers.
@@ -244,7 +246,9 @@ StoreV2->QueryOffersById(
 
 To query for the available offers, use the "Query Offers by ID" blueprint node followed by "Get Offers".
 
-<Blueprint height="500px" blueprint={`
+<Blueprint
+  height="500px"
+  blueprint={`
 Begin Object Class=/Script/BlueprintGraph.K2Node_GetSubsystem Name="K2Node_GetSubsystem_0"
    CustomClass=/Script/CoreUObject.Class'"/Script/OnlineSubsystemBlueprints.OnlineStoreV2Subsystem"'
    NodePosX=624
@@ -330,7 +334,8 @@ Begin Object Class=/Script/BlueprintGraph.K2Node_MakeArray Name="K2Node_MakeArra
    CustomProperties Pin (PinId=22F5D1DF42B0296013404FAC236185F6,PinName="Array",Direction="EGPD_Output",PinType.PinCategory="string",PinType.PinSubCategory="",PinType.PinSubCategoryObject=None,PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=Array,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,LinkedTo=(K2Node_AsyncAction_1 FBDBD07F4FBD9DB441389297AFD14044,),PersistentGuid=00000000000000000000000000000000,bHidden=False,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,)
    CustomProperties Pin (PinId=EAB5F5D04198F8602191B894FD0BF6AA,PinName="[0]",PinType.PinCategory="string",PinType.PinSubCategory="",PinType.PinSubCategoryObject=None,PinType.PinSubCategoryMemberReference=(),PinType.PinValueType=(),PinType.ContainerType=None,PinType.bIsReference=False,PinType.bIsConst=False,PinType.bIsWeakPointer=False,PinType.bIsUObjectWrapper=False,PinType.bSerializeAsSinglePrecisionFloat=False,DefaultValue="test_iap",PersistentGuid=00000000000000000000000000000000,bHidden=False,bNotConnectable=False,bDefaultValueIsReadOnly=False,bDefaultValueIsIgnored=False,bAdvancedView=False,bOrphanedPin=False,)
 End Object
-`} />
+`}
+/>
 
 </TabItem>
-</Tabs>
+</Tabs>

docs/ossv1/ecom/purchasing.mdx

@@ -55,9 +55,9 @@ Refer to [Initating a purchase](#initating-a-purchase-on-any-platform) for an ex
 </TabItem>
 <TabItem value="google-play">
 
-When using Google Play Billing, in-app purchases will be available with their product IDs as the offer IDs. You can only purchase consumable items on Google Play; subscriptions and non-consumable items are not supported.
+When using Google Play Billing, in-app purchases will be available with their product IDs as the offer IDs. You can only purchase consumable and non-consumable items on Google Play; subscriptions are not supported.
 
-After a purchase completes on Google Play, you must award the player the in-app purchase and then call `FinalizePurchase` on the receipt to consume the purchase.
+After a purchase completes on Google Play, you must award the player the in-app purchase and then call `FinalizePurchase` on the receipt to consume or acknowledge the purchase.
 
 :::caution
 If you do not call `FinalizePurchase` when using Google Play, the user's purchase will be automatically refunded after 3 days.
@@ -180,7 +180,7 @@ To finalize purchases on Google Play, you need to check for outstanding receipts
 
 When the game starts up, you should query for any outstanding receipts so that you can finalize the purchases and award items.
 
-After a purchase is consumed with `FinalizePurchase`, the receipt will no longer appear when querying receipts or calling `GetReceipts`.
+After a purchase is consumed or acknowledged with `FinalizePurchase`, the receipt will no longer appear when querying receipts or calling `GetReceipts`.
 
 <Tabs lazy groupId="code-format" defaultValue="c++" values={[ { label: 'C++', value: 'c++' }, { label: 'Blueprints', value: 'blueprints' } ]}>
 <TabItem value="c++">
@@ -234,15 +234,15 @@ You _must_ handle deferred purchases on Google Play. Also, you can not know when
 The `OnUnexpectedPurchaseReceipt` event fires:
 
 - When a deferred purchase moves to the `Purchased` state.
-- When a receipt is consumed via `FinalizePurchase` and removed from the `GetReceipts` array.
+- When a receipt is consumed or acknowledged via `FinalizePurchase` and removed from the `GetReceipts` array.
 
 :::note
 The `TransactionId` field of a receipt is the `ReceiptId` to use in other functions.
 :::
 
-### Consuming a purchase via `FinalizePurchase`
+### Consuming or acknowledging a purchase via `FinalizePurchase`
 
-To acknowledge a purchase on Google Play and consume the purchase, you must call `FinalizePurchase`. If you don't call this function for a receipt, the user's purchase will automatically be refunded 3 days after it moved into the `Purchased` state.
+To acknowledge or consume a purchase on Google Play, you must call `FinalizePurchase`. If you don't call this function for a receipt, the user's purchase will automatically be refunded 3 days after it moved into the `Purchased` state.
 
 <Tabs lazy groupId="code-format" defaultValue="c++" values={[ { label: 'C++', value: 'c++' }, { label: 'Blueprints', value: 'blueprints' } ]}>
 <TabItem value="c++">
@@ -252,7 +252,8 @@ To consume a purchase, call `FinalizePurchase`:
 ```cpp
 Purchase->FinalizePurchase(
     *Identity->GetUniquePlayerId(0).Get(), // The local player to get offers for.
-    ReceiptId                             // The TransactionId field of the receipt.
+    ReceiptId,                             // The TransactionId field of the receipt.
+    TEXT("consume")                        // Or "acknowledge" to acknowledge without consuming the receipt.
 );
 ```