Mendapatkan akuisisi aplikasi
Gunakan metode ini di API analitik Microsoft Store untuk mendapatkan data akuisisi agregat dalam format JSON untuk aplikasi selama rentang tanggal tertentu dan filter opsional lainnya. Informasi ini juga tersedia dalam laporan Akuisisi 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/appacquisitions |
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 Toko aplikasi yang ingin Anda ambil data akuisisinya. | Ya |
startDate | date | Tanggal mulai dalam rentang tanggal data akuisisi untuk diambil. Defaultnya adalah tanggal saat ini. | No |
endDate | date | Tanggal akhir dalam rentang tanggal data akuisisi untuk 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. Setiap pernyataan berisi nama bidang dari isi respons dan nilai yang terkait dengan operator eq atau ne , dan pernyataan dapat digabungkan menggunakan dan atau atau. Nilai string harus dikelilingi oleh tanda kutip tunggal dalam parameter filter . Misalnya, filter=market eq 'US' dan gender eq 'm'. Anda dapat menentukan bidang berikut dari isi respons:
|
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 akuisisi. Sintaksnya adalah orderby=field [order],field [order],.... Parameter bidang dapat berupa salah satu string berikut:
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:
Baris data yang dikembalikan akan berisi bidang yang ditentukan dalam parameter groupby serta yang berikut ini:
Parameter groupby dapat digunakan dengan parameter agregasiLevel . Misalnya: &groupby=ageGroup,market&aggregationLevel=week |
No |
Contoh permintaan
Contoh berikut menunjukkan beberapa permintaan untuk mendapatkan data akuisisi aplikasi. Ganti nilai applicationId dengan ID Toko untuk aplikasi Anda.
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?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/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and gender eq 'm' HTTP/1.1
Authorization: Bearer <your access token>
Respons
Isi respons
Nilai | Tipe | Deskripsi |
---|---|---|
Nilai | array | Array objek yang berisi data akuisisi agregat untuk aplikasi. Untuk informasi selengkapnya tentang data di setiap objek, lihat bagian nilai akuisisi 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 akuisisi untuk kueri. |
TotalCount | int | Jumlah total baris dalam hasil data untuk kueri. |
Nilai akuisisi
Elemen dalam array Nilai berisi nilai berikut.
Nilai | Tipe | Deskripsi |
---|---|---|
date | string | Tanggal pertama dalam rentang tanggal untuk data akuisisi. 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 Toko aplikasi tempat Anda mengambil data akuisisi. |
applicationName | string | Nama tampilan aplikasi. |
deviceType | string | Salah satu string berikut yang menentukan jenis perangkat tempat akuisisi terjadi:
|
orderName | string | Nama pesanan. |
storeClient | string | Salah satu string berikut yang menunjukkan versi Store tempat akuisisi terjadi:
|
osVersion | string | Salah satu string berikut yang menentukan versi OS tempat akuisisi terjadi:
|
market | string | Kode negara ISO 3166 dari pasar tempat akuisisi terjadi. |
gender | string | Salah satu string berikut yang menentukan jenis kelamin pengguna yang melakukan akuisisi:
|
ageGroup | string | Salah satu string berikut yang menentukan kelompok usia pengguna yang melakukan akuisisi:
|
acquisitionType | string | Salah satu string berikut yang menunjukkan jenis akuisisi:
|
acquisitionQuantity | number | Jumlah akuisisi yang terjadi selama tingkat agregasi yang ditentukan. |
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/appacquisitions?applicationId=9NBLGGGZ5QDR HTTP/1.1
Authorization: Bearer <your access token>
Respons Sampel
{
"Value": [
{
"applicationId": "9NBLGGGZ5QDR",
"date": "2022-07-29",
"acquisitionQuantity": 7,
"purchasePriceUSDAmount": 0.0,
"purchasePriceLocalAmount": 0.0,
"purchaseTaxUSDAmount": 0.0,
"purchaseTaxLocalAmount": 0.0
},
],
"TotalCount": 1,
"DataFreshnessTimestamp": "2022-07-29T08:42:00"
}
Permintaan Sampel
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2021&endDate=12/21/2021&skip=0&filter=market&groupby=date,applicationName,acquisitionType,ageGroup,storeClient,gender,market,osVersion,deviceType HTTP/1.1
Authorization: Bearer <your access token>
Respons Sampel
{
"Value": [
{
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"acquisitionType": "Free",
"storeClient": "Microsoft Store (client)",
"gender": "f",
"market": "TW",
"osVersion": "Windows 10",
"deviceType": "PC",
"date": "2021-08-01",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 0.0,
"purchasePriceLocalAmount": 0.0,
"purchaseTaxUSDAmount": 0.0,
"purchaseTaxLocalAmount": 0.0
},
{
"applicationId": "9NBLGGGZ5QDR",
"applicationName": "Contoso Demo",
"acquisitionType": "Free",
"storeClient": "Microsoft Store (client)",
"gender": "Unknown",
"market": "BR",
"osVersion": "Windows 10",
"deviceType": "PC",
"date": "2021-08-01",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 0.0,
"purchasePriceLocalAmount": 0.0,
"purchaseTaxUSDAmount": 0.0,
"purchaseTaxLocalAmount": 0.0
},
],
"TotalCount": 2,
"DataFreshnessTimestamp": "2022-07-29T08:42:00"
}