Android 游戏中的事件

本指南将向您展示如何使用 Google Play 游戏服务提供的事件 API 收集玩家游戏数据以进行游戏分析。这些 API 可以在 com.google.android.gms.games.event 和 com.google.android.gms.games 中找到。

开始之前

如果您尚未执行此操作，您可能会发现查看 事件游戏概念 很有帮助。

在开始使用事件 API 编写代码之前

获取事件客户端

要开始使用事件 API，您的游戏必须首先获取 EventsClient 对象。您可以通过调用 Games.getEventsClient() 方法并传入活动和当前玩家的 GoogleSignInAccount 来实现。要了解如何检索玩家帐户信息，请参阅 Android 游戏中的登录。

提交事件

您可以在游戏中添加代码，以便在游戏发生您感兴趣的事件时通知 Google Play 游戏服务。

要发送事件更新，请使用 eventId 值和等于或大于 0 的整数 incrementAmount 调用 EventsClient.increment()。

  • 当您首次在 Google Play Console 中定义事件时，eventId 由 Google Play 游戏服务生成，用于在游戏中唯一标识此事件。
  • 您可以使用 incrementAmount 输入指定玩家完成某些特定游戏目标的定量进度。例如，如果您的游戏想要跟踪的事件是“击败 500 个独眼怪物”，则 incrementAmount 值可以是玩家在一场战斗中杀死的怪物数量。

以下是如何提交增量值为 1 的事件的示例

public void submitEvent(String eventId) {
  Games.getEventsClient(this, GoogleSignIn.getLastSignedInAccount(this))
      .increment(eventId, 1);
}

检索事件

您可以通过调用 EventsClient.load() 检索存储在 Google 服务器中与您的游戏相关的所有事件数据。在方法调用中，传入一个布尔值以指示 Google Play 游戏服务是否应清除用户设备上的本地缓存数据。

要检索您在 Google Play Console 中定义的特定事件的数据，请调用 EventsClient.loadByIds() 并将事件 ID 数组作为输入参数传入。

以下代码段显示了如何查询 Google Play 游戏服务以获取游戏的所有事件列表

public void loadEvents() {
  Games.getEventsClient(this, GoogleSignIn.getLastSignedInAccount(this))
      .load(true)
      .addOnCompleteListener(new OnCompleteListener<AnnotatedData<EventBuffer>>() {
        @Override
        public void onComplete(@NonNull Task<AnnotatedData<EventBuffer>> task) {
          if (task.isSuccessful()) {
            // Process all the events.
            for (Event event : task.getResult().get()) {
              Log.d(TAG, "loaded event " + event.getName());
            }
          } else {
            // Handle Error
            Exception exception = task.getException();
            int statusCode = CommonStatusCodes.DEVELOPER_ERROR;
            if (exception instanceof ApiException) {
              ApiException apiException = (ApiException) exception;
              statusCode = apiException.getStatusCode();
            }
            showError(statusCode);
          }
        }
      });
}