はじめに
LINEのAPIには様々な種類のサービスとそのドキュメントがあります。
その中には申請等を行うことで法人ユーザーが利用できる、法人ユーザー向けオプションが存在します。
今回はこのオプションの中からミッションスタンプAPIの実装における注意事項について解説していきます。
ミッションスタンプとは
LINEユーザーに無料または条件付きで提供しているLINEプロモーションスタンプのうち、ミッションをクリアすることで取得できるスタンプになります。
事例一覧も様々、公開されています。
また、ミッションスタンプにはさらにミッションの有無によって区分があります。
- LINEプロモーションスタンプとは
- プロモーションスタンプの区分
本記事ではスポンサードミッションスタンプを前提として記載していきます。
開発にあたって
ミッションスタンプの開発にあたっては、LINEよりミッションスタンプ ガイドラインが公開されています。
このガイドラインにはミッションの種類や実装における仕様、大まかな実施の流れが記載されており、実装において必要な情報を知ることができます。
また、ミッションスタンプのAPIもリファレンスがあります。
用意されているAPIは1つですが、そのAPIによってスタンプショップのダウンロードリンクを有効にすることができます。
*ボタンのラベルが変わっている様子。画像はガイドラインより
実装の注意事項
ここからは本題の実装時の注意点に関して下記の点について記載します。
- トークンの違いに注意する
- 友だち登録が必須なのでチャンネルに注意する
- キャンセル時の動作をガイドラインに合わせる
- ちょっと驚く、LINEブラウザ独特な動き
- ミッションスタンプを有効化してしまった...
トークンの違いに注意する
まず注意することとしては、トークンの違いです。
ミッションスタンプにおいて利用するトークンは2種類存在します。
それぞれの項目については次項に記載していきます。ここでは私が誤解した点を記載します。
-
チャネルアクセストークン
- 発行するチャネル： Messaging APIチャネル、LINEログインチャネルなど
-
アクセストークン
- 発行するチャネル： LINEログインチャネル
ミッションスタンプAPIのリファレンスにあるように、AuthorizationヘッダーにBearerトークンを指定します。
このBearerトークンにはchannel access tokenを使用します。
このチャネルアクセストークンとアクセストークンの関係性に注意が必要です。
アクセストークンの一種にチャネルアクセストークンがあるわけではありません。
チャネルアクセストークン ⊂ アクセストークン
あくまでも、アクセストークンとチャネルアクセストークンは別物となります。
チャネルアクセストークン ≠ アクセストークン
アクセストークンはチャネルアクセストークンの代替にはなりません。
そのため、ミッションスタンプAPIを叩く際にはチャネルアクセストークンが必要になります。
チャネルアクセストークン
チャネルアクセストークンはチャネルごとに別物のトークンになります。
開発グループや利用グループごとに発行が想定されているものになります。
LINE Developersのコンソールでもチャネルアクセストークンを確認できます。
*Messaging APIチャネルに記載
ただし、画像に(長期)とあるように、このチャネルアクセストークンは新たに発行するまで期限切れにならないトークンです。
そのため利用は控えた方がよいでしょう。その代わりに別方法でチャネルアクセストークンを用意する必要があります。
それにはチャネルアクセストークンの種類に記載がある、短期のチャネルアクセストークンやJWTを使って発行するトークンを利用します。
アクセストークン
アクセストークンはLINEログインでユーザが認可作業をするとLINEから返ってくるトークンになります。
このアクセストークンはLINEログインで取得する以外にSDKを使うことで取得できます。
アクセストークンはLINEログインで利用するため、LINEログインチャネルを作成することになります。
友だち登録が必須なのでチャンネルに注意する
ミッションスタンプ ガイドラインに友だちにならないとミッション画⾯には 進めないように実装してくださいと記載があるように、ミッションスタンプでは友だち登録が必須です。
友だち登録の状況を確認するため、前項に記載したアクセストークンを利用し、友だち関係を確認するAPIを叩く必要があります。
curl -v -X GET https://api.line.me/friendship/v1/status -H 'Authorization: Bearer {access token}'
そのため、ミッションスタンプの施策ではミッションスタンプAPIの実行に必要なチャネルアクセストークンとアクセストークンの2つトークンが存在することに注意が必要です。
ただし、2つのトークンを用意することは、Messaging APIチャネルとLINEログインチャネルの2つが必要ということではありません。
ミッションスタンプの利用申請はどちらのチャネルからもできてしまいます。
LINEログインチャネルでもチャネルアクセストークンの発行はできるため、「LINEログイン」という名を冠したチャネルですがミッションスタンプAPIを実行できます。
そのため、どのチャネルでどのトークンを使って、LINE APIを実行するのか整理をしておくことをお勧めします。
※筆者は混同した結果、実装の修正に手間取りました...
キャンセル時の動作をガイドラインに合わせる
ミッションスタンプの申請を進めていくと、スタンプパッケージIDの発⾏とそれを設定したチャネルでの挙動のテストを行うことになります。
この際、LINEログインでユーザが認可した後にリダイレクトされるCallback先を、ミッション画面にしている場合に注意が必要となります。
実装は下記の流れでした。
- Callback先がバックエンドではなくフロントエンドのミッション画面に設定。
- フロントエンド側で認可の確認。
- バックエンドにて認可コードを使ってアクセストークンの取得、友だち状況の確認を実施するためにフロントエンドからリクエスト
4. 認可コードに誤りがあるなど、本来のアクセスと異なる場合にはリダイレクト。
ガイドラインの確認項目として、認証画⾯の「キャンセル」ボタンを押すとスタンプショップ詳細画⾯に戻る（または適切なLPに遷移する）というものがあります。
上記の実装場合、LINEログインでキャンセルを押した場合でも、まずはCallback URLにリダイレクトされます。何も制御されていないとミッション画面が表示されてしまいます。
このようなミッション画面で認可の確認をする実装にしている場合には、表示制御によってLPと同等のページを表示することでガイドラインに沿う形にできます。
また、次項でも記載しますが、スタンプショップ詳細画⾯にリダイレクト処理をした場合にはブラウザの同じタブ上では遷移せず、別タブで表示される挙動となります。
ちょっと驚く、LINEブラウザ独特な動き
ミッションスタンプではLINEアプリからアクセスするため、LINE内部にあるLINEアプリ内ブラウザ（以降、LINEブラウザ）が起動、ミッション画面にアクセスします。
このLINEブラウザには他のブラウザとは異なる挙動があります。
例えば、ガイドラインのFAQにはBasic認証に関して記載があります。（ミッションスタンプガイドライン 2022.09版）
Q5.
本番チャネルでの動作確認の際、本番環境にベーシック認証を導⼊しても問題ないでしょうか︖
A.
LINEアプリ内ブラウザではベーシック認証の動作保証していないため、別⼿段での制御をお願い致します。
ここでは落とし穴というわけではありませんが、そうなるの？となった動きを紹介します。
スタンプショップ詳細画⾯に遷移した場合はLINEブラウザでページの遷移をするのではなく、別の画面として被さる形で表示されます。
下記のGIF画像がその時の動きです。（わかりやすくするために被さる動きの部分のみ動画速度を下げています。）
LINEブラウザではリンクを押せば画面が同じタブ内で遷移するとは限らないようです。
そのため、特にLINEブラウザからLINEの他サービスにリンクで遷移する場合にはスマホでの確認をおすすめします。
ミッションスタンプを有効化してしまった...
ミッションスタンプを有効化してしまったら、どうしようもないので気をつけましょうというお話です。
ミッションスタンプAPIのリファレンスを見るとわかりますが、ミッションスタンプの利用を許可するAPIしかありません。
一度ミッションを達成し、ミッションスタンプの有効化をすると無効にできません。
ユーザがスタンプを無効化することはないのでAPIが用意されていないのも当たり前ですが、テストの時には困ったことになります。
申請を行う際にリリース前チェックを行う必要があります。（ガイドライン参照）
リリース前チェックはOS別に4パターンのテストがあります。
もし、本番環境の動作確認のついでにミッションスタンプを有効化してしまうと、リリース前チェックにそのアカウントは利用できません。
パターン別にLINEアカウントを用意する必要があるので動作確認を先にしてしまうと、後々アカウントが足りない、なんてことが起きるかもしれません。
※筆者はやらかしてしまったので、メンバーにリリース前チェックをお願いすることになりました・・・（ごめんなさい
）
おわりに
弊社でミッションスタンプの施策を実施した際に出会った開発時の注意点に関して解説しました。
法人ユーザー向けオプションというのもあるため携わる機会が少ないかもしれませんが、実施する際の手助けになれば幸いです。