Messaging API SDKのサンプルコードを活用しよう

こんにちは！テクニカルライターの銭神です。みなさんは、LINEヤフーが提供しているMessaging API SDKを利用しているとき、「どうやってコードに落とし込めばいいかわからない……」と悩んだことはありませんか？

そんな悩みを解決する方法のひとつが、SDKのサンプルコードを見ることです。

この記事では、SDKのサンプルコードの場所や活用するメリット、またRuby版のサンプルコードの一部を紹介します。

• 各言語向けのSDKのサンプルコード
• サンプルコードを活用するメリット
• 具体例：Ruby版のSDKでプッシュメッセージを送る方法
• おわりに

各言語向けのSDKのサンプルコード

Messaging APIの各言語向けのSDKは、すべてGitHub上でオープンソースとして公開されています。各リポジトリにあるexamples（またはsamples）ディレクトリの中に、実際に動作させることができるサンプルコードが格納されています。

サンプルコードを活用するメリット

サンプルコードには、署名の検証やWebhookの受け取り、エラーハンドリングといった基本的な処理が含まれており、これをベースに開発することができます。

また、プッシュメッセージや応答メッセージの送り方など、Messaging APIの機能を利用する方法も記述されているため、開発のときの辞書がわりにもなります。

具体例：Ruby版のSDKでプッシュメッセージを送る方法

サンプルコードの見方の例として、ここではRuby版のSDKでプッシュメッセージを送る方法を見てみます。Ruby版のSDKのサンプルコードは、line-bot-sdk-ruby/examplesにあります。この中のv2/kitchensinkには、さまざまな機能のコードがあります。

サンプルコードを見ると、たとえばユーザーにプッシュメッセージを送る方法が以下のようになることがわかります。

client = Line::Bot::V2::MessagingApi::ApiClient.new(channel_access_token: ENV.fetch("LINE_CHANNEL_ACCESS_TOKEN"))

push_request = Line::Bot::V2::MessagingApi::PushMessageRequest.new(
  to: "ユーザーID",
  messages: [
    Line::Bot::V2::MessagingApi::TextMessage.new(text: "Hello, world!")
  ]
)

client.push_message(push_message_request: push_request)

おわりに

Messaging API SDKを利用しているときに迷ったら、各言語のサンプルコードを見てみると、解決につながるかもしれません。この記事が、たのしい開発につながればうれしいです！