TurnBasedMatches

mewakili pencocokan berbasis giliran.

Untuk daftar metode untuk resource ini, lihat bagian akhir halaman ini.

Representasi resource

Ini adalah template JSON untuk objek resource pencocokan berbasis giliran.

{
  "kind": "games#turnBasedMatch",
  "matchId": string,
  "applicationId": string,
  "variant": integer,
  "status": string,
  "userMatchStatus": string,
  "participants": [
    {
      "kind": "games#turnBasedMatchParticipant",
      "id": string,
      "player": players Resource,
      "autoMatchedPlayer": {
        "kind": "games#anonymousPlayer",
        "displayName": string,
        "avatarImageUrl": string
      },
      "autoMatched": boolean,
      "status": string
    }
  ],
  "creationDetails": {
    "kind": "games#turnBasedMatchModification",
    "participantId": string,
    "modifiedTimestampMillis": long
  },
  "lastUpdateDetails": {
    "kind": "games#turnBasedMatchModification",
    "participantId": string,
    "modifiedTimestampMillis": long
  },
  "autoMatchingCriteria": {
    "kind": "games#turnBasedAutoMatchingCriteria",
    "minAutoMatchingPlayers": integer,
    "maxAutoMatchingPlayers": integer,
    "exclusiveBitmask": long
  },
  "data": {
    "kind": "games#turnBasedMatchData",
    "dataAvailable": boolean,
    "data": bytes
  },
  "results": [
    {
      "kind": "games#participantResult",
      "participantId": string,
      "result": string,
      "placing": integer
    }
  ],
  "inviterId": string,
  "withParticipantId": string,
  "description": string,
  "pendingParticipantId": string,
  "matchVersion": integer,
  "rematchId": string,
  "matchNumber": integer,
  "previousMatchData": {
    "kind": "games#turnBasedMatchData",
    "dataAvailable": boolean,
    "data": bytes
  }
}
Nama properti Nilai Deskripsi Catatan
applicationId string ID aplikasi yang sedang diputar.
autoMatchingCriteria nested object Kriteria untuk pemain yang cocok otomatis ke dalam kecocokan ini.
autoMatchingCriteria.exclusiveBitmask long Bitmask yang menunjukkan kapan pencocokan otomatis valid. Jika digabungkan dengan bitmask eksklusif lainnya, hasilnya harus nol. Dapat digunakan untuk mendukung peran eksklusif dalam game.
autoMatchingCriteria.kind string Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap games#turnBasedAutoMatchingCriteria.
autoMatchingCriteria.maxAutoMatchingPlayers integer Jumlah maksimum pemain yang harus ditambahkan ke kecocokan dengan pencocokan otomatis.
autoMatchingCriteria.minAutoMatchingPlayers integer Jumlah minimum pemain yang harus ditambahkan ke kecocokan dengan pencocokan otomatis.
creationDetails nested object Detail tentang pembuatan pencocokan.
creationDetails.kind string Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap games#turnBasedMatchModification.
creationDetails.modifiedTimestampMillis long Stempel waktu saat mereka mengubah kecocokan, dalam milidetik sejak epoch dalam UTC.
creationDetails.participantId string ID peserta yang mengubah kecocokan.
data nested object Status data / game untuk pertandingan ini.
data.data bytes Representasi byte data (dibatasi hingga 128 kB), sebagai string berenkode Base64 dengan opsi encoding URL_SAFE.
data.dataAvailable boolean Ya, jika kecocokan ini memiliki data yang tersedia tetapi tidak dikembalikan dalam respons daftar; mengambil kecocokan satu per satu akan mengambil data ini.
data.kind string Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap games#turnBasedMatchData.
description string Deskripsi singkat ini dibuat oleh server kami berdasarkan status giliran dan dilokalkan serta diucapkan sesuai dengan pemain yang meminta pertandingan. Hal ini dimaksudkan untuk ditampilkan saat kecocokan ditampilkan dalam daftar.
inviterId string ID peserta yang mengundang pengguna ke pertandingan. Tidak ditetapkan jika pengguna tidak diundang ke pertandingan.
kind string Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap games#turnBasedMatch.
lastUpdateDetails nested object Detail tentang pembaruan terakhir pada pertandingan.
lastUpdateDetails.kind string Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap games#turnBasedMatchModification.
lastUpdateDetails.modifiedTimestampMillis long Stempel waktu saat mereka mengubah kecocokan, dalam milidetik sejak epoch dalam UTC.
lastUpdateDetails.participantId string ID peserta yang mengubah kecocokan.
matchId string ID unik global untuk kecocokan berbasis giliran.
matchNumber integer Jumlah kecocokan dalam rantai pertandingan ulang. Akan ditetapkan ke 1 untuk kecocokan pertama dan ditingkatkan 1 untuk setiap pertandingan ulang.
matchVersion integer Versi kecocokan ini: penghitung yang meningkat, digunakan untuk menghindari update yang sudah tidak berlaku pada pencocokan.
participants[] list Peserta yang terlibat dalam pertandingan, beserta statusnya. Termasuk peserta yang telah meninggalkan atau menolak undangan.
participants[].autoMatched boolean True jika peserta ini dicocokkan secara otomatis dengan pemutar yang meminta.
participants[].autoMatchedPlayer nested object Informasi tentang pemain yang telah dicocokkan secara anonim dengan pemutar yang meminta. (player atau autoMatchedPlayer akan ditetapkan.)
participants[].autoMatchedPlayer.avatarImageUrl string URL dasar untuk gambar yang ditampilkan untuk pemutar anonim.
participants[].autoMatchedPlayer.displayName string Nama yang akan ditampilkan untuk pemutar anonim.
participants[].autoMatchedPlayer.kind string Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap games#anonymousPlayer.
participants[].id string ID untuk peserta dalam cakupan pencocokan. Tidak dapat digunakan untuk mengidentifikasi pemain di seluruh pertandingan atau dalam konteks lain.
participants[].kind string Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap games#turnBasedMatchParticipant.
participants[].player nested object Informasi tentang pemutar. Tidak diisi jika pemain ini dicocokkan secara otomatis dengan pemutar yang meminta. (player atau autoMatchedPlayer akan ditetapkan.)
participants[].status string Status peserta sehubungan dengan kecocokan.
Nilai yang memungkinkan adalah:
  • "PARTICIPANT_NOT_INVITED_YET" - Peserta dijadwalkan untuk diundang ke pertandingan, tetapi undangan belum dikirim; undangan akan dikirim saat giliran mereka berakhir.
  • "PARTICIPANT_INVITED" - Peserta telah diundang untuk bergabung dalam pertandingan, tetapi belum menanggapinya.
  • "PARTICIPANT_JOINED" - Peserta telah bergabung dengan pertandingan (baik setelah membuatnya atau menerima undangan.)
  • "PARTICIPANT_DECLINED" - Peserta menolak undangan untuk bergabung dengan pertandingan.
  • "PARTICIPANT_LEFT" - Peserta bergabung dengan pertandingan, lalu keluar.
  • "PARTICIPANT_FINISHED" - Peserta selesai bermain dalam pertandingan.
  • "PARTICIPANT_UNRESPONSIVE" - Peserta tidak mengambil giliran dalam waktu yang ditentukan.


Nilai yang dapat diterima adalah:
  • "PARTICIPANT_DECLINED"
  • "PARTICIPANT_FINISHED"
  • "PARTICIPANT_INVITED"
  • "PARTICIPANT_JOINED"
  • "PARTICIPANT_LEFT"
  • "PARTICIPANT_NOT_INVITED_YET"
  • "PARTICIPANT_UNRESPONSIVE"
pendingParticipantId string ID peserta yang sedang bergiliran.
previousMatchData nested object Status data / game untuk pertandingan sebelumnya; hanya ditetapkan untuk giliran pertama pertandingan ulang.
previousMatchData.data bytes Representasi byte data (dibatasi hingga 128 kB), sebagai string berenkode Base64 dengan opsi encoding URL_SAFE.
previousMatchData.dataAvailable boolean Ya, jika kecocokan ini memiliki data yang tersedia tetapi tidak dikembalikan dalam respons daftar; mengambil kecocokan satu per satu akan mengambil data ini.
previousMatchData.kind string Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap games#turnBasedMatchData.
rematchId string ID pertandingan ulang. Hanya ditetapkan untuk pencocokan lengkap yang telah dicocokkan kembali.
results[] list Hasil yang dilaporkan untuk pertandingan ini.
results[].kind string Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap games#participantResult.
results[].participantId string ID peserta.
results[].placing integer Penempatan atau peringkat peserta dalam hasil pertandingan; angka dari satu hingga jumlah peserta dalam pertandingan. Beberapa peserta mungkin memiliki nilai penempatan yang sama untuk jenis tertentu.
results[].result string Hasil peserta untuk pertandingan ini.
Nilai yang memungkinkan adalah:
  • "MATCH_RESULT_WIN" - Peserta memenangkan pertandingan.
  • "MATCH_RESULT_LOSS" - Peserta kalah dalam pertandingan.
  • "MATCH_RESULT_TIE" - Peserta mengikat pertandingan.
  • "MATCH_RESULT_NONE" - Tidak ada pemenang untuk pertandingan ini (tidak ada yang menang atau kalah dalam game ini.)
  • "MATCH_RESULT_DISCONNECT" - Peserta terputus/keluar selama pertandingan.
  • "MATCH_RESULT_DISAGREED" - Klien yang berbeda melaporkan hasil yang berbeda untuk peserta ini.


Nilai yang dapat diterima adalah:
  • "MATCH_RESULT_DISAGREED"
  • "MATCH_RESULT_DISCONNECT"
  • "MATCH_RESULT_LOSS"
  • "MATCH_RESULT_NONE"
  • "MATCH_RESULT_TIE"
  • "MATCH_RESULT_WIN"
status string Status kecocokan.
Nilai yang memungkinkan adalah:
  • "MATCH_AUTO_MATCHING" - Satu atau beberapa slot harus diisi dengan pencocokan otomatis; pencocokan tidak dapat dibuat hingga slot terisi.
  • "MATCH_ACTIVE" - Pertandingan telah dimulai.
  • "MATCH_COMPLETE" - Pertandingan telah selesai.
  • "MATCH_CANCELED" - Pertandingan dibatalkan.
  • "MATCH_EXPIRED" - Pertandingan berakhir karena tidak aktif.
  • "MATCH_DELETED" - Pencocokan tidak akan lagi ditampilkan pada klien. Ditampilkan hanya untuk tombstone untuk kecocokan saat sinkronisasi dipanggil.


Nilai yang dapat diterima adalah:
  • "MATCH_ACTIVE"
  • "MATCH_AUTO_MATCHING"
  • "MATCH_CANCELED"
  • "MATCH_COMPLETE"
  • "MATCH_DELETED"
  • "MATCH_EXPIRED"
userMatchStatus string Status pengguna saat ini dalam pencocokan. Diambil dari jenis pencocokan, status kecocokan, status peserta pengguna, dan peserta yang menunggu keputusan untuk pencocokan.
Nilai yang memungkinkan adalah:
  • "USER_INVITED" - Pengguna telah diundang untuk bergabung dalam pertandingan dan belum merespons.
  • "USER_AWAITING_TURN" - Pengguna menunggu giliran mereka.
  • "USER_TURN" - Pengguna memiliki tindakan yang akan dilakukan dalam pencocokan.
  • "USER_MATCH_COMPLETED" - Pertandingan telah berakhir (selesai, dibatalkan, atau kedaluwarsa.)


Nilai yang dapat diterima adalah:
  • "USER_AWAITING_TURN"
  • "USER_INVITED"
  • "USER_MATCH_COMPLETED"
  • "USER_TURN"
variant integer Varian / mode aplikasi yang sedang dimainkan; dapat berupa nilai bilangan bulat, atau dibiarkan kosong.
withParticipantId string ID peserta lain dalam pertandingan yang dapat digunakan saat menjelaskan peserta yang sedang bermain dengan pengguna.

Metode

batal
Batalkan pencocokan berbasis giliran.
buat
Buat pencocokan berbasis giliran.
tolak
Tolak undangan untuk memutar pertandingan berbasis giliran.
tutup
Tutup pencocokan berbasis giliran dari daftar kecocokan. Hasil pencocokan tidak akan muncul lagi dalam daftar dan tidak akan membuat notifikasi.
selesai
Menyelesaikan pencocokan berbasis giliran. Setiap pemain harus melakukan panggilan ini satu kali, setelah semua hasil masuk. Hanya pemain yang gilirannya dapat melakukan panggilan pertama ke Finish, dan dapat meneruskan status kecocokan terakhir.
dapatkan
Dapatkan data untuk pencocokan berbasis giliran.
join
Bergabunglah dengan pertandingan berbasis giliran.
keluar
Meninggalkan pertandingan berbasis giliran jika bukan giliran pemain saat ini, tanpa membatalkan pertandingan.
keluar dari
Meninggalkan pertandingan berbasis giliran selama giliran pemain saat ini, tanpa membatalkan pertandingan.
list
Menampilkan kecocokan berbasis giliran yang melibatkan atau melibatkan pemain.
pencocokan ulang
Membuat pencocokan ulang pertandingan yang sebelumnya diselesaikan, dengan peserta yang sama. Tindakan ini hanya dapat dipanggil oleh satu pemain pada pertandingan yang masih ada dalam daftar; pemain tersebut harus sudah selesai terlebih dahulu. Menampilkan kecocokan yang baru dibuat; giliran pemanggil.
sinkronisasi
Menampilkan kecocokan berbasis giliran dari pemain yang mengalami atau terlibat dalam perubahan tersebut sejak panggilan sinkronisasi terakhir, dengan perubahan terbaru akan muncul terlebih dahulu. Kecocokan yang harus dihapus dari cache lokal akan memiliki status MATCH_DELETED.
mengambil alih
Commit hasil giliran pemain.