LIFF v2 APIリファレンス

LIFF SDKのエラーはLiffErrorオブジェクトで返されます。

liff.init()に渡したLIFFアプリID（String型）を保持するプロパティです。

liff.init()を実行するまでは、nullです。

LIFFアプリ起動後、liff.init()の実行が初めて終了したときにresolveするPromiseオブジェクトを保持するプロパティです。

liff.readyを利用すると、liff.init()の終了を待って、任意の処理を実行できます。

LIFFアプリを初期化します。

このメソッドを実行すると、LIFF SDKの他のメソッドを実行できるようになります。LIFFアプリは、ページを開くたびに必ず初期化する必要があります。同じLIFFアプリ内での遷移であっても、新たにページを開く場合にはliff.init()メソッドを実行してください。

LIFFアプリが正しく初期化されていない状態でLIFFの機能を使用した場合、それらの動作は保証対象外です。

liff.init()メソッドを実行するとき、LIFF SDKは現在のユーザーのアクセストークンやIDトークンをLINEプラットフォームから取得します。

• LIFF SDKが取得したアクセストークンを利用するには、「liff.getAccessToken()」を呼び出します。
• LIFF SDKが取得したIDトークンのペイロードを利用するには、「liff.getDecodedIDToken()」を呼び出します。

LIFFアプリ初期化時の注意事項

LIFFアプリを初期化する際の注意事項は以下のとおりです。注意事項を確認し、理解した上でLIFFアプリの開発を行ってください。

• liff.init()をエンドポイントURL以下の階層で実行する
• liff.init()を1次リダイレクト先URLと2次リダイレクト先URLで1回ずつ実行する
• URLを操作する処理はliff.init()が完了してから実行する
• 1次リダイレクト先URLの取り扱いに注意する

liff.init()をエンドポイントURL以下の階層で実行する

liff.init()メソッドはエンドポイントURLと完全に一致、もしくはエンドポイントURLよりも下の階層においてのみ動作します。これら以外のURLに遷移して実行した場合、liff.init()メソッドの動作は保証されません。

以下の例では、エンドポイントURLがhttps://example.com/path1/の場合に、liff.init()メソッドを実行するURLで動作が保証されるかどうかを示しています。なお、動作が保証されないURLでは、マルチタブビューなどのLIFFアプリの一部機能が正しく動作しない可能性があります。

liff.init() was called with a current URL that is not related to the endpoint URL.
https://example.com/path1/ is not under https://example.com/path1/path2/

liff.init()を1次リダイレクト先URLと2次リダイレクト先URLで1回ずつ実行する

liff.init()メソッドは、1次リダイレクト先URLに付与されるliff.stateやaccess_token=xxxなどの情報を元に初期化処理を行います。エンドポイントURLにクエリパラメータやパスが含まれている場合、正しくLIFFアプリを初期化するために、1次リダイレクト先URLと2次リダイレクト先URLで、1回ずつliff.init()メソッドを実行してください。リダイレクトについて詳しくは、『LIFFドキュメント』の「LIFF URLにアクセスしてからLIFFアプリが開くまでの動作について」を参照してください。

URLを操作する処理はliff.init()が完了してから実行する

URLを操作する処理は、liff.init()メソッドが返すPromiseオブジェクトがresolveしてから実行してください。

// Example using window.location.replace()
liff
  .init({
    liffId: "1234567890-AbcdEfgh", // Use own liffId
  })
  .then(() => {
    // Redirect to another page after the returned Promise object has been resolved
    window.location.replace(location.href + "/entry/");
  });

Promiseオブジェクトがresolveする前に、次のようなURLを操作する処理を実行すると、LIFFアプリを正常に開けない場合があります。

• Document.locationプロパティやWindow.locationプロパティを使ってURLを変更する
• History APIのhistory.pushState()メソッドやhistory.replaceState()メソッドを使ってURLを変更する
• サーバー側でステータスコード301や302を返し、別のURLにリダイレクトする

1次リダイレクト先URLの取り扱いに注意する

1次リダイレクト先URLに自動的に付与されるaccess_token=xxxはユーザーのアクセストークン（機密情報）です。Google Analyticsなど外部のロギングツールに、1次リダイレクト先URLを送らないように注意してください。

なお、LIFF v2.11.0以降のバージョンでは、liff.init()メソッドがresolveされたタイミングでURLから機密情報が除外されます。そのため、以下のようにthen()メソッド内でページビューを送信することで、機密情報の漏洩を防ぐことができます。ロギングツールを利用する場合は、LIFFアプリをv2.11.0以降にバージョンアップすることをお勧めします。LIFF v2.11.0の更新内容について詳しくは、『LIFFドキュメント』の「リリースノート」を参照してください。

liff
  .init({
    liffId: "1234567890-AbcdEfgh", // Use own liffId
  })
  .then(() => {
    ga("send", "pageview");
  });

ユーザーがLIFFアプリを動作させている環境を取得します。

LIFF SDKのバージョンを取得します。

ユーザーのLINEバージョンを取得します。

LIFFアプリが起動された画面（1対1のトーク、グループトーク、複数人トーク、または外部ブラウザ）に関する情報を取得します。

各種APIを呼び出すために必要な情報を含むデータオブジェクトが返されます。

availabilityオブジェクトには、以下のプロパティが含まれます。

menuColorSettingオブジェクトには、以下のプロパティが含まれます。

LIFFアプリをLIFFブラウザで動作させているかどうかを取得します。

ユーザーがログインしているかどうかを取得します。

指定したAPIが、LIFFアプリを起動した環境で使用可能かどうかを確認します。たとえば、APIが対応しているLINEバージョンであることや、APIを呼び出すために特別な同意が必要な場合は同意していることを確認します。

外部ブラウザおよびLINE内ブラウザ上で、ログイン処理を行います。

ログアウトします。

LIFF SDKが取得した「現在のユーザーのアクセストークン」を取得します。

LIFFアプリからサーバーにユーザー情報を送信するときに、このAPIで取得したアクセストークンを利用できます。サーバーでユーザー情報を使用する方法について詳しくは、『LIFFドキュメント』の「LIFFアプリおよびサーバーでユーザー情報を使用する」を参照してください。

LIFF SDKが取得した「現在のユーザーのIDトークン」を取得します。IDトークンは、ユーザー情報を含むJSONウェブトークン（JWT）です。

LIFFアプリからサーバーにユーザー情報を送信するときに、このAPIで取得したIDトークンを利用できます。サーバーでユーザー情報を使用する方法について詳しくは、『LIFFドキュメント』の「LIFFアプリおよびサーバーでユーザー情報を使用する」を参照してください。

LIFF SDKが取得したIDトークンの「ペイロード」を取得します。ペイロードには、ユーザーの表示名、プロフィール画像のURL、メールアドレスなどの情報が含まれます。

LIFFアプリでユーザーの表示名などを利用する場合に、このメソッドを利用してください。

なお取得できる情報はメインプロフィールのみです。ユーザーのサブプロフィールは取得できません。

IDトークンのペイロードが返されます。

IDトークンのペイロードについて詳しくは、「IDトークンからプロフィール情報を取得する」の「ペイロード」を参照してください。

ユーザーが権限の付与に同意したスコープの一覧を取得します。

このメソッドで取得できるスコープは次のとおりです。

• profile
• chat_message.write
• openid
• email

ユーザーが指定した権限の付与に同意しているかどうかを確認します。

現在のユーザーのプロフィール情報を取得します。

なお取得できる情報はメインプロフィールのみです。ユーザーのサブプロフィールは取得できません。

Promiseオブジェクトが返されます。

Promiseがresolveされると、ユーザーのプロフィール情報を含むオブジェクトが渡されます。

エラーレスポンス

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

ユーザーとLINE公式アカウントの友だち関係を取得します。

ただし、LIFFアプリが追加されているLINEログインのチャネルに、LINE公式アカウントがリンクされている場合に、そのLINE公式アカウントとの友だち関係のみを取得できます。LINEログインのチャネルに、LINE公式アカウントをリンクする方法については、『LINEログインドキュメント』の「LINEログインしたときにLINE公式アカウントを友だち追加する（友だち追加オプション）」を参照してください。

Promiseオブジェクトが返されます。

友だち関係を取得できると、Promiseがresolveされ、友だち関係に関する情報が渡されます。

エラーレスポンス

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

指定したURLをLINE内ブラウザまたは外部ブラウザで開きます。

LIFFアプリを閉じます。

LIFFアプリを閉じたときの挙動は、LINEアプリのバージョンやLIFFアプリの設定によって異なります。詳しくは、『LIFFドキュメント』の「LIFFアプリを閉じたときの挙動」を参照してください。

ユーザーの代わりに、LIFFアプリが開かれているトークルームにメッセージを送信します。

この機能を利用するには、以下の条件を満たす必要があります。

• 1対1のトーク、グループトーク、または複数人トークから起動したLIFFアプリのLIFFブラウザ内である
• chat_message.writeスコープが有効である
• LIFFアプリが「最近使用したサービス」から再読み込みされていない

条件を満たしていない場合、liff.sendMessages()メソッドが利用できず、エラーコード403のuser doesn't grant required permissions yetエラーが発生します。以下は、エラーが発生する場合の例です。

• Keepメモの機能を利用してLIFFアプリにアクセスした場合。
• ウェブサイトのリダイレクト処理などによりLIFFアプリを開くためのURLスキームにアクセスした場合。
• LIFF間遷移後のLIFFアプリでchat_message.writeスコープが無効になった場合。詳しくは、『LIFFドキュメント』の「LIFF間遷移後の「chat_message.write」スコープについて」を参照してください。
• ユーザーがchat_message.writeスコープを認可しなかった場合。

なお、LIFFアプリが起動された画面に関する情報は、liff.getContext()メソッドで取得できます。

ターゲットピッカー（グループまたは友だちを選択する画面）を表示し、ターゲットピッカーで選択した相手に、開発者が作成したメッセージを送信します。このメッセージは、ユーザーが送信したかのように、グループまたは友だちに表示されます。

liff.shareTargetPicker()メソッドの使用条件

liff.shareTargetPicker()メソッドを使用するには、以下の条件をすべて満たす必要があります。

• ユーザーがログインしている。
• LINE Developersコンソールでシェアターゲットピッカーがオンになっている。詳しくは、『LIFFドキュメント』の「シェアターゲットピッカーを利用するには」を参照してください。

二次元コードリーダーを起動し、読み取った文字列を取得します。二次元コードリーダーを起動するには、あらかじめLINE Developersコンソールで、 Scan QR をオンにする必要があります。

LINEの二次元コードリーダーを起動し、読み取った文字列を取得します。二次元コードリーダーを起動するには、あらかじめLINE Developersコンソールで、 Scan QR をオンにする必要があります。

LIFFアプリの任意のページのパーマネントリンクを取得します。

パーマネントリンクの形式：

https://liff.line.me/{liffId}/{path}?{query}#{URL fragment}

現在のページのパーマネントリンクを取得します。

パーマネントリンクの形式：

https://liff.line.me/{liffId}/{path}?{query}#{URL fragment}

現在のページのパーマネントリンクに、任意のクエリパラメータを追加できます。

liff.permanentLink.setExtraQueryParam()を実行するたびに、前回追加したクエリパラメータは破棄されます。

プラガブルSDKのLIFF APIや、LIFFプラグインを有効化し、初期化処理を実行します。

LIFF SDKが表示する文言の言語を指定します。

LINEミニアプリへのショートカットを、ユーザー端末のホーム画面に追加する画面を表示します。

詳しくは、『LINEミニアプリドキュメント』の「ユーザー端末のホーム画面にLINEミニアプリへのショートカットを追加する」を参照してください。