[DroidKaigi 2020] Re:ゼロから始める Play Billing Library / Re: Zero - starting uses of Play Billing Library

BillingClient = BillingClient.newBuilder(application) .enablePendingPurchases() .setListener(this /* PurchasesUpdatedListener */) .build() } BillingViewModel.kt

class BillingViewModel(application: Application) : ViewModel(), PurchasesUpdatedListener { private val billingClient:

class BillingViewModel(application: Application) : ViewModel(), PurchasesUpdatedListener { ...省略... /** 購入完了、購入キャンセルなどのコールバック

*/ override fun onPurchasesUpdated( billingResult: BillingResult, purchases: MutableList<Purchase>? ) { } } BillingViewModel.kt

class BillingViewModel(application: Application) : ViewModel(), PurchasesUpdatedListener { private val billingClient:

BillingClient = BillingClient.newBuilder(application) .enablePendingPurchases() .setListener(this /* PurchasesUpdatedListener */) .build() ...省略... } BillingViewModel.kt

• BillingClientは課金サービスへの接続完了後や購入完了後などさまざまな状態に応じたイベントを受け取れる • 現在どのような状態なのかを知るため、各状態をあらかじめ定義し、LiveDataで管理する LiveDataで課金の状態を管理する

sealed class BillingStatus { object SetupSuccess : BillingStatus() object BillingFlow

: BillingStatus() object PendingPurchase : BillingStatus() object AcknowledgeSuccess : BillingStatus() object ServiceDisconnected : BillingStatus() object NoPreviousPlanPurchaseHistory : BillingStatus() data class Error(val billingResult: BillingResult) : BillingStatus() } BillingStatus.kt

sealed class BillingStatus { object SetupSuccess : BillingStatus() object BillingFlow

class BillingViewModel(application: Application) : ViewModel(), PurchasesUpdatedListener { ...省略... /** 購入完了、購入キャンセルなどのコールバック

sealed class BillingStatus { object SetupSuccess : BillingStatus() object BillingFlow

class BillingViewModel(application: Application) : ViewModel(), PurchasesUpdatedListener { ...省略... private val

_billingStatus = MutableLiveData<BillingStatus>() val billingStatus: LiveData<BillingStatus> = _billingStatus } BillingViewModel.kt

Google Playの課金サービスに接続する

• 課金を行うには、Google Playの課金サービスへの接続が必要 • 課金サービスへの接続は通常、課金したい画面のonCreateなどのイベント発生時に実行する Google Playの課金サービスに接続する

• AACのLifecycleObserverを使うとActivityや Fragmentのライフサイクルイベントを任意のメソッドで受け取れる • ViewModelにLifecycleObserverを実装して onCreate時に課金サービスへ接続する Google Playの課金サービスに接続する

Google Playの課金サービスに接続する ViewModel BillingClient Google Play startConnection onServiceConnected bindService onBillingSetupFinished

Fragment OnLifecycleEvent: onCreate LiveData: SetupSuccess

Google Playの課金サービスに接続する ViewModel BillingClient Google Play startConnection onServiceConnected bindService onBillingSetupFinished

class BillingViewModel(application: Application) : ViewModel(), BillingClientStateListener, PurchasesUpdatedListener { ...省略... private

fun startConnection() { billingClient.startConnection(this /* BillingClientStateListener */) } } BillingViewModel.kt

class BillingViewModel(application: Application) : ViewModel(), BillingClientStateListener, PurchasesUpdatedListener { ...省略... private

class BillingViewModel(application: Application) : ViewModel(), BillingClientStateListener, PurchasesUpdatedListener { ...省略... override

fun onBillingSetupFinished(billingResult: BillingResult) { if (billingResult.responseCode == BillingClient.BillingResponseCode.OK) _billingStatus.postValue(BillingStatus.SetupSuccess) else _billingStatus.postValue(BillingStatus.Error(billingResult)) } override fun onBillingServiceDisconnected() = Unit } BillingViewModel.kt

class BillingViewModel(application: Application) : ViewModel(), BillingClientStateListener, PurchasesUpdatedListener { ...省略... override

class BillingViewModel(application: Application) : ViewModel(), BillingClientStateListener, PurchasesUpdatedListener, LifecycleObserver { ...省略...

@OnLifecycleEvent(Lifecycle.Event.ON_CREATE) fun onCreate() { startConnection() } } BillingViewModel.kt

class BillingViewModel(application: Application) : ViewModel(), BillingClientStateListener, PurchasesUpdatedListener, LifecycleObserver { ...省略...

@OnLifecycleEvent(Lifecycle.Event.ON_CREATE) fun onCreate() { startConnection() } } BillingViewModel.kt

class BillingViewModel(application: Application) : ViewModel(), BillingClientStateListener, PurchasesUpdatedListener, LifecycleObserver { override

fun onCleared() { super.onCleared() billingClient.endConnection() } } BillingViewModel.kt

class BillingViewModel(application: Application) : ViewModel(), BillingClientStateListener, PurchasesUpdatedListener, LifecycleObserver { override

fun onCleared() { super.onCleared() billingClient.endConnection() } } BillingViewModel.kt

課金アイテムの情報を取得する

• Google Playの管理アイテムにはそれぞれアイテムIDが振られている • アイテムIDはPlay Console上でアイテムを追加する際に自ら設定する • PBL内ではSKUと呼ばれる

アイテム情報を取得する

• アイテムの種類や金額などの情報がまとまったオブジェクトをSkuDetailsと呼び、アイテムID を使って取得できる • SkuDetailsはアイテムを購入する際にも利用するアイテム情報を取得する

アイテムの購入画面を表示するまでの流れユーザーアプリ Google Play アイテムの購入ボタンをタップ SkuDetails アイテムの購入画面を表示 SkuDetailsを元に購入をリクエスト

アイテムIDとアイテムの種類を元にアイテム情報をリクエスト

アイテムの購入画面を表示するまでの流れユーザーアプリ Google Play アイテムの購入ボタンをタップ SkuDetails アイテムの購入画面を表示アイテムIDとアイテムの種類を元にアイテム情報をリクエスト

SkuDetailsを元に購入をリクエスト

アイテムの購入画面を表示するまでの流れユーザーアプリ Google Play アイテムの購入ボタンをタップ SkuDetails アイテムの購入画面を表示アイテムIDとアイテムの種類を元にアイテム情報をリクエスト

• アイテム情報を取得するにはアイテムIDとアイテムの種類が必要 • アプリで購入できるアイテムが複数ある場合は、一箇所でまとめて定義しておくほうが便利アイテムを管理する

• PBLではアプリ内のアイテムの種類を SkuTypeとして表す ◦ SkuType.INAPP … 管理対象アイテム ◦ SkuType.SUBS …

定期購入アイテムを管理する

enum class BillingSkuType( @BillingClient.SkuType val skuType: String ) { /**

定期購読 */ Subscription(BillingClient.SkuType.SUBS), /** 消費不可のアプリ内アイテム */ InAppNonConsumable(BillingClient.SkuType.INAPP), /** 消費可能なアプリ内アイテム */ InAppConsumable(BillingClient.SkuType.INAPP), } BillingSkuType.kt

enum class BillingItem(val sku: String, val billingSkuType: BillingSkuType) { MonthlyPlan(

"monthly_plan", BillingSkuType.Subscription), MonthlyPremiumPlan( "monthly_premium_plan", BillingSkuType.Subscription), NonConsumableItem( "non_consumable_item", BillingSkuType.InAppNonConsumable), ConsumableItem( "consumable_item", BillingSkuType.InAppConsumable), AndroidTestPurchased( "android.test.purchased", BillingSkuType.InAppNonConsumable); } BillingSkuType.kt

enum class BillingItem(val sku: String,val billingSkuType: BillingSkuType) { ...省略... fun

skusList(): List<String> = listOf(sku) companion object { fun findBySku(sku: String): BillingItem? = values().find { it.sku == sku } } } BillingSkuType.kt

private fun getSkuDetails( billingItem: BillingItem, onResponse: (skuDetails: SkuDetails) -> Unit

) { val skuDetailsParams = SkuDetailsParams.newBuilder() .setSkusList(billingItem.skusList()) .setType(billingItem.billingSkuType.skuType) .build() ...省略... BillingViewModel.kt

billingClient.querySkuDetailsAsync(skuDetailsParams ) { billingResult: BillingResult, skuDetailList: List<SkuDetails> -> if (billingResult.responseCode

== BillingClient.BillingResponseCode.OK && skuDetailList.isNotEmpty() ) { onResponse(skuDetailList[0]) } else { _billingStatus.postValue(BillingStatus.Error(billingResult)) } } } BillingViewModel.kt

billingClient.querySkuDetailsAsync(skuDetailsParams ) { billingResult: BillingResult, skuDetailList: List<SkuDetails> -> if (billingResult.responseCode

アイテムの購入画面を表示するまでの流れユーザーアプリ Google Play アイテムの購入ボタンをタップ SkuDetails アイテムの購入画面を表示アイテムIDとアイテムの種類を元にアイテム情報をリクエスト

fun purchase(activity: Activity, billingItem: BillingItem) { getSkuDetails(billingItem) { skuDetails ->

val flowParams = BillingFlowParams.newBuilder() .setSkuDetails(skuDetails) .build() _billingStatus.postValue(BillingStatus.BillingFlow) billingClient.launchBillingFlow(activity, flowParams) } } BillingViewModel.kt

class BillingFragment : Fragment(), View.OnClickListener { ...省略... override fun onClick(v:

View?) { billingViewModel.purchase( requireActivity(), BillingItem.NonConsumableItem ) } } BillingFragment.kt

None

支払いをしてからアイテムを受け取るまでの流れユーザーアプリサーバー支払いを行うレシートアイテムを渡す Google Play レシートを送信

class BillingViewModel(application: Application) : ViewModel(), PurchasesUpdatedListener { ...省略... /** 購入完了、購入キャンセルなどのコールバック

• Purchaseには注文IDや購入したアイテムのアイテムID、購入日時などの購入情報を含むレシートが入っている • レシートはユーザーが購入したことを証明する唯一の手がかりレシートの取得、検証

• たとえば、ユーザーが購入している定期購入の契約状況をサーバーが知りたい場合、レシートに含まれる情報が無ければ契約情報を取得できないレシートの取得、検証

• ユーザーのアイテム購入状況を取得するためにはレシートは必須 • そのためレシートを受け取ったアプリは通常、サービスのサーバーへレシートを送信するレシートの取得、検証

• Purchaseオブジェクトのsignatureというプロパティは購入情報を含むレシートデータを開発者用の秘密鍵で署名しているため、これを送信するレシートの取得、検証

• 署名されたレシートを受け取ったサーバーは開発者用の公開鍵を使って復号化し、改ざんなどを検証する • 検証結果に問題がなければアプリに購入結果を返却するレシートの取得、検証

• 結果を受け取ったアプリはユーザーに対してアイテム購入が完了したことを表示するなどしてアイテムの受け渡しが完了するレシートの取得、検証

定期購入を契約する

• 週、月、3ヶ月、6ヶ月、年間のいずれかの期間で定期的に課金できるアイテム • 新規の定期購入者に対して無料試用期間やお試し価格の設定もできる定期購入

• ある定期購入アイテムから別の定期購入アイテムへのプラン変更をする仕組みも提供されている • 初回購入以降の支払いは、アイテムに設定されている定期購入の期間に応じて自動的に支払われる定期購入

class BillingFragment : Fragment(), View.OnClickListener { ...省略... override fun onClick(v:

View?) { billingViewModel.purchase( requireActivity(), BillingItem.MonthlyPlan ) } } BillingFragment.kt

class BillingFragment : Fragment(), View.OnClickListener { ...省略... override fun onClick(v:

View?) { billingViewModel.purchase( requireActivity(), BillingItem.MonthlyPlan ) } } BillingFragment.kt

None

定期購入のプランを変更する

• 定期購入の購入と同じくlaunchBillingFlowメソッドを使う • BillingFlowParamsのsetOldSkuメソッドでプラン変更前の定期購入アイテムを指定する定期購入のプラン変更

• 以前はsetOldSkuにSKUだけ渡せば良かったが、PBL 2.1.0からSKUだけを渡すメソッドは非推奨となった • SKUに加えて変更前のプランの PurchaseTokenが必要になった定期購入のプラン変更

fun changePlan( activity: Activity, billingItem: BillingItem, oldBillingItem: BillingItem ) {

billingClient.queryPurchaseHistoryAsync( BillingClient.SkuType.SUBS) { _, purchases -> val purchase: PurchaseHistoryRecord? = purchases.find { it.sku == oldBillingItem.sku } if (purchase == null) { _billingStatus.postValue( BillingStatus.NoPreviousPlanPurchaseHistory) return@queryPurchaseHistoryAsync } BillingViewModel.kt

fun changePlan( activity: Activity, billingItem: BillingItem, oldBillingItem: BillingItem ) {

billingClient.queryPurchaseHistoryAsync( BillingClient.SkuType.SUBS) { _, purchases -> ...省略... getSkuDetails(billingItem) { skuDetails

-> val flowParams = BillingFlowParams.newBuilder() .setSkuDetails(skuDetails) .setOldSku(purchase.sku, purchase.purchaseToken) .build() _billingStatus.postValue(BillingStatus.BillingFlow) billingClient.launchBillingFlow(activity, flowParams) } BillingViewModel.kt

billingClient.queryPurchaseHistoryAsync( BillingClient.SkuType.SUBS) { _, purchases -> ...省略... getSkuDetails(billingItem) { skuDetails

-> val flowParams = BillingFlowParams.newBuilder() .setSkuDetails(skuDetails) .setOldSku(purchase.sku, purchase.purchaseToken) .build() _billingStatus.postValue(BillingStatus.BillingFlow) billingClient.launchBillingFlow(activity, flowParams) } BillingViewModel.kt

class BillingFragment : Fragment(), View.OnClickListener { ...省略... override fun onClick(v:

View?) { billingViewModel.changePlan( requireActivity(), billingItem = BillingItem.MonthlyPremiumPlan, oldBillingItem = BillingItem.MonthlyPlan ) } } BillingFragment.kt

None

アプリからacknowledgeする

acknowledgeに対応した支払いフローユーザーアプリサーバー支払いを行うレシート承認リクエスト承認結果アイテムを渡す Google

private fun acknowledgePurchase(purchase: Purchase) { if (purchase.purchaseState == Purchase.PurchaseState.PURCHASED &&

purchase.isAcknowledged.not()) { val acknowledgePurchaseParams = AcknowledgePurchaseParams.newBuilder() .setPurchaseToken(purchase.purchaseToken) .build() billingClient.acknowledgePurchase( acknowledgePurchaseParams, this /* AcknowledgePurchaseResponseListener */ ) } BillingViewModel.kt

private fun acknowledgePurchase(purchase: Purchase) { if (purchase.purchaseState == Purchase.PurchaseState.PURCHASED &&

class BillingViewModel(application: Application) : ViewModel(), BillingClientStateListener, PurchasesUpdatedListener, LifecycleObserver, AcknowledgePurchaseResponseListener {

override fun onAcknowledgePurchaseResponse(billingResult: BillingResult) { if (billingResult.responseCode() == BillingClient.BillingResponseCode.OK) { _billingStatus.postValue(BillingStatus.AcknowledgeSuccess) } else { _billingStatus.postValue(BillingStatus.Error(billingResult)) } } } BillingViewModel.kt

プラン変更時の承認処理

• 購入アイテムの承認はプラン変更時も同様に承認しなければならない • プランを変更すると、Google Playの仕様上、以前のプランがキャンセルされ、新たなプランを契約するという形になるプラン変更時の承認処理

プラン変更時の支払いの流れユーザーアプリ Google Play 支払いを行うレシートプランを利用可能にする以前のプランを解約

新しいプランを契約

プラン変更時の支払いの流れユーザーアプリ Google Play 支払いを行うレシートプランを利用可能にする以前のプランを解約

新しいプランを契約

プラン変更時の支払いの流れユーザーアプリ Google Play 支払いを行うレシートプランを利用可能にする以前のプランを解約

新しいプランを契約プラン変更後3日以内に承認しなかった場合は？

プラン変更後3日以内に承認しなかった場合ユーザーアプリ Google Play 支払いを行うレシートプランを利用可能にする以前のプランを解約

新しいプランを契約 3日以内に承認されていない払い戻し

プラン変更後3日以内に承認しなかった場合ユーザーアプリ Google Play 支払いを行うレシートプランを利用可能にする以前のプランを解約

新しいプランを契約 3日以内に承認されていない払い戻し

プラン変更後3日以内に承認しなかった場合ユーザーアプリ Google Play 支払いを行うレシートプランを利用可能にする以前のプランを解約

新しいプランを契約 3日以内に承認されていない払い戻しユーザーが新たにプランを契約し、その契約が承認されない状態でプランを変更した場合は？

• テスト購入で確認したところ、以前購入したプランが承認されていない状態でもプラン変更は可能 • 承認されていない変更前のプランは払い戻され、変更後のプランが承認されていれば問題なく契約が継続されるプラン変更時の承認処理

• 正しく承認しなければプラン契約中のユーザーが解約される事態になってしまう • 確実に承認されるように慎重にフローを組む必要があるプラン変更時の承認処理

Pending transactionsに対応する

• 購入後、通常のアプリ課金と同様に onPurchasesUpdatedメソッドに購入結果が返却される • 保留中の購入はpurchaseStateが PurchaseState.PENDINGになっている Pending transactionsに対応する

private fun acknowledgePurchase(purchase: Purchase) { if (purchase.purchaseState == Purchase.PurchaseState.PURCHASED &&

purchase.isAcknowledged.not()) { ...省略... } else if ( purchase.purchaseState == Purchase.PurchaseState.PENDING ) { _billingStatus.postValue(BillingStatus.PendingPurchase) } } BillingViewModel.kt

class BillingFragment : Fragment(), View.OnClickListener { override fun onViewCreated(view: View,

savedInstanceState: Bundle?) { super.onViewCreated(view, savedInstanceState) billingViewModel.billingStatus.observe( viewLifecycleOwner, Observer { billingStatus -> when (billingStatus) { BillingStatus.SetupSuccess -> { // 購入履歴を取得して承認する } } }) } BillingFragment.kt