菜单

PHP SDK

概述

Gravity Engine PHP SDK 是一个用于数据采集和上报的工具，帮助开发者轻松集成事件追踪和用户行为分析功能。在接入前, 请先阅读接入前准备。

服务端接入PHP SDK，完成事件的服务端报送功能，您需要注意以下几点：

服务端SDK仅负责事件的收集上报，不负责用户的注册，用户注册需要调用客户端 SDK 的 initialize 方法完成；
客户端和服务端SDK使用的用户 client id 需要保持一致；
在客户端完成 initialize 方法调用之后，服务端SDK才能开始做事件采集上报，否则上报不成功；
服务端SDK接入事件上报时，请参考元事件页面下关于事件的详情属性；
请尽量上报事件的公共属性，引力不做强制要求，但是上报足够多属性，可以方便您后续在引力平台使用数据分析功能（ $city、 $province 、 $country 、 $browser 、 $browser_version 属性可以不上报，引力后端会自动采集）；
关于属性的更多信息，请您参考事件属性页面。

1. 环境要求

PHP版本：8.5.1+

2. 安装集成

下载SDK：下载地址

require "GEPhpSdk.php";

3. 初始化配置

基础配置

<?php

namespace GESDKDemo;
require "GEPhpSdk.php";


use Exception;
use GEData\GELog;
use GEData\GEAnalytics;
use GEData\GEDebugConsumer;
use GEData\GEBatchConsumer;
use GEData\GEDataException;


const SERVER_URL = 'https://backend.gravity-engine.com/event_center/api/v1/event/collect/?access_token=__XXX__';


/**
 * report data by http
 * @return GEAnalytics|null
 */
function get_batch_sdk()
{
    GELog::$enable = true;
    $batchConsumer = new GEBatchConsumer(SERVER_URL,);
    return new GEAnalytics($batchConsumer);
}

/**
 * @return GEAnalytics|null
 */
function get_debug_sdk()
{
    try {
        GELog::$enable = true;
        $debugConsumer = new GEDebugConsumer(SERVER_URL, 1000,);
        return new GEAnalytics($debugConsumer, true);
    } catch (GEDataException $e) {
        echo $e;
        return null;
    }
}

$geSDK = get_debug_sdk();
//$geSDK = get_batch_sdk();

核心功能

1. 事件追踪

如需上报自定义事件，您必须先在元事件中添加，否则会上报失败！

您可以调用 track 方法，记录用户自定义事件。

您需要先在元事件中添加自定义事件，然后调用 track 方法上报自定义事件。

$client_id = '_test_client_id_0';


try {
    for ($i = 0; $i < 100; $i++) {
        $properties = array();
        $properties['idx'] = $i;
        $properties['age'] = 20;
        $properties['Product_Name'] = 'c';
        $properties['update_time'] = date('Y-m-d H:i:s', time());
        $json = array();
        $json['a'] = "a";
        $json['b'] = "b";
        $jsonArray = array();
        $jsonArray[0] = $json;
        $jsonArray[1] = $json;
        $properties['json'] = $json;
        $properties['jsonArray'] = $jsonArray;
        $eventName = '$AdClick';
        $geSDK->track($client_id, $eventName, $properties);
    }

} catch (Exception $e) {
    echo $e;
}

事件的名称是字符串类型，为字符串类型。
Key 为该属性的名称，为字符串类型。
Value 为该属性的值，支持字符串、数字、布尔、时间、对象、对象组、数组

2. 用户属性管理

设置用户属性（覆盖）

对于一般的用户属性，您可以调用来user_set进行设置，使用该接口上传的属性将会覆盖原有的属性值，如果之前不存在该用户属性，则会新建该用户属性。

try {
    $properties = array();
    $properties['user_name'] = 'xxx';
    $geSDK->user_set($client_id, $properties);
} catch (Exception $e) {
    //handle except
    echo $e;
}

初始化用户属性（仅首次设置有效）

对于只在首次设置时有效的属性，我们可以使用 user_set_once记录这些属性。与 user_set方法不同的是，如果被设置的用户属性已存在，则这条记录会被忽略而不会覆盖已有数据，如果属性不存在则会自动创建。因此，user_set_once适用于为用户设置首次激活时间、首次注册时间等属性。

try {
    $properties = array();
    $properties['prop_set_once'] = "once";
    $geSDK->user_set_once($client_id, $properties);
} catch (Exception $e) {
    //handle except
    echo $e;
}

累加用户属性

对于数值型的用户属性，可以使用 user_increment对属性值进行累加。常用于记录用户付费次数、付费额度、积分等属性。

try {
    $properties = array();
    $properties['TotalRevenue'] = 100;
    $geSDK->user_increment($client_id, $properties);
} catch (Exception $e) {
    //handle except
    echo $e;
}

用户属性取最大值

对于数值型的用户属性，可以使用 user_max用来比较数值大小，保存较大的，如果没有这个 key，则新增 key，value 取本次的值。

try {
    $properties = array();
    $properties['TotalRevenue'] = 1000;
    $geSDK->user_max($client_id, $properties);
} catch (Exception $e) {
    //handle except
    echo $e;
}

用户属性取最小值

对于数值型的用户属性，可以使用 user_min用来比较数值大小，保存较小的，如果没有这个 key，则新增 key，value 取本次的值。

try {
    $properties = array();
    $properties['TotalRevenue'] = 1;
    $geSDK->user_min($client_id, $properties);
} catch (Exception $e) {
    //handle except
    echo $e;
}

用户属性追加

对用户喜爱的电影、用户点评过的餐厅等属性，可以调用 user_append记录列表型属性。

try {
    $properties = array();
    $properties['prop_list_type'] = ['a', 'a', 'b'];
    $geSDK->user_append($client_id, $properties);
} catch (Exception $e) {
    //handle except
    echo $e;
}

用户属性去重追加

调用 user_uniq_append用来对 Array 类型的用户数据去重追加元素。

try {
    $properties = array();
    $properties['prop_list_type'] = ['a', 'a', 'b', 'c'];
    $geSDK->user_uniq_append($client_id, $properties);
} catch (Exception $e) {
    //handle except
    echo $e;
}

重置用户属性

如果需要重置已设置的某个用户属性，可以调用 user_unset进行重置。

try {
    $properties = array();
    $properties['user_name'] = '';
    $geSDK->user_unset($client_id, $properties);
} catch (Exception $e) {
    //handle except
    echo $e;
}

清空用户属性

调用 user_del方法，将把当前用户属性清空，您将无法再查询该名用户的用户属性，但该用户产生的事件仍然可以被查询到。

try {
    $geSDK->user_del($client_id);
} catch (Exception $e) {
    //handle except
    echo $e;
}

3. 数据管理

立即上报数据

$geSDK->flush();

注意: 频繁调用 flush() 会影响性能，建议在重要操作后调用。

关闭 SDK

try {
    $geSDK->close();
} catch (Exception $e) {
    echo 'error' . PHP_EOL;
}

在应用关闭前调用，确保缓存数据不会丢失。

完整示例

<?php
namespace GESDKDemo;
require "GEPhpSdk.php";


use Exception;
use GEData\GELog;
use GEData\GEAnalytics;
use GEData\GEDebugConsumer;
use GEData\GEBatchConsumer;
use GEData\GEDataException;


const SERVER_URL = 'https://backend.gravity-engine.com/event_center/api/v1/event/collect/?access_token=__XXX__';


/**
 * report data by http
 * @return GEAnalytics|null
 */
function get_batch_sdk()
{
    GELog::$enable = true;
    $batchConsumer = new GEBatchConsumer(SERVER_URL,);
    return new GEAnalytics($batchConsumer);
}

/**
 * @return GEAnalytics|null
 */
function get_debug_sdk()
{
    try {
        GELog::$enable = true;
        $debugConsumer = new GEDebugConsumer(SERVER_URL, 1000,);
        return new GEAnalytics($debugConsumer, true);
    } catch (GEDataException $e) {
        echo $e;
        return null;
    }
}

$geSDK = get_debug_sdk();
//$geSDK = get_batch_sdk();


$client_id = '_test_client_id_0';


try {
    for ($i = 0; $i < 100; $i++) {
        $properties = array();
        $properties['idx'] = $i;
        $properties['age'] = 20;
        $properties['Product_Name'] = 'c';
        $properties['update_time'] = date('Y-m-d H:i:s', time());
        $json = array();
        $json['a'] = "a";
        $json['b'] = "b";
        $jsonArray = array();
        $jsonArray[0] = $json;
        $jsonArray[1] = $json;
        $properties['json'] = $json;
        $properties['jsonArray'] = $jsonArray;
        $eventName = '$AdClick';
        $geSDK->track($client_id, $eventName, $properties);
    }

} catch (Exception $e) {
    echo $e;
}


try {
    $properties = array();
    $properties['prop_set_once'] = "once";
    $geSDK->user_set_once($client_id, $properties);
} catch (Exception $e) {
    //handle except
    echo $e;
}


try {
    $properties = array();
    $properties['user_name'] = 'xxx';
    $geSDK->user_set($client_id, $properties);
} catch (Exception $e) {
    //handle except
    echo $e;
}


try {
    $properties = array();
    $properties['user_name'] = '';
    $geSDK->user_unset($client_id, $properties);
} catch (Exception $e) {
    //handle except
    echo $e;
}

try {
    $properties = array();
    $properties['prop_list_type'] = ['a', 'a', 'b'];
    $geSDK->user_append($client_id, $properties);
} catch (Exception $e) {
    //handle except
    echo $e;
}


try {
    $properties = array();
    $properties['prop_list_type'] = ['a', 'a', 'b', 'c'];
    $geSDK->user_uniq_append($client_id, $properties);
} catch (Exception $e) {
    //handle except
    echo $e;
}


try {
    $properties = array();
    $properties['TotalRevenue'] = 100;
    $geSDK->user_increment($client_id, $properties);
} catch (Exception $e) {
    //handle except
    echo $e;
}

try {
    $properties = array();
    $properties['TotalRevenue'] = 1000;
    $geSDK->user_max($client_id, $properties);
} catch (Exception $e) {
    //handle except
    echo $e;
}

try {
    $properties = array();
    $properties['TotalRevenue'] = 1;
    $geSDK->user_min($client_id, $properties);
} catch (Exception $e) {
    //handle except
    echo $e;
}


try {
    $geSDK->user_del($client_id);
} catch (Exception $e) {
    //handle except
    echo $e;
}


$geSDK->flush();

try {
    $geSDK->close();
} catch (Exception $e) {
    echo 'error' . PHP_EOL;
}

最佳实践

异常处理: 对所有SDK调用进行异常捕获
资源清理: 在应用关闭前调用 close()方法
属性命名: 使用有意义的属性名称，保持一致性
数据类型: 确保属性值类型符合预期，避免类型错误

故障排除

常见问题

初始化问题: 检查 ACCESS_TOKEN 和服务器地址是否正确
数据格式: 验证事件属性数据类型是否符合要求
性能问题: 避免频繁调用 flush() 方法

上一个

GO SDK

下一个

小游戏Token接入

最近修改: 2026-01-15Powered by