外部优惠计划的应用内集成指南

本指南介绍了如何在符合条件的区域和应用中集成 API 以支持外部优惠。如需详细了解外部优惠计划（包括资格要求和适用区域范围），请参阅计划要求。

Play Billing Library 设置

要使用外部优惠 API，请向您的 Android 应用添加 6.2.1 或更高版本的 Play Billing Library 依赖项。如果您需要从较早版本迁移，请先按照迁移指南中的说明操作，然后再尝试实现外部优惠。

连接到 Google Play

集成流程的第一步与结算集成指南中描述的步骤相同，但在初始化 BillingClient 时有一些修改

以下示例演示了如何通过这些修改来初始化 BillingClient

Kotlin

var billingClient = BillingClient.newBuilder(context)
  .enableExternalOffer()
  .build()

Java

private BillingClient billingClient = BillingClient.newBuilder(context)
    .enableExternalOffer()
    .build();

初始化 BillingClient 后，您需要按集成指南中的说明建立与 Google Play 的连接。

检查可用性

您的应用应通过调用 isExternalOfferAvailableAsync 来确认外部优惠是否可用。

如果外部优惠可用，此 API 会返回 BillingResponseCode.OK。有关您的应用应如何响应其他响应代码的详细信息，请参阅响应处理。

Kotlin


billingClient.isExternalOfferAvailableAsync(
  object : ExternalOfferAvailabilityListener {
    override fun onExternalOfferAvailabilityResponse(
      billingResult: BillingResult) {
        if (billingResult.responseCode !=  BillingResponseCode.OK) {
            // Handle failures such as retrying due to network errors,
            // handling external offers unavailable, etc.
            return
        }

        // External offers are available. Continue with steps in the
        // guide.
})

Java


billingClient.isExternalOfferAvailableAsync(
  new ExternalOfferAvailabilityListener() {
    @Override
    public void onExternalOfferAvailabilityResponse(
      BillingResult billingResult) {
        if (billingResult.getResponseCode() != BillingResponseCode.OK) {
            // Handle failures such as retrying due to network errors,
            // handling external offers being unavailable, etc.
            return;
        }
        // External offers are available. Continue with steps in the
        // guide.
      }

});

准备外部交易令牌

要向 Google Play 报告外部交易，您必须拥有由 Play Billing Library 生成的外部交易令牌。用户每次通过外部优惠 API 访问外部网站时，都必须生成新的外部交易令牌。这可以通过调用 createExternalOfferReportingDetailsAsync API 来完成。此令牌应在用户被导向应用外部之前立即生成。切勿缓存此令牌，并且每次用户被导向应用外部时都应生成新令牌。

Kotlin


billingClient.createExternalOfferReportingDetailsAsync(
  object : ExternalOfferReportingDetailsListener {
    override fun onExternalOfferReportingDetailsResponse(
      billingResult: BillingResult,
      externalOfferReportingDetails: ExternalOfferReportingDetails?) {
        if (billingResult.responseCode !=  BillingResponseCode.OK) {
            // Handle failures such as retrying due to network errors.
            return
        }
        val externalTransactionToken =
            externalOfferReportingDetails?.externalTransactionToken
        // Persist the transaction token locally. Pass it to the external
        // website when showExternalOfferInformationDialog is called.
    }
})

Java


billingClient.createExternalOfferReportingDetailsAsync(
  new ExternalOfferReportingDetailsListener() {
    @Override
    public void onExternalOfferReportingDetailsResponse(
      BillingResult billingResult,
      @Nullable ExternalOfferReportingDetails
        externalOfferReportingDetails) {
        if (billingResult.getResponseCode() != BillingResponseCode.OK) {
            // Handle failures such as retrying due to network errors.
            return;
        }

        String transactionToken =
          externalOfferReportingDetails.getExternalTransactionToken();

        // Persist the external transaction token locally. Pass it to the
        // external website when showExternalOfferInformationDialog is
        // called.
      }
});

用户须知对话框

要集成外部优惠，您的符合条件的应用必须显示一个信息屏幕，帮助用户了解他们即将被导向应用外部的外部网站。每次链接到外部优惠之前，都必须通过调用 showExternalOfferInformationDialog API 向用户显示此信息屏幕。

Kotlin


// An activity reference from which the external offers information dialog
// will be launched.
val activity : Activity = ...;

val listener : ExternalOfferInformationDialogListener =
  ExternalOfferInformationDialogListener {
      override fun onExternalOfferInformationDialogResponse(
        billingResult: BillingResult){
        // Check billingResult
    }
}

val billingResult = billingClient.showExternalOfferInformationDialog(
  activity, listener)

Java


// An activity reference from which the external offers information dialog
// will be launched.
Activity activity = ...;

ExternalOfferInformationDialogListener listener =
  new ExternalOfferInformationDialogListener() {
    @Override
    public void onExternalOfferInformationDialogResponse(
      BillingResult billingResult) {
        if (billingResult.responseCode !=  BillingResponseCode.OK) {
          // Handle failures such as retrying due to network errors.
        }
        // Open the external website, passing along the external transaction
        // token as a URL parameter. If the user purchases an item, be sure
        // to report the transaction to Google Play.
      }
}

BillingResult billingResult =
  billingClient.showExternalOfferInformationDialog(activity, listener);

如果此方法返回 BillingResponseCode.OK，则您的应用可以继续将用户导向外部网站。如果此方法返回 BillingResponseCode.USER_CANCELED，则您的应用不得继续打开网站。

向 Google Play 报告交易

所有外部交易都必须通过从后端调用 Google Play Developer API 向 Google Play 报告。报告外部交易时，必须提供通过 createExternalOfferReportingDetailsAsync API 获取的 externalTransactionToken。如果用户进行多次购买，您可以使用相同的 externalTransactionToken 来报告每次购买。如需了解如何报告交易，请参阅后端集成指南。

响应处理

发生错误时，isExternalOfferAvailableAsync、createExternalOfferReportingDetailsAsync 和 showExternalOfferInformationDialog 方法可能会返回 BillingResponseCode.OK 以外的响应。请考虑按如下方式处理这些响应代码

  • ERROR：这是一个内部错误。请勿继续进行交易或打开外部网站。下次尝试将用户导向应用外部时，请再次调用 showExternalOfferInformationDialog() 以向用户显示信息对话框，然后重试。
  • FEATURE_NOT_SUPPORTED：当前设备上的 Play 商店不支持外部优惠 API。请勿继续进行交易或打开外部网站。
  • USER_CANCELED：请勿继续打开外部网站。下次尝试将用户导向应用外部时，请再次调用 showExternalOfferInformationDialog() 以向用户显示信息对话框。
  • BILLING_UNAVAILABLE：此交易不符合外部优惠的条件，因此不应在此计划下继续进行。这可能是因为用户不在符合该计划条件的国家/地区，或者您的帐号尚未成功注册该计划。如果是后者，请在 Play 管理中心检查您的注册状态。
  • DEVELOPER_ERROR：请求有误。继续操作前，请使用调试消息找出并纠正错误。
  • NETWORK_ERROR, SERVICE_DISCONNECTED, SERVICE_UNAVAILABLE：这些是暂时性错误，应通过适当的重试政策进行处理。对于 SERVICE_DISCONNECTED，请在重试之前重新建立与 Google Play 的连接。

测试外部优惠

应使用许可测试人员来测试您的外部优惠集成。许可测试人员帐号发起的交易不会计费。如需详细了解如何配置许可测试人员，请参阅使用应用许可测试应用内结算功能。

后续步骤

完成应用内集成后，您就可以集成后端了。