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 エポック)からのミリ秒単位)。

periodEndMillis

string (int64 format)

この更新期間が終了する時刻(1970 UTC(Unix エポック)からのミリ秒数)。

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 1 つのバッチで許可されるイベント数を超えるイベントを含むバッチ リクエストが発行されました。
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 正の値以外の値でイベントをインクリメントしようとした。