Merge pull request #166 from line/feature/endpoints_for_friend_statistics

Support user interaction statistics API

Author: kimoto

examples/kitchensink/app.rb

@@ -27,12 +27,17 @@ def reply_text(event, texts)
   )
 end
 
+def broadcast(messages)
+  client.broadcast(messages)
+end
+
 def reply_content(event, messages)
   res = client.reply_message(
     event['replyToken'],
     messages
   )
   logger.warn res.read_body unless Net::HTTPOK === res
+  res
 end
 
 post '/callback' do
@@ -532,6 +537,31 @@ def handle_message(event)
         client.leave_room(event['source']['roomId'])
       end
 
+    when 'stats'
+      response = broadcast({
+        type: 'template',
+        altText: 'stats',
+        template: {
+          type: 'buttons',
+          thumbnailImageUrl: THUMBNAIL_URL,
+          title: 'stats sample',
+          text: 'Hello, my stats',
+          actions: [
+            { label: 'Go to line.me', type: 'uri', uri: 'https://line.me', altUri: {desktop: 'https://line.me#desktop'} },
+            { label: 'Send postback', type: 'postback', data: 'hello world' },
+            { label: 'Send postback2', type: 'postback', data: 'hello world', text: 'hello world' },
+            { label: 'Send message', type: 'message', text: 'This is message' }
+          ]
+        }
+      })
+      request_id = response.header["X-Line-Request-Id"]
+      reply_text(event, "RequestId: #{request_id}")
+
+    when /\Astats\s+(?<request_id>.+)/
+      request_id = Regexp.last_match[:request_id]
+      stats = client.get_user_interaction_statistics(request_id)
+      reply_text(event, "[STATS]\n#{stats.body}")
+
     else
       reply_text(event, "[ECHO]\n#{event.message['text']}")
 

lib/line/bot/client.rb

@@ -563,6 +563,18 @@ def get_number_of_message_deliveries(date)
         get(endpoint, endpoint_path, credentials)
       end
 
+      # Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.
+      #
+      # @param [String] request_id
+      #
+      # @return [Net::HTTPResponse]
+      def get_user_interaction_statistics(request_id)
+        channel_token_required
+
+        endpoint_path = "/bot/insight/message/event?requestId=#{request_id}"
+        get(endpoint, endpoint_path, credentials)
+      end
+
       # Returns the number of followers
       #
       # @param [String] date (Format:yyyyMMdd, Example:20191231)

spec/line/bot/client_get_spec.rb

@@ -143,6 +143,52 @@
 }
 EOS
 
+USER_INTERACTION_STATISTICS_CONTENT = <<EOS
+{
+    "overview": {
+        "requestId": "f70dd685-499a-4231-a441-f24b8d4fba21",
+        "timestamp": 1568214000,
+        "delivered": 32,
+        "uniqueImpression": 4,
+        "uniqueClick": null,
+        "uniqueMediaPlayed": 2,
+        "uniqueMediaPlayed100Percent": -1
+    },
+    "messages": [
+        {
+            "seq": 1,
+            "impression": 18,
+            "mediaPlayed": 11,
+            "mediaPlayed25Percent": -1,
+            "mediaPlayed50Percent": -1,
+            "mediaPlayed75Percent": -1,
+            "mediaPlayed100Percent": -1,
+            "uniqueMediaPlayed": 2,
+            "uniqueMediaPlayed25Percent": -1,
+            "uniqueMediaPlayed50Percent": -1,
+            "uniqueMediaPlayed75Percent": -1,
+            "uniqueMediaPlayed100Percent": -1
+        }
+    ],
+    "clicks": [
+        {
+            "seq": 1,
+            "url": "https://example.com/1",
+            "click": -1,
+            "uniqueClick": -1,
+            "uniqueClickOfRequest": -1
+        },
+        {
+            "seq": 1,
+            "url": "https://example.com/2",
+            "click": -1,
+            "uniqueClick": -1,
+            "uniqueClickOfRequest": -1
+        }
+    ]
+}
+EOS
+
 WebMock.allow_net_connect!
 
 describe Line::Bot::Client do
@@ -354,4 +400,57 @@ def generate_client
       ]
     )
   end
+
+  it 'get user interaction statistics' do
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/insight/message/event?requestId=f70dd685-499a-4231-a441-f24b8d4fba21'
+    stub_request(:get, uri_template).to_return(body: USER_INTERACTION_STATISTICS_CONTENT, status: 200)
+
+    client = generate_client
+    response = client.get_user_interaction_statistics('f70dd685-499a-4231-a441-f24b8d4fba21')
+
+    json = JSON.parse(response.body, symbolize_names: true)
+    expect(json).to eq(
+      overview: {
+        requestId: 'f70dd685-499a-4231-a441-f24b8d4fba21',
+        timestamp: 1568214000,
+        delivered: 32,
+        uniqueImpression: 4,
+        uniqueClick: nil,
+        uniqueMediaPlayed: 2,
+        uniqueMediaPlayed100Percent: -1
+      },
+      messages: [
+        {
+          seq: 1,
+          impression: 18,
+          mediaPlayed: 11,
+          mediaPlayed25Percent: -1,
+          mediaPlayed50Percent: -1,
+          mediaPlayed75Percent: -1,
+          mediaPlayed100Percent: -1,
+          uniqueMediaPlayed: 2,
+          uniqueMediaPlayed25Percent: -1,
+          uniqueMediaPlayed50Percent: -1,
+          uniqueMediaPlayed75Percent: -1,
+          uniqueMediaPlayed100Percent: -1
+        }
+      ],
+      clicks: [
+        {
+          seq: 1,
+          url: 'https://example.com/1',
+          click: -1,
+          uniqueClick: -1,
+          uniqueClickOfRequest: -1
+        },
+        {
+          seq: 1,
+          url: 'https://example.com/2',
+          click: -1,
+          uniqueClick: -1,
+          uniqueClickOfRequest: -1
+        }
+      ]
+    )
+  end
 end