API Reference

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Referensi API ini diatur menurut jenis resource. Setiap jenis resource memiliki satu atau beberapa representasi data dan satu atau beberapa metode.

Jenis resource

  1. AchievementDefinitions
  2. Pencapaian
  3. Aplikasi
  4. Acara
  5. Papan peringkat
  6. Metagame
  7. Pemain
  8. Token push
  9. Revisi
  10. Ruang
  11. Skor
  12. Snapshot
  13. Statistik
  14. Berbasis Kecocokan

PencapaianDefinisi

Untuk detail Resource AchievementDefinitions, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/games/v1, kecuali dinyatakan lain
list GET  /achievements Mencantumkan semua definisi pencapaian untuk aplikasi Anda.

Pencapaian

Untuk mengetahui detail Resource Pencapaian, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/games/v1, kecuali dinyatakan lain
kenaikan POST  /achievements/achievementId/increment Menambah langkah-langkah pencapaian dengan ID yang diberikan untuk pemain yang saat ini diautentikasi.

Parameter kueri yang diperlukan: stepsToIncrement

list GET  /players/playerId/achievements Mencantumkan progres untuk semua pencapaian aplikasi Anda untuk pemain yang saat ini diautentikasi.
ungkapkan POST  /achievements/achievementId/reveal Menetapkan status pencapaian dengan ID yang diberikan ke REVEALED untuk pemain yang saat ini diautentikasi.
setStepsAtLeast POST  /achievements/achievementId/setStepsAtLeast Menetapkan langkah-langkah bagi pemain yang saat ini diautentikasi untuk membuka pencapaian. Jika parameter langkah kurang dari jumlah langkah saat ini yang sudah diperoleh pemain untuk pencapaian, pencapaian tidak akan diubah.

Parameter kueri yang diperlukan: steps

buka kunci POST  /achievements/achievementId/unlock Membuka pencapaian ini untuk pemain yang saat ini terautentikasi.
pembaruanBeberapa POST  /achievements/updateMultiple Memperbarui beberapa pencapaian untuk pemain yang saat ini diautentikasi.

Aplikasi

Untuk detail Resource Aplikasi, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/games/v1, kecuali dinyatakan lain
dapatkan GET  /applications/applicationId Mengambil metadata aplikasi dengan ID yang diberikan. Jika aplikasi yang diminta tidak tersedia untuk platformType yang ditentukan, respons yang ditampilkan tidak akan menyertakan data instance apa pun.
telah diputar POST  /applications/played Mengindikasikan bahwa pengguna yang saat ini diautentikasi sedang memutar aplikasi Anda.
verifikasi GET  /applications/applicationId/verify Memverifikasi bahwa token autentikasi yang diberikan dengan permintaan ini ditujukan untuk aplikasi dengan ID yang ditentukan dan menampilkan ID pemutar yang diberikan izinnya.

Peristiwa

Untuk mengetahui detail Resource Peristiwa, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/games/v1, kecuali dinyatakan lain
listByPlayer GET  /events Menampilkan daftar yang menunjukkan progres saat ini pada peristiwa di aplikasi ini untuk pengguna yang saat ini diautentikasi.
listDefinitions GET  /eventDefinitions Menampilkan daftar definisi peristiwa di aplikasi ini.
catatan POST  /events Merekam batch perubahan pada frekuensi terjadinya peristiwa untuk pengguna aplikasi yang saat ini terautentikasi.

Papan peringkat

Untuk mengetahui detail Resource Papan Peringkat, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/games/v1, kecuali dinyatakan lain
dapatkan GET  /leaderboards/leaderboardId Mengambil metadata papan peringkat dengan ID yang diberikan.
list GET  /leaderboards Mencantumkan semua metadata papan peringkat untuk aplikasi Anda.

Game meta

Untuk mengetahui detail Resource Metagame, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/games/v1, kecuali dinyatakan lain
getMetagameConfig GET  /metagameConfig Menampilkan data konfigurasi metagame untuk aplikasi panggilan.
listCategoriesByPlayer GET  /players/playerId/categories/collection Cantumkan data pemutaran yang digabungkan per kategori untuk pemain yang sesuai dengan playerId.

Pemain

Untuk detail Resource Pemain, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/games/v1, kecuali dinyatakan lain
dapatkan GET  /players/playerId Mengambil resource Player dengan ID yang diberikan. Untuk mengambil pemutar bagi pengguna yang saat ini terautentikasi, tetapkan playerId ke me.
list GET  /players/me/players/collection Mendapatkan koleksi pemain untuk pengguna yang saat ini diautentikasi.

Token push

Untuk detail Pushtokens Resource, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/games/v1, kecuali dinyatakan lain
hapus POST  /pushtokens/remove Menghapus token push untuk pengguna dan aplikasi saat ini. Penghapusan token push yang tidak ada akan melaporkan keberhasilan.
perbarui PUT  /pushtokens Mendaftarkan token push untuk pengguna dan aplikasi saat ini.

Revisi

Untuk mengetahui detail Resource Revisi, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/games/v1, kecuali dinyatakan lain
periksa GET  /revisions/check Memeriksa apakah klien game sudah usang.

Parameter kueri yang diperlukan: clientRevision

Ruang

Untuk mengetahui detail Resource Ruang, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/games/v1, kecuali dinyatakan lain
buat POST  /rooms/create Membuat ruang. Untuk penggunaan internal khusus Game SDK. Memanggil metode ini secara langsung tidak didukung.
tolak POST  /rooms/roomId/decline Menolak undangan untuk bergabung ke ruang. Untuk penggunaan internal khusus Game SDK. Memanggil metode ini secara langsung tidak didukung.
tutup POST  /rooms/roomId/dismiss Menutup undangan untuk bergabung ke ruang. Untuk penggunaan internal khusus Game SDK. Memanggil metode ini secara langsung tidak didukung.
dapatkan GET  /rooms/roomId Mendapatkan data untuk ruang.
join POST  /rooms/roomId/join Bergabung ke ruang. Untuk penggunaan internal khusus Game SDK. Memanggil metode ini secara langsung tidak didukung.
keluar POST  /rooms/roomId/leave Keluar dari ruang. Untuk penggunaan internal khusus Game SDK. Memanggil metode ini secara langsung tidak didukung.
list GET  /rooms Menampilkan undangan untuk bergabung ke ruang.
reportStatus POST  /rooms/roomId/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.

Skor

Untuk mengetahui detail Resource Skor, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/games/v1, kecuali dinyatakan lain
dapatkan GET  /players/playerId/leaderboards/leaderboardId/scores/timeSpan Dapatkan skor tinggi, dan secara opsional, peringkat, di papan peringkat untuk pemain yang saat ini diautentikasi. Untuk rentang waktu tertentu, leaderboardId dapat disetel ke ALL untuk mengambil data semua papan peringkat dalam rentang waktu tertentu.
CATATAN: Anda tidak dapat meminta papan peringkat 'SEMUA' dan 'SEMUA' timespan dalam permintaan yang sama; hanya satu parameter yang dapat ditetapkan ke 'SEMUA'.
list GET  /leaderboards/leaderboardId/scores/collection Mencantumkan skor di papan peringkat, mulai dari atas.

Parameter kueri yang diperlukan: timeSpan

listWindow GET  /leaderboards/leaderboardId/window/collection Mencantumkan skor di papan peringkat seputar (dan termasuk) skor pemain.

Parameter kueri yang diperlukan: timeSpan

kirim POST  /leaderboards/leaderboardId/scores Mengirim skor ke papan peringkat yang ditentukan.

Parameter kueri yang diperlukan: score

kirim Beberapa POST  /leaderboards/scores Mengirimkan beberapa skor ke papan peringkat.

Snapshot

Untuk mengetahui detail Resource Snapshot, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/games/v1, kecuali dinyatakan lain
dapatkan GET  /snapshots/snapshotId Mengambil metadata untuk ID snapshot yang diberikan.
list GET  /players/playerId/snapshots Mengambil daftar snapshot yang dibuat oleh aplikasi untuk pemutar yang sesuai dengan ID pemain.

Statistik

Untuk detail Resource Statistik, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/games/v1, kecuali dinyatakan lain
dapatkan GET  /stats Menampilkan statistik engagement dan pembelanjaan di aplikasi ini untuk pengguna yang saat ini diautentikasi.

Kecocokan Berbasis Giliran

Untuk mengetahui detail Resource TurnBasedMatch, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/games/v1, kecuali dinyatakan lain
batal PUT  /turnbasedmatches/matchId/cancel Batalkan pencocokan berbasis giliran.
buat POST  /turnbasedmatches/create Membuat pencocokan berbasis giliran.
tolak PUT  /turnbasedmatches/matchId/decline Tolak undangan untuk memutar pertandingan berbasis giliran.
tutup PUT  /turnbasedmatches/matchId/dismiss Menutup pencocokan berbasis giliran dari daftar pencocokan. Hasil pencocokan tidak akan muncul lagi dalam daftar dan tidak akan membuat notifikasi.
selesai PUT  /turnbasedmatches/matchId/finish Selesaikan 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 GET  /turnbasedmatches/matchId Mendapatkan data untuk pencocokan berbasis giliran.
join PUT  /turnbasedmatches/matchId/join Bergabunglah dengan pencocokan berbasis giliran.
keluar PUT  /turnbasedmatches/matchId/leave Meninggalkan pertandingan berbasis giliran jika bukan giliran pemain saat ini, tanpa membatalkan pertandingan.
keluar dari PUT  /turnbasedmatches/matchId/leaveTurn Memberikan kecocokan berbasis giliran selama giliran pemain saat ini, tanpa membatalkan pertandingan.

Parameter kueri yang diperlukan: matchVersion

list GET  /turnbasedmatches Menampilkan kecocokan berbasis giliran yang diikuti atau melibatkan pemain.
pencocokan ulang POST  /turnbasedmatches/matchId/rematch Membuat pertandingan ulang yang sebelumnya telah selesai, 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 GET  /turnbasedmatches/sync Menampilkan kecocokan berbasis giliran yang melibatkan 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 PUT  /turnbasedmatches/matchId/turn Commit hasil dari giliran pemain.