Bagikan melalui

Mendapatkan peringkat aplikasi

  • Artikel

Gunakan metode ini di API analitik Microsoft Store untuk mendapatkan data peringkat agregat dalam format JSON untuk rentang tanggal tertentu dan filter opsional lainnya. Informasi ini juga tersedia dalam laporan Ulasan di Pusat Mitra.

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 ACTIVE Directory untuk digunakan di header permintaan untuk metode ini. Setelah mendapatkan token akses, Anda memiliki waktu 60 menit untuk menggunakan token akses sebelum masa berlakunya habis. Setelah token kedaluwarsa, Anda dapat memperoleh yang baru.

Minta

Minta sintaks

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

Header permintaan

Header Tipe Deskripsi
Authorization string Harus diisi. Token akses Microsoft Azure ACTIVE Directory dalam bentuk token> Pembawa<.

Parameter permintaan

Parameter Jenis Deskripsi Wajib diisi
applicationId string ID Penyimpanan aplikasi yang ingin Anda ambil data peringkatnya. Ya
startDate date Tanggal mulai dalam rentang tanggal data peringkat yang akan diambil. Defaultnya adalah tanggal saat ini. No
endDate date Tanggal akhir dalam rentang tanggal data peringkat yang akan diambil. Defaultnya adalah tanggal saat ini. No
atas int Jumlah baris data yang akan dikembalikan dalam permintaan. Nilai maksimum dan nilai default jika tidak ditentukan adalah 10000. Jika ada lebih banyak baris dalam kueri, isi respons menyertakan tautan berikutnya yang bisa Anda gunakan untuk meminta halaman data berikutnya. No
skip int Jumlah baris yang akan dilewati dalam kueri. Gunakan parameter ini untuk halaman melalui himpunan data besar. Misalnya, top=10000 dan skip=0 mengambil 10000 baris data pertama, top=10000 dan skip=10000 mengambil 10000 baris data berikutnya, dan sebagainya. No
filter string Satu atau beberapa pernyataan yang memfilter baris dalam respons. Untuk informasi selengkapnya, lihat bagian bidang filter di bawah ini. No
agregasiLevel string Menentukan rentang waktu untuk mengambil data agregat. Dapat berupa salah satu string berikut: hari, minggu, atau bulan. Jika tidak ditentukan, defaultnya adalah hari. No
urut berdasarkan string Pernyataan yang mengurutkan nilai data hasil untuk setiap peringkat. Sintaksnya adalah orderby=field [order],field [order],.... Parameter bidang dapat berupa salah satu string berikut:
  • date
  • osVersion
  • pasar
  • deviceType
  • isRevised

Parameter pesanan bersifat opsional, dan dapat berupa asc atau desc untuk menentukan urutan naik atau turun untuk setiap bidang. Defaultnya adalah asc.

Berikut adalah contoh string orderby : orderby=date,market

 No
groupby string Pernyataan yang menerapkan agregasi data hanya ke bidang yang ditentukan. Anda dapat menentukan bidang berikut:
  • date
  • applicationName
  • pasar
  • osVersion
  • deviceType
  • isRevised

Baris data yang dikembalikan akan berisi bidang yang ditentukan dalam parameter groupby serta yang berikut ini:

  • date
  • applicationId
  • fiveStars
  • fourStars
  • threeStars
  • twoStars
  • oneStar

Parameter groupby dapat digunakan dengan parameter agregasiLevel . Misalnya: &groupby=osVersion,market&aggregationLevel=week

 No

 

Memfilter bidang

Parameter filter permintaan berisi satu atau beberapa pernyataan yang memfilter baris dalam respons. Setiap pernyataan berisi bidang dan nilai yang terkait dengan operator eq atau ne , dan pernyataan dapat digabungkan menggunakan dan atau atau.

Berikut adalah contoh string filter : filter=market eq 'US' dan deviceType eq 'phone' dan isRevised eq true

Untuk daftar bidang yang didukung, lihat tabel berikut ini. Nilai string harus dikelilingi oleh tanda kutip tunggal dalam parameter filter .

Bidang Deskripsi
market String yang berisi kode negara ISO 3166 pasar tempat aplikasi Anda dinilai.
osVersion Salah satu string berikut:
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Tidak diketahui
deviceType Salah satu string berikut:
  • Komputer mikro
  • Nomor
  • Console-Xbox One
  • Console-Xbox Series X
  • IoT
  • Holografik
  • Tidak diketahui
isRevised Tentukan true untuk memfilter peringkat yang telah direvisi; jika tidak salah.

Contoh permintaan

Contoh berikut menunjukkan beberapa permintaan untuk mendapatkan data peringkat. Ganti nilai applicationId dengan ID Toko untuk aplikasi Anda.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?applicationId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and deviceType eq 'phone' HTTP/1.1
Authorization: Bearer <your access token>

Respons

Isi respons

Nilai Tipe Deskripsi
Nilai array Array objek yang berisi data peringkat agregat. Untuk informasi selengkapnya tentang data di setiap objek, lihat bagian nilai peringkat di bawah ini.
@nextLink string Jika ada halaman data tambahan, string ini berisi URI yang dapat Anda gunakan untuk meminta halaman data berikutnya. Misalnya, nilai ini dikembalikan jika parameter teratas permintaan diatur ke 10000 tetapi ada lebih dari 10000 baris data peringkat untuk kueri.
TotalCount int Jumlah total baris dalam hasil data untuk kueri.

Nilai peringkat

Elemen dalam array Nilai berisi nilai berikut.

Nilai Tipe Deskripsi
date string Tanggal pertama dalam rentang tanggal untuk data peringkat. Jika permintaan menentukan satu hari, nilai ini adalah tanggal tersebut. Jika permintaan yang ditentukan minggu, bulan, atau rentang tanggal lainnya, nilai ini adalah tanggal pertama dalam rentang tanggal tersebut.
applicationId string ID Penyimpanan aplikasi tempat Anda mengambil data peringkat.
applicationName string Nama tampilan aplikasi.
market string Kode negara ISO 3166 dari pasar tempat peringkat dikirimkan.
osVersion string Versi OS tempat peringkat dikirimkan. Untuk daftar string yang didukung, lihat bagian bidang filter di atas.
deviceType string Jenis perangkat tempat peringkat dikirimkan. Untuk daftar string yang didukung, lihat bagian bidang filter di atas.
isRevised Boolean Nilai benar menunjukkan bahwa peringkat direvisi; jika tidak salah.
oneStar number Jumlah peringkat bintang satu.
twoStars number Jumlah peringkat bintang dua.
threeStars number Jumlah peringkat bintang tiga.
fourStars number Jumlah peringkat bintang empat.
fiveStars number Jumlah peringkat bintang lima.

Contoh Permintaan dan Respons

Cuplikan kode berikut menunjukkan beberapa contoh permintaan dan isi respons JSON untuk permintaan tersebut.

Permintaan Sampel

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

Respons Sampel


{
    "Value": [
        {
            "date": "2012-09-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "oneStar": 1,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 1,
            "fiveStars": 3
        },
        {
            "date": "2012-09-02",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "oneStar": 3,
            "twoStars": 0,
            "threeStars": 1,
            "fourStars": 2,
            "fiveStars": 17
        },
        {
            "date": "2012-09-03",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "oneStar": 1,
            "twoStars": 1,
            "threeStars": 1,
            "fourStars": 5,
            "fiveStars": 17
        },
  ],
    "TotalCount": 3
}

Permintaan Sampel

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/ratings?applicationId=9NBLGGGZ5QDR&startDate=06/19/2022&endDate=07/20/2022&top=10&skip=0&groupby=date,applicationName,market,osVersion,deviceType,isRevised
HTTP/1.1
Authorization: Bearer <your access token>

Respons Sampel

{
    "Value": [
        {
            "date": "2022-06-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "CL",
            "osVersion": "Windows 11",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-06-22",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "TR",
            "osVersion": "Windows 11",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-06-29",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "FR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 1,
            "fiveStars": 0
        },
        {
            "date": "2022-07-01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-04",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "ES",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-06",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "ES",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-07",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "AE",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "true",
            "oneStar": 1,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 0
        },
        {
            "date": "2022-07-10",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "true",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-13",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "EG",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "false",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 0,
            "fiveStars": 1
        },
        {
            "date": "2022-07-14",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "isRevised": "true",
            "oneStar": 0,
            "twoStars": 0,
            "threeStars": 0,
            "fourStars": 1,
            "fiveStars": 0
        }
    ],
    "TotalCount": 10
}