特定のプレーヤーのゲーム イベントのバッチを記録します。このメソッドを使用すると、1 つのリクエストで複数のイベントを送信できます。
HTTP リクエスト
POST https://games.googleapis.com/games/v1/players/{playerId}/gameStats:batchRecordEvents
パスパラメータ
| パラメータ | |
|---|---|
playerId |
必須。イベントを実行したプレーヤーのプレーヤー ID。 |
リクエストの本文
リクエストの本文には、次の構造のデータが含まれます。
| JSON 表現 |
|---|
{
"packageName": string,
"requestTime": string,
"events": [
{
object ( |
| フィールド | |
|---|---|
packageName |
必須。アプリケーションのパッケージ名(例: 「com.example.game」)。 |
requestTime |
必須。この特定のバッチのイベントがクライアントから送信された時刻。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
events[] |
必須。記録するプレーヤーのゲーム イベントのリスト。バッチ リクエストあたりの最大イベント数: 30 個。 |
レスポンスの本文
成功したレスポンスは、イベントのバッチが処理されたことを示します。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
| JSON 表現 |
|---|
{
"failedRequests": {
integer: {
object ( |
| フィールド | |
|---|---|
failedRequests |
失敗したイベントのマップ。
|
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/gameshttps://www.googleapis.com/auth/games_lite
詳細については、OAuth 2.0 Overview をご覧ください。
PlayerGameEvent
ゲーム内のプレーヤーのイベントによってトリガーされるシングル プレーヤー ゲームイベントの表現。たとえば、レベルのクリア、アイテムのロック解除、試合の終了などです。
| JSON 表現 |
|---|
{
"eventId": string,
"eventName": string,
"eventProperties": {
string: {
object ( |
| フィールド | |
|---|---|
eventId |
必須。この特定のイベント インスタンスに対してクライアントが生成した一意の UUID。サーバーサイドのべき等性と重複除去に使用されます。同じプレーヤーに対して以前に記録された eventId を含むイベントを送信しても、無視されます。 |
eventName |
必須。クライアントが定義したイベントの名前(「run_completed」、「level_up」など)。最大 100 文字を入力できます。 |
eventProperties |
省略可。イベントの詳細を提供する Key-Value プロパティ。- プロパティの最大数: 25。- プロパティ キーの最大長: 100 文字。- PropertyValue 内の文字列値の最大長: 1,024 文字。
|
eventTime |
必須。この特定のイベントが実行されたときのクライアントからの時間。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
PropertyValue
値のラッパー。
| JSON 表現 |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "intValue": string, "doubleValue": number, "stringValue": string, "boolValue": boolean, "durationValue": string } |
| フィールド | |
|---|---|
| スカラーの値。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
intValue |
整数値。 |
doubleValue |
double 値。 |
stringValue |
文字列値。 |
boolValue |
ブール値。 |
durationValue |
期間の値。
|
| 相互に排他的なフィールドの終了。 | |
ステータス
Status 型は、REST API や RPC API など、さまざまなプログラミング環境に適した論理エラーモデルを定義します。gRPC により使用されます。各 Status メッセージには、エラーコード、エラー メッセージ、エラーの詳細という 3 種類のデータが含まれます。
このエラーモデルと使い方について詳しくは、API 設計ガイドをご覧ください。
| JSON 表現 |
|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
| フィールド | |
|---|---|
code |
ステータス コード。 |
message |
デベロッパー向けのエラー メッセージ。英語で記述します。ユーザー向けのエラー メッセージは、ローカライズして |
details[] |
エラーの詳細を保持するメッセージのリスト。API が使用する共通のメッセージ タイプのセットがあります。 任意のデータ型のフィールドを含むオブジェクトであり、型を識別する URI を含むフィールド |