LINEミニアプリにアプリ内課金を組み込む

このページでは、LINEミニアプリにアプリ内課金機能を組み込む方法について説明します。

事前準備

実装を開始する前に、以下が完了していることを確認してください。

• LINEミニアプリが認証済ミニアプリとして公開されている、または未認証ミニアプリの場合は開発用のチャネルが使用できる
• アプリ内課金機能の利用申請が承認されている
• LINEミニアプリのサーバーが用意されている
• Webhookの受信エンドポイント（Webhook URL）が用意されている （※）

※ Webhook URLは、アプリ内課金の利用申請が承認された後に、LINE Developersコンソールで登録します。

実装の流れ

アプリ内課金は、以下の流れで組み込みます。

1. アプリ内課金が利用可能な環境かを確認する
2. 購入可能なアイテムの情報を取得する
3. ユーザーからアプリ内課金利用の同意を取得する
4. LINEミニアプリのサーバーから購入処理を予約する
5. ストアでの購入処理を開始する
6. Webhookを受信して購入完了を処理する

1. アプリ内課金が利用可能な環境かを確認する

liff.isApiAvailable()メソッドを呼び出して、アプリ内課金が利用可能な環境かを確認します。

liff.isApiAvailable("iap");

外部ブラウザを使用している場合や、ユーザーが使用しているLINEアプリのバージョンがアプリ内課金に非対応である場合などは、LINEミニアプリを利用不可にしたり、購入導線を表示しないようにしたりするなどの制御をしてください。

liff.isApiAvailable()メソッドを使い、アプリ内課金に対応している環境であることが確認できた場合でも、「3. ユーザーからアプリ内課金利用の同意を取得する」においてユーザーからの同意を得ることができない場合や、後から同意が撤回された場合は、アプリ内課金を利用できません。

2. 購入可能なアイテムの情報を取得する

購入可能なアイテム情報を取得し、ユーザーに表示します。

アプリ内課金で購入可能なアイテムは、日本円を基準にしてLINEヤフー株式会社によって事前に定義されています。アプリ内課金で購入可能なアイテムをユーザーに表示する際には、ユーザー体験を損ねないように、ユーザーが使用するアプリストアのリージョンにローカライズされた価格と通貨の値を用いて表示してください。

事前に定義されているアイテムのうち、LINEミニアプリでサポートするアイテムは、アプリ内課金を利用するサービス事業主のポリシーに従って定めることができます。liff.iap.getPlatformProducts()メソッドに指定して呼び出すことで、それらのアイテムについて、ローカライズされた価格、通貨、およびアイテム名を取得できます。

const productIds = ["iap_ln_002", "iap_ln_003"];
await liff.iap.getPlatformProducts({ productIds });

例:

{
  "iap_ln_002": {
    "currency": "JPY",
    "price": 100,
    "productName": "LINE Purchase 100"
  },
  "iap_ln_003": {
    "currency": "JPY",
    "price": 150,
    "productName": "LINE Purchase 150"
  }
}

3. ユーザーからアプリ内課金利用の同意を取得する

liff.iap.requestConsentAgreement()メソッドを使用して、「LINEアプリ内課金利用規約」に対するユーザーの同意を取得します。

await liff.iap.requestConsentAgreement();

このプロセスは、LINEミニアプリごとではなく、ユーザーごとに一度だけ完了する必要があります。ユーザーが他のLINEミニアプリですでにアプリ内課金の利用に同意している場合は、再同意は不要です。起動中のLINEミニアプリですでに同意が得られている場合も、再同意は必要ありません。

ただし、LINEアプリ内課金利用規約が更新された場合、再度の同意が必要になることがあります。したがって、アプリ内課金を開始する際には、常にliff.iap.requestConsentAgreement()メソッドを呼び出して、最新の同意状況を確認する必要があります。

同意を得ていないユーザーが、購入処理の予約および購入処理を開始することはできません。まだユーザーによる同意が完了しておらず、同意が新たに必要な場合は、その場で同意画面が表示されます。同意画面の表示に伴うユーザーの離脱を避けるために、適切なタイミングで同意のリクエストを行うことを推奨します。

4. LINEミニアプリのサーバーから購入処理を予約する

アプリストア（App Store、Google Play）での購入処理を開始する前に、LINEミニアプリのサーバーから「購入処理を予約する」エンドポイントで購入処理の予約を行います。

LINEミニアプリのサーバーから購入処理の予約は、「ユーザーがLINEミニアプリ上でアイテムの購入ボタンを押した」等のタイミングで行ってください。

購入処理の予約時に追加で必要となるパラメータについては、以下の方法で取得します。

• 認証時のアクセストークンはliff.getAccessToken()メソッドで取得されるユーザーアクセストークンを取得して指定してください。
• clientIpはLINEミニアプリのサーバーで取得したユーザーのIPアドレスを指定してください。
• clientOsはliff.getOS()メソッドで取得される値を指定してください。

この時点では、購入はまだ完了していません。たとえば、購入処理の予約が成功した場合でも、その後ユーザーがLINEミニアプリから離脱したり、アプリストアの購入処理をキャンセルしたりした場合は、予約が成功していても実際の購入は完了しないということに注意してください。

購入処理の予約時にレスポンスから取得できる注文ID（orderIdの値）は、決済の完了時にLINEプラットフォームから送信されるWebhookのパラメータとしても含まれます。このorderIdの値については当社への問い合わせや調査等に必要であるため、ログやストレージに記録してください。

また、レスポンスに含まれるx-line-request-idヘッダーの値についても同様に記録し、orderIdの値と合わせてお問い合わせください。

5. ストアでの購入処理を開始する

購入予約が完了したら、LINEミニアプリからアプリストア決済を開始します。

await liff.iap.createPayment({
  productId,
  orderId,
});

購入処理が成功すると、LINEプラットフォーム側でストアに問い合わせが行われ、決済が正しく行われたことを検証します。決済が正しく行われたことが検証された場合に、事前に設定されたWebhookのエンドポイントURLに対し、LINEプラットフォームから購入完了のWebhookイベントを通知します。通知されるWebhookイベントについて詳しくは、『LINEミニアプリAPIリファレンス』の「購入完了イベント」を参照してください。

購入がキャンセルされた場合や購入処理が失敗した場合は、例外が発生します。必要に応じてエラーハンドリングを実装してください。

try {
  await liff.iap.createPayment({
    productId,
    orderId,
  });
} catch (e) {
  // e => { code: "CANCELED", message: "Transaction was canceled." }
  console.error({
    code: e.code,
    message: e.message,
  });
}

6. Webhookを受信して購入完了を処理する

LINEプラットフォーム通知された購入完了のWebhookイベントを受信したら、LINEミニアプリのサーバーで中身を確認し、ユーザーにアイテムを付与してください。ユーザーにアイテムを付与する具体的な処理については、開発しているLINEミニアプリの実装によって異なります。

Webhookイベントの特性上、ネットワークやアプリケーションに起因するエラーなどにより、同一のイベントが複数回通知される可能性があります。また、LINEミニアプリのサーバーで特定の購入完了イベントを正常に受信した場合でも、LINEプラットフォーム側で受信されたことを確認できなかった場合については、同一のイベントが再通知される可能性があります。

ユーザーの購入については、購入の予約時に発行されたユニークなorderIdが割り当てられています。orderIdを使用して処理済みかどうかを判定してください。また、1つの購入に対して、アイテム付与は1回のみ行ってください。

購入完了の判断は、必ずWebhookイベントを基準に行ってください。

Webhookへのレスポンス

LINEプラットフォームでは、LINEミニアプリのサーバーからのレスポンスの内容は確認しないため、任意のペイロードを返すことができます。

ただし、サーバーでWebhookを正常に受信した場合は、200番台のステータスコードを返す必要があります。

他のステータスコード（300番台、400番台、500番台など）が返されると、LINEプラットフォームは失敗として認識し、Webhookの再送を試みます。再送は30分以内に複数回行われます。

Webhookイベントの履歴を取得する

「Webhookイベントの履歴を取得する」エンドポイントを利用すると、過去に送信されたWebhookイベントの履歴を取得できます。

受信に失敗したWebhookイベントについて開発者側でリカバリーなどの実施が必要な場合は、このエンドポイントを利用してください。

詳しくは、『LINEミニアプリAPIリファレンス』の「Webhookイベントの履歴を取得する」を参照してください。

決済成功時のユーザーへの通知

決済が完了すると、LINEヤフー株式会社の「LINEアプリ内課金お知らせ」LINE公式アカウントから、購入したユーザーに自動的にメッセージが送信されます。そのため、開発者側で追加の対応を行う必要はありません。

このアカウントは、ユーザーがブロックしたり、通知設定を変更することはできません。ただし、まれにユーザーの利用環境やサーバーの状況により、通知が届かない場合があります。あらかじめご了承ください。

ユーザーが購入履歴を確認する方法

ユーザーは、LINEアプリの「設定」画面の［アプリ内課金］を開くか、LINE公式アカウント「LINEアプリ内課金お知らせ」から送信されたメッセージからアプリ内課金の履歴を確認できます。最大1年間の決済履歴が確認可能です。

「アプリ内課金」画面の赤枠で囲まれた部分で表示される値については、アプリ内課金の利用を申請する時点や、購入予約リクエスト時点、ユーザーがストアで購入する際の実際の価格と通貨が反映されます。