Mendapatkan akuisisi add-on
Gunakan metode ini di API analitik Microsoft Store untuk mendapatkan data akuisisi agregat untuk add-on untuk aplikasi Anda dalam format JSON selama rentang tanggal tertentu dan filter opsional lainnya. Informasi ini juga tersedia dalam laporan akuisisi Add-on 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.
Permintaan
Minta sintaks
| Metode | URI Permintaan |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions |
Header permintaan
| Header | Jenis | Deskripsi |
|---|---|---|
| Otorisasi | string | Harus diisi. Token akses Microsoft Azure ACTIVE Directory dalam bentuk token> Pembawa<. |
Parameter permintaan
Parameter applicationId atau inAppProductId diperlukan. Untuk mengambil data akuisisi untuk semua add-on yang terdaftar ke aplikasi, tentukan parameter applicationId . Untuk mengambil data akuisisi untuk satu add-on, tentukan parameter inAppProductId . Jika Anda menentukan keduanya, parameter applicationId diabaikan.
| Parameter | Jenis | Deskripsi | Wajib diisi |
|---|---|---|---|
| applicationId | string | ID Toko aplikasi yang ingin Anda ambil data akuisisi add-on-nya. | Ya |
| inAppProductId | string | ID Penyimpanan add-on yang ingin Anda ambil data akuisisinya. | Ya |
| startDate | date | Tanggal mulai dalam rentang tanggal data akuisisi add-on untuk diambil. Defaultnya adalah tanggal saat ini. | No |
| endDate | date | Tanggal akhir dalam rentang tanggal data akuisisi add-on 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. 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 akuisisi add-on. 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 |
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 beberapa contoh parameter filter :
- filter=market eq 'US' dan gender eq 'm'
- filter=(market ne 'US') dan (ne gender 'Unknown') dan (gender ne 'm') dan (market ne 'NO') dan (ageGroup ne 'greater than 55' atau ageGroup ne 'less than 13')
Untuk daftar bidang yang didukung, lihat tabel berikut ini. Nilai string harus dikelilingi oleh tanda kutip tunggal dalam parameter filter .
| Kolom | Deskripsi |
|---|---|
| acquisitionType | Salah satu string berikut:
|
| ageGroup | Salah satu string berikut:
|
| storeClient | Salah satu string berikut:
|
| gender | Salah satu string berikut:
|
| market | String yang berisi kode negara ISO 3166 dari pasar tempat akuisisi terjadi. |
| osVersion | Salah satu string berikut:
|
| deviceType | Salah satu string berikut:
|
| orderName | String yang menentukan nama pesanan untuk kode promosi yang digunakan untuk memperoleh add-on (ini hanya berlaku jika pengguna memperoleh add-on dengan menukarkan kode promosi). |
Contoh permintaan
Contoh berikut menunjukkan beberapa permintaan untuk mendapatkan data akuisisi add-on. Ganti nilai inAppProductId dan applicationId dengan ID Store yang sesuai untuk add-on atau aplikasi Anda.
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?inAppProductId=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/inappacquisitions?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/inappacquisitions?inAppProductId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=7/3/2015&top=100&skip=0&filter=market ne 'US' and gender ne 'Unknown' and gender ne 'm' and market ne 'NO' and ageGroup ne '>55' HTTP/1.1
Authorization: Bearer <your access token>
Respons
Isi respons
| Value | Jenis | Deskripsi |
|---|---|---|
| Value | array | Array objek yang berisi data akuisisi add-on agregat. Untuk informasi selengkapnya tentang data di setiap objek, lihat bagian nilai akuisisi add-on 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 add-on untuk kueri. |
| TotalCount | int | Jumlah total baris dalam hasil data untuk kueri. |
Nilai akuisisi add-on
Elemen dalam array Nilai berisi nilai berikut.
| Value | Jenis | 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. |
| inAppProductId | string | ID Penyimpanan add-on tempat Anda mengambil data akuisisi. |
| inAppProductName | string | Nama tampilan add-on. Nilai ini hanya muncul dalam data respons jika parameter agregasiLevel diatur ke hari, kecuali Anda menentukan bidang inAppProductName di parameter groupby. |
| applicationId | string | ID Toko aplikasi yang ingin Anda ambil data akuisisi add-on-nya. |
| applicationName | string | Nama tampilan aplikasi. |
| deviceType | string | Jenis perangkat yang menyelesaikan akuisisi. Untuk daftar string yang didukung, lihat bagian bidang filter di atas. |
| orderName | string | Nama pesanan. |
| storeClient | string | Versi Store tempat akuisisi terjadi. Untuk daftar string yang didukung, lihat bagian bidang filter di atas. |
| osVersion | string | Versi OS tempat akuisisi terjadi. Untuk daftar string yang didukung, lihat bagian bidang filter di atas. |
| market | string | Kode negara ISO 3166 dari pasar tempat akuisisi terjadi. |
| gender | string | Jenis kelamin pengguna yang melakukan akuisisi. Untuk daftar string yang didukung, lihat bagian bidang filter di atas. |
| ageGroup | string | Kelompok usia pengguna yang melakukan akuisisi. Untuk daftar string yang didukung, lihat bagian bidang filter di atas. |
| acquisitionType | string | Jenis akuisisi (gratis, berbayar, dan sebagainya). Untuk daftar string yang didukung, lihat bagian bidang filter di atas. |
| acquisitionQuantity | Integer | Jumlah akuisisi yang terjadi. |
Contoh Permintaan dan Respons
Cuplikan kode berikut menunjukkan contoh permintaan dan isi respons JSON untuk permintaan tersebut.
Permintaan Sampel
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>
Respons Sampel
{
"Value": [
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Deluxe Collector's Edition",
"addonProductId": "9NBLGGAAGZDQ",
"date": "2022-07-29",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 18.12,
"purchasePriceLocalAmount": 18.12,
"purchaseTaxUSDAmount": 1.13,
"purchaseTaxLocalAmount": 1.13
},
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Episode 4",
"addonProductId": "9NAAAAAAAAAQ",
"date": "2017-01-07",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 4.147206,
"purchasePriceLocalAmount": 3.99,
"purchaseTaxUSDAmount": 0.686004,
"purchaseTaxLocalAmount": 0.66
},
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Deluxe Collector's Edition",
"addonProductId": "9NALGGGZ5QDQ",
"date": "2018-04-01",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 1.99,
"purchasePriceLocalAmount": 1.99,
"purchaseTaxUSDAmount": 0.0,
"purchaseTaxLocalAmount": 0.0
},
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Strategy Guide Episode 4",
"addonProductId": "9NBLGGGZ5QDQ",
"date": "2021-11-25",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 1.31902922876179,
"purchasePriceLocalAmount": 150.0,
"purchaseTaxUSDAmount": 0.114315866492689,
"purchaseTaxLocalAmount": 13.0
},
],
"TotalCount": 4,
"DataFreshnessTimestamp": "2022-07-29T05:54:00"
}
Topik terkait
- Laporan akuisisi add-on
- Mengakses data analitik menggunakan layanan Microsoft Store
- Mendapatkan konversi add-on menurut saluran
- Mendapatkan akuisisi aplikasi
- Mendapatkan data corong akuisisi aplikasi
- Mendapatkan konversi aplikasi menurut saluran
Saran dan Komentar
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat: https://aka.ms/ContentUserFeedback.
Kirim dan lihat umpan balik untuk