Dapatkan data penggunaan bersamaan Xbox Live

Gunakan metode ini di API analitik Microsoft Store untuk mendekati data penggunaan real-time (dengan latensi 5-15 menit) tentang jumlah rata-rata pelanggan yang memainkan game Xbox Live Anda setiap menit, jam, atau hari selama rentang waktu tertentu. Informasi ini juga tersedia dalam laporan analitik Xbox di Partner Center.

Penting

Metode ini hanya mendukung game untuk Xbox atau game yang menggunakan layanan Xbox Live. Game-game ini harus melalui proses persetujuan konsep, yang mencakup game yang diterbitkan oleh mitra Microsoft dan game yang dikirimkan melalui program ID@Xbox. Metode ini saat ini tidak mendukung game yang diterbitkan melalui Program Kreator Xbox Live.

Prasyarat

Untuk menggunakan metode ini, Anda harus terlebih dahulu melakukan hal berikut:

  • Jika Anda belum melakukannya, selesaikan semua prasyarat untuk API analitik Microsoft Store.
  • Dapatkan token akses Azure AD untuk digunakan di header permintaan untuk metode ini. Setelah mendapatkan token akses, Anda memiliki waktu 60 menit untuk menggunakannya sebelum masa berlakunya habis. Setelah token kedaluwarsa, Anda bisa mendapatkan yang baru.

Minta

Minta sintaks

Metode URI Permintaan
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/gameanalytics

Header permintaan

Header Jenis Deskripsi
Authorization string Wajib diisi. Token akses Azure AD dalam bentuk Bearertoken<>.

Parameter permintaan

Parameter Jenis Deskripsi Diperlukan
applicationId string ID Toko game yang ingin Anda ambil Xbox Live data penggunaan bersamaan. Ya
metricType string String yang menentukan jenis data analitik Xbox Live untuk diambil. Untuk metode ini, tentukan konkurensi nilai. Ya
startDate tanggal Tanggal mulai dalam rentang tanggal data penggunaan bersamaan untuk diambil. Lihat deskripsi aggregationLevel untuk perilaku default. Tidak
endDate tanggal Tanggal akhir dalam rentang tanggal data penggunaan bersamaan untuk diambil. Lihat deskripsi aggregationLevel untuk perilaku default. Tidak
tingkat agregasi string Menentukan rentang waktu untuk mengambil data agregat. Bisa menjadi salah satu string berikut: menit, jam, atau hari. Jika tidak ditentukan, default adalah hari.

Jika Anda tidak menentukan startDate atau endDate, badan respons default ke hal berikut:

  • menit: 60 catatan terakhir dari data yang tersedia.
  • jam: 24 catatan terakhir dari data yang tersedia.
  • hari: 7 catatan terakhir dari data yang tersedia.

Tingkat agregasi berikut memiliki batas ukuran pada jumlah catatan yang dapat dikembalikan. Catatan akan terpotong jika rentang waktu yang diminta terlalu besar.

  • menit: Hingga 1440 catatan (24 jam data).
  • jam: Hingga 720 catatan (30 hari data).
  • hari: Hingga 60 catatan (60 hari data).
Tidak

Contoh permintaan

Contoh berikut menunjukkan permintaan untuk mendapatkan data penggunaan bersamaan untuk game Xbox Live Anda. Permintaan ini mengambil data untuk setiap menit antara 1 Februari 2018 dan 2 Februari 2018. Ganti nilai applicationId dengan ID Toko untuk game Anda.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/gameanalytics?applicationId=9NBLGGGZ5QDR&metrictype=concurrency&aggregationLevel=hour&startDate=2018-02-01&endData=2018-02-02 HTTP/1.1
Authorization: Bearer <your access token>

Respons

Badan respons berisi array objek yang masing-masing berisi satu set data penggunaan bersamaan untuk menit, jam, atau hari tertentu. Setiap objek berisi nilai-nilai berikut.

Nilai Jenis Deskripsi
Hitung number Jumlah rata-rata pelanggan yang memainkan Xbox Live Anda diaktifkan untuk menit, jam, atau hari yang ditentukan.

Nota Nilai 0 menunjukkan bahwa tidak ada pengguna bersamaan selama interval yang ditentukan, atau bahwa ada kegagalan saat mengumpulkan data pengguna bersamaan untuk permainan selama interval yang ditentukan.

Tanggal string Tanggal dan waktu yang menentukan menit, jam atau hari di mana data penggunaan bersamaan terjadi.
Nama Seri string Ini selalu memiliki nilai UserConcurrency.

Contoh respons

Contoh berikut menunjukkan contoh badan respons JSON untuk permintaan ini dengan agregasi data per menit.

[   {
        "Count": 418.0,
        "Date": "2018-02-02T04:42:13.65Z",
        "SeriesName": "UserConcurrency"
    }, {
        "Count": 418.0,
        "Date": "2018-02-02T04:43:13.65Z",
        "SeriesName": "UserConcurrency"
    }, {
        "Count": 415.0,
        "Date": "2018-02-02T04:44:13.65Z",
        "SeriesName": "UserConcurrency"
    }, {
        "Count": 412.0,
        "Date": "2018-02-02T04:45:13.65Z",
        "SeriesName": "UserConcurrency"
    }, {
        "Count": 414.0,
        "Date": "2018-02-02T04:46:13.65Z",
        "SeriesName": "UserConcurrency"
    }
]