iugosds/sherlaravel

为Laravel项目集成的Sherlock Score评分

维护者

详细信息

github.com/iugosds/sherlaravel

主页

源代码

问题

安装: 932

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 0

开放问题: 0

0.1 2020-02-12 21:29 UTC

Requires

Requires (Dev)

MIT e999f47e84af5432d4042f1090775bd255be1328

laravelSherLaravel

This package is auto-updated.

Last update: 2024-09-27 04:30:02 UTC

README

Latest Version on Packagist Total Downloads

Sherlock Score的Laravel集成。

使用Sherlock的Product Engagement Scoring引擎跟踪您的用户、试用和付费账户。

安装

通过Composer

$ composer require iugosds/sherlaravel

使用方法

首先，将SHERLOCK_SCORE_API_KEY键添加到您的.env文件中

SHERLOCK_SCORE_API_KEY=a12b34c56...

您还可以通过添加SHERLOCK_SCORE_ENABLED键并设置为false（默认为true）来禁用此包。

如果您不想等待API响应，可以将所有与Sherlock Score的交互作为异步调用运行（作业将被调度到您的laravel应用程序的"默认"队列）。要启用此功能，请在.env文件中将SHERLOCK_ASYNC_CALLS变量设置为true。

要开始与Sherlock Score交互，请使用以下方法

use SherLaravel;
SherLaravel::identifyAccount("groupIdHere");

使用Sherlock可以跟踪账户（或用户组）。要识别新账户，请将上面的行添加到您的控制器中。

SherLaravel::identifyUser("userIdHere");

identifyUser方法用于识别新用户。它通常添加到登录控制器的register方法，或者如果使用观察者，则添加到用户模型的"created"事件。

SherLaravel::trackEvent("userID", "event-name");

在控制器中，每次想要跟踪与用户的交互时，请使用trackEvent方法。

SherLaravel::identifyAccount(String $group_id, ?Array $traits= [], ?int $timestamp = null)
SherLaravel::identifyUser(String $user_id, ?String $group_id = null, ?Array $traits= [], ?int $timestamp = null)
SherLaravel::trackEvent(String $user_id, String $event, ?int $timestamp = null)

##示例

SherLaravel::identifyUser("1234", "Customer44", [
        'name' => 'John Doe',
        'email' => 'johndoe@example.com'],
    '1553647710707');

变更日志

请参阅变更日志以获取有关最近更改的更多信息。

贡献

请参阅contributing.md以获取详细信息及待办事项清单。

致谢

许可证

MIT。有关更多信息，请参阅许可证文件。