diff --git a/src/content/docs/zh/sdk/cocos2dx/v5/features/subscriptions.mdoc b/src/content/docs/zh/sdk/cocos2dx/v5/features/subscriptions.mdoc index 7e564ab65..758101b61 100644 --- a/src/content/docs/zh/sdk/cocos2dx/v5/features/subscriptions.mdoc +++ b/src/content/docs/zh/sdk/cocos2dx/v5/features/subscriptions.mdoc @@ -1,50 +1,53 @@ --- -title: 发送订阅信息 -description: 使用这些方法向 Adjust 发送订阅信息。 -slug: zh/sdk/cocos2dx/features/subscriptions -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /zh/sdk/cocos2dx/v4/features/subscriptions +title: "发送订阅信息" +description: "使用这些方法向 Adjust 发送订阅信息。" +slug: "en/sdk/cocos2dx/features/subscriptions" +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/cocos2dx/v4/features/subscriptions" --- - -{% callout type="important" %} -The following steps only set up subscription measurement within the Adjust SDK. To enable the feature, follow the steps at [Set up subscriptions for your app](https://help.adjust.com/zh/article/set-up-subscriptions-for-your-app). -{% /callout %} +\{% callout type="important" %\} +下列步骤仅会在 Adjust SDK 中设置订阅监测。要启用该功能,请按照[为应用设置订阅监测](https://help.adjust.com/en/article/set-up-subscriptions-for-your-app)中的步骤操作。 +\{% /callout %\} 您可以用 Adjust SDK 记录 App Store 和 Play 应用商店的订阅,并验证这些订阅是否有效。 -## 工作原理{% #how-it-works %} +工作原理\{% \#how\-it\-works %\} +--------------------------------- 用户购买订阅后,创建一个 `AdjustAppStoreSubscription2dx` 或 `AdjustPlayStoreSubscription2dx` 实例。这些类包含表示订阅详细信息的属性,允许 Adjust 监测订阅事件。 -## App Store 订阅 {% #app-store-subscriptions %} +App Store 订阅 \{% \#app\-store\-subscriptions %\} +----------------------------------------------------- `AdjustAppStoreSubscription2dx`类代表 App Store 订阅信息。您可以创建该类的多个实例来向 Adjust 发送订阅信息。 要开始设置,先实例化一个包含订阅购买细节的订阅对象。 -### 实例化 App Store 订阅对象{% #instantiate-an-app-store-subscription-object %} +### 实例化 App Store 订阅对象\{% \#instantiate\-an\-app\-store\-subscription\-object %\} 使用以下参数实例化`AdjustAppStoreSubscription2dx`对象: -{% deflist %} -`price` (`std::string`) +\{% deflist %\} +`price` \(`std::string`\) : 订阅价格 -`currency` (`std::string`) +`currency` \(`std::string`\) : 订阅使用的币种。此信息格式为[`priceLocale`](https://developer.apple.com/documentation/foundation/nslocale/1642836-currencycode?language=objc)对象的 [`currencyCode`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=objc)。 -`transactionId` (`std::string`) +`transactionId` \(`std::string`\) : 您的交易 ID。 -{% /deflist %} +\{% /deflist %\} ```cpp AdjustAppStoreSubscription2dx subscription = AdjustAppStoreSubscription2dx( @@ -54,17 +57,17 @@ AdjustAppStoreSubscription2dx subscription = AdjustAppStoreSubscription2dx( ); ``` -### 记录购买日期{% #record-the-purchase-date-app-store %} +### 记录购买日期\{% \#record\-the\-purchase\-date\-app\-store %\} 您可以记录用户购买订阅的日期。SDK 会返回该数据用于报告。 在您的订阅对象上调用 `setTransactionDate` 方法来记录订阅的时间戳。 -{% deflist %} -`transactionDate` (`std::string`) +\{% deflist %\} +`transactionDate` \(`std::string`\) : 订阅时间戳 -{% /deflist %} +\{% /deflist %\} ```cpp AdjustAppStoreSubscription2dx subscription = AdjustAppStoreSubscription2dx( @@ -75,15 +78,15 @@ AdjustAppStoreSubscription2dx subscription = AdjustAppStoreSubscription2dx( subscription.setTransactionDate({% $variables.subscription.appStoreSubscription.transactionDate %}); ``` -### 记录购买地区{% #record-the-purchase-region %} +### 记录购买地区\{% \#record\-the\-purchase\-region %\} 您可以记录用户购买订阅的地区。为此,请在订阅对象上调用 `setSalesRegion` 方法并将国家代码作为 **字符串** 传递。此信息格式需为 [`Storefront`](https://developer.apple.com/documentation/storekit/storefront/3792000-countrycode) 对象 的 [`countryCode`](https://developer.apple.com/documentation/storekit/storefront) 。 -{% deflist %} -`salesRegion` (`std::string`) +\{% deflist %\} +`salesRegion` \(`std::string`\) : 订阅的国家代码。 -{% /deflist %} +\{% /deflist %\} ```cpp AdjustAppStoreSubscription2dx subscription = AdjustAppStoreSubscription2dx( @@ -94,7 +97,7 @@ AdjustAppStoreSubscription2dx subscription = AdjustAppStoreSubscription2dx( subscription.setSalesRegion({% $variables.subscription.appStoreSubscription.salesRegion %}); ``` -### 添加回传参数{% #add-callback-parameters-app-store %} +### 添加回传参数\{% \#add\-callback\-parameters\-app\-store %\} 您可以向订阅对象附加回传参数。SDK 会将这些参数附加至您的回传 URL。要添加回传参数,请在订阅对象上调用 `addCallbackParameter` 方法。多次调用该方法可添加多个回传参数。 @@ -108,7 +111,7 @@ subscription.addCallbackParameter({% $variables.subscription.key1 %}); subscription.addCallbackParameter({% $variables.subscription.key2 %}); ``` -### 添加合作伙伴参数{% #add-partner-parameters-app-store %} +### 添加合作伙伴参数\{% \#add\-partner\-parameters\-app\-store %\} 您可以向订阅对象附加合作伙伴参数。用户购买订阅时,SDK 会将这些参数发送至 Adjust 服务器。Adjust 服务器会将此信息转发至您的合作伙伴。要添加合作伙伴参数,请在您的订阅对象上调用`addPartnerParameter`方法。多次调用该方法可添加多个合作伙伴参数。 @@ -122,31 +125,29 @@ subscription.addPartnerParameter({% $variables.subscription.key1 %}); subscription.addPartnerParameter({% $variables.subscription.key2 %}); ``` -### App Store 订阅教程{% #tutorial-app-store %} +### App Store 订阅教程\{% \#tutorial\-app\-store %\} 设置好订阅对象后,您就可以通过 Adjust SDK 对其进行记录了。 本教程将展示如何使用`AdjustAppStoreSubscription2dx`和`AdjustPlayStoreSubscription2dx`类向 Adjust 发送订阅信息。您可了解到: 1. 如何创建并填充`AdjustAppStoreSubscription2dx`或`AdjustPlayStoreSubscription2dx`实例。 -1. 如何在应用中使用`AdjustAppStoreSubscription2dx`和`AdjustPlayStoreSubscription2dx`类向 Adjust 发送订阅信息。 +2. 如何在应用中使用`AdjustAppStoreSubscription2dx`和`AdjustPlayStoreSubscription2dx`类向 Adjust 发送订阅信息。 如需向 Adjust 发送订阅信息,请按照下列步骤操作: -1. 使用`price` 、 `currency`和`transactionId`实例化并填充`AdjustAppStoreSubscription2dx`对象。下方示例中使用了以下值: - - * `price`为 *{% $variables.subscription.appStoreSubscription.price %}* 。 - * `currency`为 *{% $variables.subscription.appStoreSubscription.currency %}* 。 - * `transactionId`为 *{% $variables.subscription.appStoreSubscription.transactionId %}* - -1. 下方示例中设置了以下属性: +1. 使用`price` 、 `currency`和`transactionId`实例化并填充`AdjustAppStoreSubscription2dx`对象。下方示例中使用了以下值: + * `price`为 *\{% $variables.subscription.appStoreSubscription.price %\}* 。 + * `currency`为 *\{% $variables.subscription.appStoreSubscription.currency %\}* 。 + * `transactionId`为 *\{% $variables.subscription.appStoreSubscription.transactionId %\}* - * 交易日期设为 *{% $variables.subscription.appStoreSubscription.transactionDate %}* - * 销售地区设为 *{% $variables.subscription.appStoreSubscription.salesRegion %}* 。 - * 回传参数设为 *{% $variables.subscription.key1 %}* 和 *{% $variables.subscription.key2 %}* 。 - * 合作伙伴参数设为 *{% $variables.subscription.key1 %}* 和 *{% $variables.subscription.key2 %}* 。 +2. 下方示例中设置了以下属性: + * 交易日期设为 *\{% $variables.subscription.appStoreSubscription.transactionDate %\}* + * 销售地区设为 *\{% $variables.subscription.appStoreSubscription.salesRegion %\}* 。 + * 回传参数设为 *\{% $variables.subscription.key1 %\}* 和 *\{% $variables.subscription.key2 %\}* 。 + * 合作伙伴参数设为 *\{% $variables.subscription.key1 %\}* 和 *\{% $variables.subscription.key2 %\}* 。 -1. 在函数末尾,使用`AdjustAppStoreSubscription2dx`实例作为参数调用`trackAppStoreSubscription`,以此将信息发送至 Adjust。 +3. 在函数末尾,使用`AdjustAppStoreSubscription2dx`实例作为参数调用`trackAppStoreSubscription`,以此将信息发送至 Adjust。 ```cpp #include "Adjust/Adjust2dx.h" @@ -171,41 +172,42 @@ subscription.addPartnerParameter({% $variables.subscription.key2 %}); Adjust2dx::trackAppStoreSubscription(subscription); ``` -## Play 商店订阅 {% #play-store-subscriptions %} +Play 商店订阅 \{% \#play\-store\-subscriptions %\} +--------------------------------------------------- `AdjustPlayStoreSubscription2dx`类代表 App Store 订阅信息。您可以创建该类的多个实例来向 Adjust 发送订阅信息。 要开始设置,先实例化一个包含订阅购买细节的订阅对象。 -### 实例化 Play 应用商店订阅对象{% #instantiate-a-play-store-subscription-object %} +### 实例化 Play 应用商店订阅对象\{% \#instantiate\-a\-play\-store\-subscription\-object %\} 使用以下参数实例化`AdjustPlayStoreSubscription2dx`对象: -{% deflist %} -`price` (`std::string`) +\{% deflist %\} +`price` \(`std::string`\) : 订阅价格 -`currency` (`std::string`) +`currency` \(`std::string`\) : 订阅使用的币种 -`sku` (`std::string`) +`sku` \(`std::string`\) : 产品 ID -`orderId` (`std::string`) +`orderId` \(`std::string`\) : 您的交易 ID -`signature` (`std::string`) +`signature` \(`std::string`\) : 购买数据的签名 -`purchaseToken` (`std::string`) +`purchaseToken` \(`std::string`\) -: 交易唯一识别码。请参考 [Google 的文档](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getPurchaseToken\(\)),了解更多信息 -{% /deflist %} +: 交易唯一识别码。请参考 [Google 的文档](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getPurchaseToken()),了解更多信息 +\{% /deflist %\} ```cpp AdjustPlayStoreSubscription2dx subscription = AdjustPlayStoreSubscription2dx( @@ -218,17 +220,17 @@ AdjustPlayStoreSubscription2dx subscription = AdjustPlayStoreSubscription2dx( ); ``` -### 记录购买日期{% #record-the-purchase-date-play-store %} +### 记录购买日期\{% \#record\-the\-purchase\-date\-play\-store %\} 您可以记录用户购买订阅的日期。SDK 会返回该数据用于报告。 在您的订阅对象上调用 `setPurchaseTime` 方法来记录订阅的时间戳。 -{% deflist %} -`purchaseTime` (`std::string`) +\{% deflist %\} +`purchaseTime` \(`std::string`\) : 订阅时间戳。 -{% /deflist %} +\{% /deflist %\} ```cpp AdjustPlayStoreSubscription2dx subscription = AdjustPlayStoreSubscription2dx( @@ -242,7 +244,7 @@ AdjustPlayStoreSubscription2dx subscription = AdjustPlayStoreSubscription2dx( subscription.setPurchaseTime({% $variables.subscription.playStoreSubscription.purchaseTime%}); ``` -### 添加回传参数{% #add-callback-parameters-play-store %} +### 添加回传参数\{% \#add\-callback\-parameters\-play\-store %\} 您可以向订阅对象附加回传参数。SDK 会将这些参数附加至您的回传 URL。要添加回传参数,请在订阅对象上调用 `addCallbackParameter` 方法。多次调用该方法可添加多个回传参数。 @@ -259,7 +261,7 @@ subscription.addCallbackParameter({% $variables.subscription.key1 %}); subscription.addCallbackParameter({% $variables.subscription.key2 %}); ``` -### 添加合作伙伴参数{% #add-partner-parameters-play-store %} +### 添加合作伙伴参数\{% \#add\-partner\-parameters\-play\-store %\} 您可以向订阅对象附加合作伙伴参数。用户购买订阅时,SDK 会将这些参数发送至 Adjust 服务器。Adjust 服务器会将此信息转发至您的合作伙伴。要添加合作伙伴参数,请在您的订阅对象上调用`addPartnerParameter`方法。多次调用该方法可添加多个合作伙伴参数。 @@ -276,33 +278,31 @@ subscription.addPartnerParameter({% $variables.subscription.key1 %}); subscription.addPartnerParameter({% $variables.subscription.key2 %}); ``` -### Play 商店订阅教程 {% #tutorial-play-store %} +### Play 商店订阅教程 \{% \#tutorial\-play\-store %\} 设置好订阅对象后,您就可以通过 Adjust SDK 对其进行记录了。 本教程将展示如何使用`AdjustAppStoreSubscription2dx`和`AdjustPlayStoreSubscription2dx`类向 Adjust 发送订阅信息。您可了解到: 1. 如何创建并填充`AdjustAppStoreSubscription2dx`或`AdjustPlayStoreSubscription2dx`实例。 -1. 如何在应用中使用`AdjustAppStoreSubscription2dx`和`AdjustPlayStoreSubscription2dx`类向 Adjust 发送订阅信息。 +2. 如何在应用中使用`AdjustAppStoreSubscription2dx`和`AdjustPlayStoreSubscription2dx`类向 Adjust 发送订阅信息。 如需向 Adjust 发送订阅信息,请按照下列步骤操作: -1. 使用`price` 、 `currency` 、 `sku` 、 `orderId` 、 `signature` 、 `purchaseToken`实例化并填充`AdjustPlayStoreSubscription2dx`对象。下方示例中使用了以下值: +1. 使用`price` 、 `currency` 、 `sku` 、 `orderId` 、 `signature` 、 `purchaseToken`实例化并填充`AdjustPlayStoreSubscription2dx`对象。下方示例中使用了以下值: + * `price`为 *\{% $variables.subscription.playStoreSubscription.price %\}* 。 + * `currency`为 *\{% $variables.subscription.playStoreSubscription.currency %\}* 。 + * `sku`为 *\{% $variables.subscription.playStoreSubscription.sku %\}* 。 + * `orderId`为 *\{% $variables.subscription.playStoreSubscription.orderId %\}* 。 + * `signature`为 *\{% $variables.subscription.playStoreSubscription.signature %\}* 。 + * `purchaseToken`为 *\{% $variables.subscription.playStoreSubscription.purchaseToken %\}* 。 - * `price`为 *{% $variables.subscription.playStoreSubscription.price %}* 。 - * `currency`为 *{% $variables.subscription.playStoreSubscription.currency %}* 。 - * `sku`为 *{% $variables.subscription.playStoreSubscription.sku %}* 。 - * `orderId`为 *{% $variables.subscription.playStoreSubscription.orderId %}* 。 - * `signature`为 *{% $variables.subscription.playStoreSubscription.signature %}* 。 - * `purchaseToken`为 *{% $variables.subscription.playStoreSubscription.purchaseToken %}* 。 +2. 下方示例中设置了以下属性: + * 购买时间设置为 *\{% $variables.subscription.playStoreSubscription.purchaseTime %\}* + * 回传参数设为 *\{% $variables.subscription.key1 %\}* 和 *\{% $variables.subscription.key2 %\}* 。 + * 合作伙伴参数设为 *\{% $variables.subscription.key1 %\}* 和 *\{% $variables.subscription.key2 %\}* 。 -1. 下方示例中设置了以下属性: - - * 购买时间设置为 *{% $variables.subscription.playStoreSubscription.purchaseTime %}* - * 回传参数设为 *{% $variables.subscription.key1 %}* 和 *{% $variables.subscription.key2 %}* 。 - * 合作伙伴参数设为 *{% $variables.subscription.key1 %}* 和 *{% $variables.subscription.key2 %}* 。 - -1. 在函数末尾,使用`AdjustAppStoreSubscription2dx`实例作为参数调用`trackPlayStoreSubscription`,以此将信息发送至 Adjust。 +3. 在函数末尾,使用`AdjustAppStoreSubscription2dx`实例作为参数调用`trackPlayStoreSubscription`,以此将信息发送至 Adjust。 ```cpp #include "Adjust/Adjust2dx.h" @@ -328,3 +328,4 @@ subscription.addPartnerParameter({% $variables.subscription.key1 %}); subscription.addPartnerParameter({% $variables.subscription.key2 %}); Adjust2dx::trackPlayStoreSubscription(subscription); ``` +