LINEミニアプリ APIリファレンス

サービス通知トークンを発行します。サービス通知トークンを使用すると、紐づけられたユーザーに対してサービスメッセージを送信できます。

サービス通知トークンの特徴は以下のとおりです。

• サービス通知トークンは、発行から1年間（31,536,000秒間）有効です。有効期限が切れるまでに、最大5回サービスメッセージを送信できます。
• サービス通知トークンを使用すると、有効期限が切れておらず、残りの送信可能回数が0でない場合は、サービス通知トークンの値が更新されます。ユーザーに対して、後続のサービスメッセージを送信する場合は、更新後のサービス通知トークンを保存してください。

ステータスコード200と以下の情報を含むJSONオブジェクトを返します。

以下のいずれかのステータスコードとエラーメッセージを返します。

サービス通知トークンで指定されたユーザーに、サービスメッセージを送信します。

サービスメッセージを送信すると、有効期限が切れておらず、残りの送信可能回数が0でない場合は、サービス通知トークンの値が更新されます。ユーザーに対して、後続のサービスメッセージを送信する予定がある場合は、更新後のサービス通知トークンを保存してください。

ステータスコード200と以下の情報を含むJSONオブジェクトを返します。

以下のいずれかのステータスコードとエラーメッセージを返します。

ユーザーがアカウントセンターで設定している共通プロフィールの情報を取得します。

liff.$commonProfile.get()メソッドを実行すると、ユーザーがプロフィールの情報を確認するためのモーダルが表示されます。表示されたモーダルでプロフィールを確認後、ユーザーが［自動で入力する］をタップすると、共通プロフィールの情報を取得できます。

モーダルの表示例：

{ data: Partial<CommonProfile>, error: Partial<CommonProfileError>}型のPromiseオブジェクトが返されます。

Promiseがresolveされると、dataプロパティにユーザーの共通プロフィール情報を含むPartial<CommonProfile>型、errorプロパティにエラー情報を含むPartial<CommonProfileError>型のオブジェクトが渡されます。

次のような場合、dataが持つプロパティはundefinedもしくはnullになります。

• undefinedになるケース
  • 引数のscopesで対象の項目を指定していない場合
  • 引数のscopesで対象の項目を指定したが、ユーザーがその項目の権限を許可していない場合
• nullになるケース
  • ユーザーが共通プロフィールで対象の項目に値を設定していない場合
  • 共通プロフィールで対象の項目を取得する時にエラーが発生した場合

指定したスコープに応じて取得できるプロパティの値については、「取得できる共通プロフィールのスコープと戻り値」を参照してください。

Promiseがrejectされたときは、LiffErrorが渡されます。

共通プロフィールのダミーデータを取得します。10種類のダミーデータが用意されており、caseIdによって取得するダミーデータを指定できます。

liff.$commonProfile.getDummy()メソッドを実行すると、プロフィールの情報を確認するためのモーダルが表示されます。［自動で入力する］をタップすると、共通プロフィールのダミーデータを取得できます。

モーダルの表示例：

{ data: Partial<CommonProfile>, error: Partial<CommonProfileError>}型のPromiseオブジェクトが返されます。

Promiseがresolveされると、dataプロパティにダミーデータを含むPartial<CommonProfile>型、errorプロパティにエラー情報を含むPartial<CommonProfileError>型のオブジェクトが渡されます。

次のような場合、dataが持つプロパティはundefinedもしくはnullになります。

• undefinedになるケース
  • 引数のscopesで対象の項目を指定していない場合
• nullになるケース
  • ダミーデータで対象の項目に値が設定されていない場合

指定したIDに応じて取得できるダミーデータについては、「取得できる共通プロフィールのダミーデータ」を参照してください。

Promiseがrejectされたときは、LiffErrorが渡されます。

取得した共通プロフィールの情報をフォームに自動入力します。それぞれのプロフィール情報とフォームの紐づけには、data-liff-autocomplete属性を用います。

アプリ内課金で購入可能なアイテムの一覧を取得します。

Promiseオブジェクトが返されます。Promiseオブジェクトがresolveされると、プロダクトIDをキーとし、以下のプロパティを持つオブジェクトが渡されます。

Promiseがrejectされたときは、LiffErrorが渡されます。

発生する可能性があるエラーには、次のようなものがあります。

HTTPステータスコードが400番台または500番台の場合、以下のJSONデータを含むレスポンスボディが返されます。

アプリストア決済を開始する前に、購入処理を予約します。

レスポンスに含まれる注文ID（orderId）は購入完了イベントにも含まれます。注文IDは弊社への問い合わせや調査で必要になるため、必ず保存してください。

また、予約成功は購入完了を保証しないため、アイテム付与は購入完了イベントを起点に行ってください。

ステータスコード200と以下の情報を含むJSONオブジェクトを返します。

エラーレスポンスの形式については、エラーレスポンスを参照してください。

一般的なもの以外で発生する可能性があるエラーには、次のようなものがあります。

LINEプラットフォームが送信したWebhookイベントの履歴を取得します。カーソルベースのページネーションで、1回に最大100件取得できます。

ソート順は、LINEプラットフォームでWebhookイベントの送信を開始した日時の昇順となります。

取得できるWebhookイベントは過去7日間に送信されたものに限られます。現時点では購入完了イベントのみ取得可能で、返金イベントは今後対応予定です。

成功した場合、ステータスコード200と以下の情報を含むJSONオブジェクトを返します。