Method: events.record

記錄此應用程式目前已通過驗證的使用者事件發生次數的批次變更。

HTTP 要求

POST https://games.googleapis.com/games/v1/events

查詢參數

參數
language

string

此方法傳回字串的偏好語言。

要求主體

要求主體包含 EventsUpdates 的例項。

回應主體

更新事件期間的資源。

如果成功,回應主體會含有以下結構的資料:

JSON 表示法
{
  "kind": string,
  "batchFailures": [
    {
      object (EventBatchRecordFailure)
    }
  ],
  "eventFailures": [
    {
      object (EventRecordFailure)
    }
  ],
  "playerEvents": [
    {
      object (PlayerEvent)
    }
  ]
}
欄位
kind

string

專門用於識別這項資源的類型。值一律為固定字串 games#eventUpdateResponse

batchFailures[]

object (EventBatchRecordFailure)

套用更新時發生的所有批次作業失敗。

eventFailures[]

object (EventRecordFailure)

更新特定事件時失敗。

playerEvents[]

object (PlayerEvent)

任何更新事件的目前狀態

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/games
  • https://www.googleapis.com/auth/games_lite

詳情請參閱 OAuth 2.0 總覽

EventsUpdates

更新事件期間的資源。

JSON 表示法
{
  "kind": string,
  "requestId": string,
  "currentTimeMillis": string,
  "timePeriods": [
    {
      object (EventPeriodUpdate)
    }
  ]
}
欄位
kind

string

專門用於識別這項資源的類型。值一律為固定字串 games#eventRecordRequest

requestId

string (int64 format)

用來識別這次嘗試記錄事件的要求 ID。

currentTimeMillis

string (int64 format)

本次更新的傳送時間 (以毫秒為單位),自 1970 年 UTC (Unix 紀元時間) 起計算。

timePeriods[]

object (EventPeriodUpdate)

此要求所執行更新的時間範圍清單。

EventPeriodUpdate

更新事件期間的資源。

JSON 表示法
{
  "timePeriod": {
    object (EventPeriodRange)
  },
  "updates": [
    {
      object (EventUpdateRequest)
    }
  ],
  "kind": string
}
欄位
timePeriod

object (EventPeriodRange)

本次更新涵蓋的時間範圍。

updates[]

object (EventUpdateRequest)

這段期間的更新。

kind

string

專門用於識別這項資源的類型。值一律為固定字串 games#eventPeriodUpdate

EventPeriodRange

事件時間範圍。

JSON 表示法
{
  "kind": string,
  "periodStartMillis": string,
  "periodEndMillis": string
}
欄位
kind

string

專門用於識別這項資源的類型。值一律為固定字串 games#eventPeriodRange

periodStartMillis

string (int64 format)

這個更新週期的開始時間,以毫秒為單位,自 1970 年 UTC (Unix Epoch 時區) 起開始計算。

periodEndMillis

string (int64 format)

此更新期結束的時間,以毫秒為單位,自 1970 年 UTC (Unix Epoch 時間) 起計算。

EventUpdateRequest

更新事件期間的資源。

JSON 表示法
{
  "definitionId": string,
  "updateCount": string,
  "kind": string
}
欄位
definitionId

string

本次更新中修改的事件 ID。

updateCount

string (int64 format)

此事件在這段時間內發生的次數。

kind

string

專門用於識別這項資源的類型。值一律為固定字串 games#eventUpdateRequest

EventBatchRecordFailure

批次更新失敗資源。

JSON 表示法
{
  "range": {
    object (EventPeriodRange)
  },
  "failureCause": enum (EventFailureCause),
  "kind": string
}
欄位
range

object (EventPeriodRange)

遭拒的時間範圍;空白則代表要求整體失敗。

failureCause

enum (EventFailureCause)

更新失敗的原因。

kind

string

專門用於識別這項資源的類型。值一律為固定字串 games#eventBatchRecordFailure

EventFailureCause

事件失敗原因可能的值,

列舉
TOO_LARGE 進行批次要求時,發生的事件數量超過單一批次允許的數量。
TIME_PERIOD_EXPIRED 傳送批次時,資料收到的時間距離現在太久,因此無法記錄。
TIME_PERIOD_SHORT 批次傳送的日期範圍太短。
TIME_PERIOD_LONG 批次傳送的時間範圍過長。
ALREADY_UPDATED 嘗試記錄一批已看過的資料。
RECORD_RATE_HIGH 嘗試記錄資料的速度比伺服器套用更新的速度更快。

EventRecordFailure

更新活動失敗的資源。

JSON 表示法
{
  "eventId": string,
  "failureCause": enum (EventUpdateFailureCause),
  "kind": string
}
欄位
eventId

string

未更新事件的 ID。

failureCause

enum (EventUpdateFailureCause)

更新失敗的原因。

kind

string

專門用於識別這項資源的類型。值一律為固定字串 games#eventRecordFailure

EventUpdateFailureCause

造成事件更新失敗的可能原因。

列舉
NOT_FOUND 嘗試設定的事件尚未定義。
INVALID_UPDATE_VALUE 嘗試以非正值來遞增事件。