使用Amazon Pinpoint对用户行为追踪

1.前言

---

最近在做一个项目，我们的后台大数据团队需要了解用户在使用app的时候，都进行了哪些操作，在哪个页面都干了些什么，以及app日活和月活等等，各种数据。总之就是监控用户行为，说好听一点就是发送反馈数据，提升用户体验。

用时下流行的叫法就是：

高情商：提升用户体验

低情商：监控用户一举一动

 ​​​

不要骂我，任何一个市面上的app都会这么干，抖音、微信、微博、QQ、支付婊、淘宝、京东等等，有一个算一个，一个都别想跑。

所以我们也为了更好地提升用户体验，当然也需要在代码里面加一点点东西咯。

做data tracking的平台很多，亚马逊、微软、谷歌、腾讯、阿里、字节、可能每家都有自己定制的一套服务，我们采用的是亚马逊的PinPoint技术，没有为什么，后台选的。

由于AWS的文档真的是乱成狗，导致我们在最基本的初始化sdk，都花了一个星期，可见官方文档有多差，包名管理混乱，连基本的示例代码都没有，文档是N年以前的，点击去各种跳转，到最后发现全都不能用。不过相比于.net平台，aws在安卓、苹果、web方便，可谓是下足了功夫，示例代码，配置截图，真的就差帮写实际项目集成代码了。所以在折腾了一个星期后，我们终于跑通了所有流程，仅以此文档记录一下踩过的坑，也让以后想“提升用户体验”的同行少走弯路。

2. PinPoint功能介绍

---

客户希望与他们喜爱的企业和品牌保持联系。他们通过各种线上和线下渠道忠实地关注最新的产品、新闻和促销活动。但客户越来越希望接收主动的相关数字通信。Amazon Pinpoint 是一项灵活且可扩展的出站和入站营销传播服务。

①通信渠道

Amazon Pinpoint 通过电子邮件、语音、推送通知和 SMS 渠道实现送达和规模，从而覆盖全球数亿客户。

②营销消息

使用 Amazon Pinpoint 在合适的时间向合适的人发送合适的信息，从而实现推广营销传播。

③事务性消息

事务性消息是指发送给特定接收者的按需消息。您可以使用 Amazon Pinpoint API 和 AWS 软件开发工具包，通过电子邮件、推送、SMS 或语音发送事务性消息。您也可以通过编程方式根据 Web 或移动应用程序中的客户活动触发事务性消息。

④分析

使用 Amazon Pinpoint 提供的分析可以通过查看与用户参与度、活动延伸范围、收入等相关的趋势，深入了解用户群。

在用户与您的项目交互时，Amazon Pinpoint 收集并存储这些交互的分析数据。您可以查看这些数据，以便了解用户参与度、购买活动以及人数统计等方面的信息。例如，如果您有一个移动应用程序，您可以查看显示每天打开您应用程序的用户数、用户打开您应用程序的时间以及您应用程序产生的收入的图表和指标。

其实我们为了提升用户体验，也就是用了PinPoint的分析功能。

3. PinPoint源码

---

实际上PinPoint只是AWS的一个很小部分而已， AWS一整套SDK包含了上百个服务，详见下图。

有兴趣的可以自己去看源代码：https://github.com/aws/aws-sdk-net

4. 下载PinPoint包

---

Nuget搜索awssdk.pinpoint，这个包几乎每天一更，而且都是稳定版，所以使用最新版即可。

或者使用命令行

Install-Package AWSSDK.Pinpoint -Version 3.7.1.4

除了PinPoint，我们还需要下载一个单独的AWSSDK.CognitoIdentity包，这个是专门管理授权的。

一开始我查了很久，以为是AWSSDK提供的，因为他里面也包含一个相同的AWSSDK.CognitoIdentity，但是却不能授权。而且这个包还是2016年的，。。。

 ​​​ ​​​ ​​​

5. 初始化PinPoint

---

PinPoint初始化一般通过AWSCredentials这个参数，而AWSCredentials初始化则需要通过刚才提到的包AWSSDK.CognitoIdentity里面的CognitoAWSCredentials，找后端要PoolId和Region

两个都明白了之后，就很简单了

CognitoAWSCredentials credentials = new CognitoAWSCredentials(poolId, RegionEndpoint.USEast1);
var pinpoint = new AmazonPinpointClient(credentials, RegionEndpoint.USEast1);

6. 发送PinPoint追踪事件

---

发送这个事件也是研究了很久，因为.net下的封装只能说是半成品，而安卓ios下的封装已经太完善了，只需要简单的调用PutEvents即可。

而我们还需要从最基本的做起，只能说还要啥自行车，能用都不错了。 ​​​ ​​​ ​​​

从EndpointDemographic、PublicEndpoint、Event、EventsBatch、EventsRequest、PutEventsRequest层层传递，

经过九九八十一难，才能取得真经————pinpoint.PutEventsAsync(putEventsRequest);

            try
            {
                CognitoAWSCredentials credentials = new CognitoAWSCredentials(poolId, RegionEndpoint.USEast1);
                var pinpoint = new AmazonPinpointClient(credentials, RegionEndpoint.USEast1);

                EndpointDemographic endpointDemographic = new EndpointDemographic
                {
                    AppVersion = "1.0.0",
                    Locale = "zh-hk",
                    Make = "xxx",
                    Model = "xxx",
                    ModelVersion = "19042",
                    Platform = "pc",
                    PlatformVersion = "19042",
                };

                PublicEndpoint publicEndpoint = new PublicEndpoint
                {
                    ChannelType = ChannelType.CUSTOM,
                    Demographic = endpointDemographic,
                    //More
                };

                //Maximum number of attribute keys and metric keys for each event ------ 40 per request
                Dictionary<string, string> attribute = new Dictionary<string, string>
                {
                    {"field1", "xxx" },
                    {"field2", "xxx" },
                    {"field3", "xxx" },
                    {"field4", "xxx" },
                    {"field5", "xxx" },
                    //More
                };

                var current = Package.Current;
                Event @event = new Event
                {
                    Attributes = attribute,
                    EventType = "xxx",
                    AppPackageName = Package.Current.Id.Name,
                    AppTitle = Package.Current.DisplayName,
                    AppVersionCode = "10000",
                    SdkName = GetAWSSDKName(pinpoint.Config.UserAgent),
                    ClientSdkVersion = GetAWSSDKVersion(pinpoint.Config.UserAgent),
                    Timestamp = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss")
                };
                Dictionary<string, Event> events = new Dictionary<string, Event>();
                events.Add("Events", @event);

                EventsBatch eventsBatch = new EventsBatch
                {
                    Endpoint = publicEndpoint,
                    Events = events
                };

                Dictionary<string, EventsBatch> batchItem = new Dictionary<string, EventsBatch>();
                batchItem.Add(installId.ToString(), eventsBatch);

                EventsRequest eventsRequest = new EventsRequest
                {
                    BatchItem = batchItem
                };

                PutEventsRequest putEventsRequest = new PutEventsRequest
                {
                    ApplicationId = appId,
                    EventsRequest = eventsRequest
                };

                var res = await pinpoint.PutEventsAsync(putEventsRequest);
                if(res != null)
                {
                    Debug.WriteLine("PinPoint.PutEventsAsync: " + DateTime.UtcNow);
                    Debug.WriteLine("EndpointItemResponse: "
                        + res?.EventsResponse?.Results[installId.ToString()]?.EndpointItemResponse.StatusCode
                        + res?.EventsResponse?.Results[installId.ToString()]?.EndpointItemResponse.Message);
                    Debug.WriteLine("EndpointItemResponse: "
                        + res?.EventsResponse?.Results[installId.ToString()]?.EventsItemResponse["Events"].StatusCode
                        + res?.EventsResponse?.Results[installId.ToString()]?.EventsItemResponse["Events"].Message);
                }
            }
            catch (AmazonPinpointException ex)
            {

            }
            catch(Exception ex)
            {

            }    

注意我们在控制台输出的调试信息，当成功发送事件后，服务器会返回202Accepted，表示服务器已经接受我们的请求，并且正在处理。稍等几分钟即可看到数据。

下面是后台看到的数据分析控制台。

7. 总结

---

关于.net平台下PinPoint的文章，我搜遍了全网，没有看到过一篇，所以决定写下来，给自己做个记录，也方便以后用到PinPoint的同行，不要再浪费时间在这没用的基本研究了，没有任何意义。

但是PinPoint确实是一个非常强大的“提升用户体验”的好工具，希望AWS能将我这篇文章收录，作为一个指引。最起码我觉得比官方的文档绕来绕去还将不明白好多了。

后续我会翻译一下成英文版，方便老外看懂。