Merge pull request #250 from moririnson/feature/user-interaction-statics

#249 Support new Messaging API endpoints for friend statistics added on 10/16

Author: moririnson

src/LINEBot.php

@@ -628,6 +628,22 @@ public function getFriendDemographics()
         return $this->httpClient->get($url);
     }
 
+    /**
+     * Get user interaction statistics
+     *
+     * Returns statistics about how users interact with broadcast messages sent from your LINE official account.
+     * Interactions are tracked for only 14 days after a message was sent.
+     * The statistics are no longer updated after 15 days.
+     *
+     * @param string $requestId Request ID of broadcast message.
+     * @return Response
+     */
+    public function getUserInteractionStatistics($requestId)
+    {
+        $url = $this->endpointBase . '/v2/bot/insight/message/event';
+        return $this->httpClient->get($url, ['requestId' => $requestId]);
+    }
+
     /**
      * Create channel access token
      *

tests/LINEBot/InsightTest.php

@@ -316,4 +316,101 @@ public function testGetFriendDemographics()
         $data = $res->getJSONDecodedBody();
         $this->assertEquals($responseJson, $data);
     }
+    
+    public function testGetUserInteractionStatistics()
+    {
+        $requestId = 'test request id';
+
+        // Test: status is ready
+        $mock = function ($testRunner, $httpMethod, $url, $data) use ($requestId) {
+            /** @var \PHPUnit\Framework\TestCase $testRunner */
+            $testRunner->assertEquals('GET', $httpMethod);
+            $testRunner->assertEquals('https://api.line.me/v2/bot/insight/message/event', $url);
+            $testRunner->assertEquals([
+                'requestId' => $requestId
+            ], $data);
+
+            return [
+                'overview' => [
+                    'requestId' => $requestId,
+                    '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://www.yahoo.co.jp/',
+                        'click' => -1,
+                        'uniqueClick' => -1,
+                        'uniqueClickOfRequest' => -1
+                    ],
+                    [
+                        'seq' => 1,
+                        'url' => 'https://www.google.com/?hl=ja',
+                        'click' => -1,
+                        'uniqueClick' => -1,
+                        'uniqueClickOfRequest' => -1
+                    ],
+                ]
+            ];
+        };
+        $bot = new LINEBot(new DummyHttpClient($this, $mock), ['channelSecret' => 'CHANNEL-SECRET']);
+        $res = $bot->getUserInteractionStatistics($requestId);
+
+        $this->assertEquals(200, $res->getHTTPStatus());
+        $this->assertTrue($res->isSucceeded());
+
+        $data = $res->getJSONDecodedBody();
+        $this->assertEquals($requestId, $data['overview']['requestId']);
+        $this->assertEquals(1568214000, $data['overview']['timestamp']);
+        $this->assertEquals(32, $data['overview']['delivered']);
+        $this->assertEquals(4, $data['overview']['uniqueImpression']);
+        $this->assertEquals(null, $data['overview']['uniqueClick']);
+        $this->assertEquals(2, $data['overview']['uniqueMediaPlayed']);
+        $this->assertEquals(-1, $data['overview']['uniqueMediaPlayed100Percent']);
+        $this->assertEquals(1, count($data['messages']));
+        $this->assertEquals(1, $data['messages'][0]['seq']);
+        $this->assertEquals(18, $data['messages'][0]['impression']);
+        $this->assertEquals(11, $data['messages'][0]['mediaPlayed']);
+        $this->assertEquals(-1, $data['messages'][0]['mediaPlayed25Percent']);
+        $this->assertEquals(-1, $data['messages'][0]['mediaPlayed50Percent']);
+        $this->assertEquals(-1, $data['messages'][0]['mediaPlayed75Percent']);
+        $this->assertEquals(-1, $data['messages'][0]['mediaPlayed100Percent']);
+        $this->assertEquals(2, $data['messages'][0]['uniqueMediaPlayed']);
+        $this->assertEquals(-1, $data['messages'][0]['uniqueMediaPlayed25Percent']);
+        $this->assertEquals(-1, $data['messages'][0]['uniqueMediaPlayed50Percent']);
+        $this->assertEquals(-1, $data['messages'][0]['uniqueMediaPlayed75Percent']);
+        $this->assertEquals(-1, $data['messages'][0]['uniqueMediaPlayed100Percent']);
+        $this->assertEquals(2, count($data['clicks']));
+        $this->assertEquals(1, $data['clicks'][0]['seq']);
+        $this->assertEquals('https://www.yahoo.co.jp/', $data['clicks'][0]['url']);
+        $this->assertEquals(-1, $data['clicks'][0]['click']);
+        $this->assertEquals(-1, $data['clicks'][0]['uniqueClick']);
+        $this->assertEquals(-1, $data['clicks'][0]['uniqueClickOfRequest']);
+        $this->assertEquals(1, $data['clicks'][1]['seq']);
+        $this->assertEquals('https://www.google.com/?hl=ja', $data['clicks'][1]['url']);
+        $this->assertEquals(-1, $data['clicks'][1]['click']);
+        $this->assertEquals(-1, $data['clicks'][1]['uniqueClick']);
+        $this->assertEquals(-1, $data['clicks'][1]['uniqueClickOfRequest']);
+    }
 }