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 イベントを正の値以外でインクリメントしようとしました。