Events: record

このアプリケーションの現在認証されているユーザーに対して、イベントが発生した回数の変更バッチを記録します。実習をご覧ください。

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名 説明
省略可能なクエリ パラメータ
language string このメソッドから返される文字列に使用する言語。

承認

このリクエストには、次のスコープによる認証が必要です。

範囲
https://www.googleapis.com/auth/games

詳細については、認証と承認のページをご覧ください。

リクエスト本文

リクエストの本文には、以下の構造を使用してデータを指定してください。

{
  "kind": "games#eventRecordRequest",
  "requestId": long,
  "currentTimeMillis": long,
  "timePeriods": [
    {
      "kind": "games#eventPeriodUpdate",
      "timePeriod": {
        "kind": "games#eventPeriodRange",
        "periodStartMillis": long,
        "periodEndMillis": long
      },
      "updates": [
        {
          "kind": "games#eventUpdateRequest",
          "definitionId": string,
          "updateCount": long
        }
      ]
    }
  ]
}
プロパティ名 説明 備考
kind string このリソースの種類を一意に識別します。値は常に固定文字列の games#eventRecordRequest です。
requestId long イベントの記録の試行を識別するために使用されるリクエスト ID。
currentTimeMillis long この更新が送信された現在の時刻(1970 UTC(Unix エポック)からのミリ秒数)。
timePeriods[] list このリクエストで行われた期間の更新のリスト。
timePeriods[].kind string このリソースの種類を一意に識別します。値は常に固定文字列の games#eventPeriodUpdate です。
timePeriods[].timePeriod nested object この更新の対象となる期間です。
timePeriods[].timePeriod.kind string このリソースの種類を一意に識別します。値は常に固定文字列の games#eventPeriodRange です。
timePeriods[].timePeriod.periodStartMillis long 1970 年の UTC(Unix エポック)からのこの更新期間の開始時間(ミリ秒単位)。
timePeriods[].timePeriod.periodEndMillis long 1970 年の UTC(Unix エポック)からのこの更新期間の終了時間(ミリ秒単位)。
timePeriods[].updates[] list この期間の更新。
timePeriods[].updates[].kind string このリソースの種類を一意に識別します。値は常に固定文字列の games#eventUpdateRequest です。
timePeriods[].updates[].definitionId string この更新で変更されるイベントの ID。
timePeriods[].updates[].updateCount long この期間にこのイベントが発生した回数。 書き込み可能

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "kind": "games#eventUpdateResponse",
  "batchFailures": [
    {
      "kind": "games#eventBatchRecordFailure",
      "range": {
        "kind": "games#eventPeriodRange",
        "periodStartMillis": long,
        "periodEndMillis": long
      },
      "failureCause": string
    }
  ],
  "eventFailures": [
    {
      "kind": "games#eventRecordFailure",
      "eventId": string,
      "failureCause": string
    }
  ],
  "playerEvents": [
    {
      "kind": "games#playerEvent",
      "definitionId": string,
      "playerId": string,
      "numEvents": long,
      "formattedNumEvents": string
    }
  ]
}
プロパティ名 説明 備考
kind string このリソースの種類を一意に識別します。値は常に固定文字列の games#eventUpdateResponse です。
batchFailures[] list アップデートの適用中に発生したバッチ全体のエラー。
batchFailures[].kind string このリソースの種類を一意に識別します。値は常に固定文字列の games#eventBatchRecordFailure です。
batchFailures[].range nested object 拒否された期間です。リクエスト全体の失敗した場合は空になります。
batchFailures[].range.kind string このリソースの種類を一意に識別します。値は常に固定文字列の games#eventPeriodRange です。
batchFailures[].range.periodStartMillis long 1970 年の UTC(Unix エポック)からのこの更新期間の開始時間(ミリ秒単位)。
batchFailures[].range.periodEndMillis long 1970 年の UTC(Unix エポック)からのこの更新期間の終了時間(ミリ秒単位)。
batchFailures[].failureCause string 更新に失敗した原因。
有効な値は次のとおりです。
  • TOO_LARGE」: バッチ リクエストが発行されたイベントの数が、1 つのバッチで許可された数を超えています。
  • TIME_PERIOD_EXPIRED」: 過去に送信されているデータが記録されているため、記録できません。
  • "TIME_PERIOD_SHORT": バッチが送信された時間範囲が短すぎます。
  • "TIME_PERIOD_LONG": バッチが長すぎる期間で送信されました。
  • ALREADY_UPDATED」: すでに確認されたデータのバッチを試行しようとしました。
  • RECORD_RATE_HIGH」: サーバーが更新を適用するよりも早くデータを録画しようとしました。


有効な値は次のとおりです。
  • "ALREADY_UPDATED"
  • RECORD_RATE_HIGH
  • TIME_PERIOD_EXPIRED
  • TIME_PERIOD_LONG
  • TIME_PERIOD_SHORT
  • TOO_LARGE
eventFailures[] list 特定のイベントの更新が失敗する。
eventFailures[].kind string このリソースの種類を一意に識別します。値は常に固定文字列の games#eventRecordFailure です。
eventFailures[].eventId string 更新されなかったイベントの ID。
eventFailures[].failureCause string 更新に失敗した原因。
有効な値は次のとおりです。
  • NOT_FOUND」- 定義されていないイベントを設定しようとしました。
  • "INVALID_UPDATE_VALUE" - イベントを正でない値でインクリメントしようとしました。


有効な値は次のとおりです。
  • "INVALID_UPDATE_VALUE"
  • NOT_FOUND
playerEvents[] list 更新されたイベントの現在のステータス
playerEvents[].kind string このリソースの種類を一意に識別します。値は常に固定文字列の games#playerEvent です。
playerEvents[].definitionId string イベント定義の ID。
playerEvents[].playerId string プレーヤーの ID。
playerEvents[].numEvents long このイベントが発生した現在の回数。
playerEvents[].formattedNumEvents string イベントが発生した現在の回数(文字列)。この文字列の形式は、Google Play ゲーム デベロッパー コンソールでのイベントの設定によって異なります。

実習

以下の API Explorer を使用して、ライブデータでこのメソッドを呼び出し、レスポンスを確認します。