Halaman ini diterjemahkan oleh Cloud Translation API.

Rooms

Merepresentasikan status ruang dengan beberapa pemain.

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

Representasi resource

Ini adalah template JSON untuk objek resource ruang.

{
  "kind": "games#room",
  "roomId": string,
  "applicationId": string,
  "variant": integer,
  "status": string,
  "participants": [
    {
      "kind": "games#roomParticipant",
      "id": string,
      "player": players Resource,
      "autoMatchedPlayer": {
        "kind": "games#anonymousPlayer",
        "displayName": string,
        "avatarImageUrl": string
      },
      "autoMatched": boolean,
      "status": string,
      "clientAddress": {
        "kind": "games#roomClientAddress",
        "xmppAddress": string
      },
      "connected": boolean,
      "leaveReason": string,
      "capabilities": [
        string
      ]
    }
  ],
  "inviterId": string,
  "creationDetails": {
    "kind": "games#roomModification",
    "participantId": string,
    "modifiedTimestampMillis": long
  },
  "lastUpdateDetails": {
    "kind": "games#roomModification",
    "participantId": string,
    "modifiedTimestampMillis": long
  },
  "description": string,
  "autoMatchingCriteria": {
    "kind": "games#roomAutoMatchingCriteria",
    "minAutoMatchingPlayers": integer,
    "maxAutoMatchingPlayers": integer,
    "exclusiveBitmask": long
  },
  "roomStatusVersion": integer,
  "autoMatchingStatus": {
    "kind": "games#roomAutoMatchStatus",
    "waitEstimateSeconds": integer
  }
}

Nama properti	Nilai	Deskripsi
`applicationId`	`string`	ID aplikasi yang sedang diputar.
`autoMatchingCriteria`	`nested object`	Kriteria untuk pemain yang cocok secara otomatis ke dalam ruang 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#roomAutoMatchingCriteria`.
`autoMatchingCriteria.maxAutoMatchingPlayers`	`integer`	Jumlah maksimum pemain yang harus ditambahkan ke ruang dengan pencocokan otomatis.
`autoMatchingCriteria.minAutoMatchingPlayers`	`integer`	Jumlah minimum pemain yang harus ditambahkan ke ruang dengan pencocokan otomatis.
`autoMatchingStatus`	`nested object`	Status pencocokan otomatis untuk ruang ini. Tidak ditetapkan jika ruang saat ini tidak ada dalam antrean pencocokan otomatis.
`autoMatchingStatus.kind`	`string`	Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap `games#roomAutoMatchStatus`.
`autoMatchingStatus.waitEstimateSeconds`	`integer`	Estimasi jumlah waktu (dalam detik) yang diperlukan untuk menyelesaikan pencocokan otomatis.
`creationDetails`	`nested object`	Detail tentang pembuatan ruang.
`creationDetails.kind`	`string`	Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap `games#roomModification`.
`creationDetails.modifiedTimestampMillis`	`long`	Stempel waktu saat mereka mengubah ruang, dalam milidetik sejak epoch dalam UTC.
`creationDetails.participantId`	`string`	ID peserta yang mengubah ruang.
`description`	`string`	Deskripsi singkat ini dibuat oleh server kami dan disusun secara relatif terhadap pemutar yang meminta ruang. Baris ini dimaksudkan untuk ditampilkan saat ruang ditampilkan dalam daftar (yaitu undangan ke ruang).
`inviterId`	`string`	ID peserta yang mengundang pengguna ke ruang. Tidak ditetapkan jika pengguna tidak diundang ke ruang.
`kind`	`string`	Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap `games#room`.
`lastUpdateDetails`	`nested object`	Detail tentang perubahan terakhir pada ruang.
`lastUpdateDetails.kind`	`string`	Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap `games#roomModification`.
`lastUpdateDetails.modifiedTimestampMillis`	`long`	Stempel waktu saat mereka mengubah ruang, dalam milidetik sejak epoch dalam UTC.
`lastUpdateDetails.participantId`	`string`	ID peserta yang mengubah ruang.
`participants[]`	`list`	Peserta yang terlibat dalam ruang, beserta status mereka. 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[].capabilities[]`	`list`	Kemampuan yang dapat digunakan saat berkomunikasi dengan peserta ini.
`participants[].clientAddress`	`nested object`	Alamat klien untuk peserta.
`participants[].clientAddress.kind`	`string`	Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap `games#roomClientAddress`.
`participants[].clientAddress.xmppAddress`	`string`	Alamat XMPP klien di jaringan XMPP Google Game.
`participants[].connected`	`boolean`	Berlaku jika peserta ini berada dalam kumpulan sesama yang terhubung sepenuhnya di ruang.
`participants[].id`	`string`	ID untuk peserta dalam cakupan ruang. Tidak dapat digunakan untuk mengidentifikasi pemain di seluruh ruang atau dalam konteks lain.
`participants[].kind`	`string`	Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap `games#roomParticipant`.
`participants[].leaveReason`	`string`	Alasan peserta keluar dari ruang; diisi jika status peserta adalah `PARTICIPANT_LEFT`. Nilai yang memungkinkan adalah: "`PLAYER_LEFT`" - Pemutar secara eksplisit memilih untuk keluar dari ruang. "`GAME_LEFT`" - Game memilih untuk menghapus pemain dari ruang. "`ABANDONED`" - Pemutar beralih ke aplikasi lain dan meninggalkan ruang. "`PEER_CONNECTION_FAILURE`" - Klien tidak dapat membuat atau mempertahankan koneksi ke pembanding lain di ruang. "`SERVER_ERROR`" - Klien menerima respons error saat mencoba berkomunikasi dengan server. "`TIMEOUT`" - Klien mengalami waktu tunggu habis saat menunggu pemain untuk bergabung dan terhubung. "`PRESENCE_FAILURE`" - Koneksi XMPP klien tiba-tiba berakhir. Nilai yang dapat diterima adalah: "`ABANDONED`" "`GAME_LEFT`" "`PEER_CONNECTION_FAILURE`" "`PLAYER_LEFT`" "`PRESENCE_FAILURE`" "`SERVER_CONNECTION_FAILURE`" "`SERVER_ERROR`" "`TIMEOUT`"
`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 ruang. Nilai yang memungkinkan adalah: "`PARTICIPANT_INVITED`" - Peserta telah diundang untuk bergabung ke ruang, tetapi belum menanggapinya. "`PARTICIPANT_JOINED`" - Peserta telah bergabung ke ruang (setelah membuatnya atau menerima undangan). "`PARTICIPANT_DECLINED`" - Peserta menolak undangan untuk bergabung ke ruang. "`PARTICIPANT_LEFT`" - Peserta bergabung ke ruang, lalu keluar. Nilai yang dapat diterima adalah: "`PARTICIPANT_DECLINED`" "`PARTICIPANT_INVITED`" "`PARTICIPANT_JOINED`" "`PARTICIPANT_LEFT`"
`roomId`	`string`	ID unik global untuk ruangan.
`roomStatusVersion`	`integer`	Versi status ruang: penghitung yang meningkat, digunakan oleh klien untuk mengabaikan pembaruan yang tidak berurutan pada status ruang.
`status`	`string`	Status ruang. Nilai yang memungkinkan adalah: "`ROOM_INVITING`" - Satu atau beberapa pemain telah diundang dan tidak merespons. "`ROOM_AUTO_MATCHING`" - Satu atau beberapa slot harus diisi dengan pencocokan otomatis. "`ROOM_CONNECTING`" - Pemain bergabung dan terhubung satu sama lain (sebelum atau setelah pencocokan otomatis). "`ROOM_ACTIVE`" - Semua pemain telah bergabung dan terhubung satu sama lain. "`ROOM_DELETED`" - Ruang tidak akan lagi ditampilkan pada klien. Ditampilkan di panggilan sinkronisasi saat pemain bergabung ke ruang (sebagai tombstone), atau untuk ruang tempat semua peserta yang bergabung keluar. Nilai yang dapat diterima adalah: "`ROOM_ACTIVE`" "`ROOM_AUTO_MATCHING`" "`ROOM_CONNECTING`" "`ROOM_DELETED`" "`ROOM_INVITING`"
`variant`	`integer`	Varian / mode aplikasi yang sedang dimainkan; dapat berupa nilai bilangan bulat, atau dibiarkan kosong.

Metode

buat: Membuat ruang. Untuk penggunaan internal khusus Game SDK. Memanggil metode ini secara langsung tidak didukung.
tolak: Menolak undangan untuk bergabung ke ruang. Untuk penggunaan internal khusus Game SDK. Memanggil metode ini secara langsung tidak didukung.
tutup: Menutup undangan untuk bergabung ke ruang. Untuk penggunaan internal khusus Game SDK. Memanggil metode ini secara langsung tidak didukung.
dapatkan: Mendapatkan data untuk ruang.
join: Bergabung ke ruang. Untuk penggunaan internal khusus Game SDK. Memanggil metode ini secara langsung tidak didukung.
keluar: Keluar dari ruang. Untuk penggunaan internal khusus Game SDK. Memanggil metode ini secara langsung tidak didukung.
list: Menampilkan undangan untuk bergabung ke ruang.
reportStatus: Pembaruan yang dikirim oleh klien yang melaporkan status pembanding di ruang. Untuk penggunaan internal khusus Game SDK. Memanggil metode ini secara langsung tidak didukung.