Mendapatkan data akuisisi add-on untuk game dan aplikasi Anda

  • Artikel

Gunakan metode ini di API analitik Microsoft Store untuk mendapatkan data akuisisi add-on agregat dalam format JSON untuk aplikasi UWP dan game Xbox One yang diserap melalui Xbox Developer Portal (XDP) dan tersedia di dasbor Pusat Mitra XDP Analytics.

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.

Catatan

API ini tidak menyediakan data agregat harian sebelum 1 Okt 2016.

Permintaan

Minta sintaks

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

Header permintaan

Header Jenis Deskripsi
Otorisasi string Harus diisi. Token akses Microsoft Azure ACTIVE Directory dalam formulir Pembawa<token>.

Parameter permintaan

Parameter applicationId atau addonProductId 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 addonProductId . Jika Anda menentukan keduanya, parameter applicationId diabaikan.

Parameter Jenis Deskripsi Wajib diisi
applicationId string ProductId dari game Xbox One tempat Anda mengambil data akuisisi. Untuk mendapatkan productId game Anda, navigasikan ke game Anda di Program XDP Analytics dan ambil productId dari URL. Atau, jika Anda mengunduh data akuisisi dari laporan analitik Pusat Mitra, productId disertakan dalam file .tsv. Ya
addonProductId string ProductId 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
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:
  • acquisitionType
  • Umur
  • storeClient
  • jenis kelamin
  • Pasar
  • osVersion
  • deviceType
  • sandboxId
 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:
  • date
  • acquisitionType
  • Umur
  • storeClient
  • jenis kelamin
  • Pasar
  • osVersion
  • deviceType
  • orderName
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
  • addonProductName
  • acquisitionType
  • Umur
  • storeClient
  • jenis kelamin
  • Pasar
  • osVersion
  • deviceType
  • paymentInstrumentType
  • sandboxId
  • xboxTitleIdHex
Baris data yang dikembalikan akan berisi bidang yang ditentukan dalam parameter groupby serta yang berikut ini:
  • date
  • applicationId
  • addonProductId
  • acquisitionQuantity
Parameter groupby dapat digunakan dengan parameter agregasiLevel . Misalnya: &groupby=age,market&aggregationLevel=week		 No

Contoh permintaan

Contoh berikut menunjukkan beberapa permintaan untuk mendapatkan data akuisisi add-on. Ganti nilai addonProductId dan applicationId dengan ID Store yang sesuai untuk add-on atau aplikasi Anda.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/addonacquisitions?applicationId=9WZDNCRFJ314&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/addonacquisitions?applicationId=9WZDNCRFJ314&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0&filter=market eq 'GB' and gender eq 'm' 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.
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.
addonProductId string ProductId add-on tempat Anda mengambil data akuisisi.
addonProductName string Nama tampilan add-on. Nilai ini hanya muncul dalam data respons jika parameter agregasiLevel diatur ke hari, kecuali Anda menentukan bidang addonProductName di parameter groupby.
applicationId string ProductId aplikasi yang ingin Anda ambil data akuisisi add-on-nya.
applicationName string Nama tampilan permainan.
deviceType string Salah satu string berikut yang menentukan jenis perangkat yang menyelesaikan akuisisi:
  • "PC"
  • "Telepon"
  • "Console-Xbox One"
  • "Console-Xbox Series X"
  • "IoT"
  • "Server"
  • "Tablet"
  • "Holografik"
  • "Tidak diketahui"
storeClient string Salah satu string berikut yang menunjukkan versi Store tempat akuisisi terjadi:
  • "Windows Telepon Store (klien)"
  • "Microsoft Store (klien)" (atau "Windows Store (klien)" jika mengkueri data sebelum 23 Maret 2018)
  • "Microsoft Store (web)" (atau "Windows Store (web)" jika mengkueri data sebelum 23 Maret 2018)
  • "Pembelian volume oleh organisasi"
  • "Lainnya"
osVersion string Versi OS tempat akuisisi terjadi. Untuk metode ini, nilai ini selalu Windows 10 atau Windows 11".
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:
  • "b"
  • "f"
  • "Tidak diketahui"
usia string Salah satu string berikut yang menunjukkan kelompok usia pengguna yang melakukan akuisisi:
  • "kurang dari 13"
  • "13-17"
  • "18-24"
  • "25-34"
  • "35-44"
  • "44-55"
  • "lebih besar dari 55"
  • "Tidak diketahui"
acquisitionType string Salah satu string berikut yang menunjukkan jenis akuisisi:
  • "Gratis"
  • "Percobaan"
  • "Dibayar"
  • "Kode promosi"
  • "Iap"
  • "Langganan Iap"
  • "Audiens Privat"
  • "PraPesanan"
  • "Xbox Game Pass" (atau "Game Pass" jika mengkueri data sebelum 23 Maret 2018)
  • "Disk"
  • "Kode Prabayar"
  • "Pre Order Berbayar"
  • "PraPesanan Dibatalkan"
  • "Pre Order Gagal"
acquisitionQuantity Integer Jumlah akuisisi yang terjadi.
inAppProductId string ID produk produk tempat add-on ini digunakan.
inAppProductName string Nama Produk produk tempat add-on ini digunakan.
paymentInstrumentType string Jenis instrumen pembayaran yang digunakan untuk akuisisi.
sandboxId string ID Sandbox dibuat untuk permainan. Ini bisa menjadi nilai RETAIL atau ID kotak pasir privat.
xboxTitleId string ID Judul Xbox produk dari XDP, jika berlaku.
localCurrencyCode string Kode Mata Uang Lokal berdasarkan negara akun Pusat Mitra.
xboxProductId string ID Produk Xbox produk dari XDP, jika berlaku.
availabilityId string ID ketersediaan produk dari XDP, jika berlaku.
skuId string ID SKU produk dari XDP, jika berlaku.
skuDisplayName string Nama Tampilan SKU produk dari XDP, jika berlaku.
xboxParentProductId string ID Produk Induk Xbox produk dari XDP, jika berlaku.
parentProductName string Nama Produk Induk produk dari XDP, jika berlaku.
productTypeName string Nama Jenis Produk produk dari XDP, jika berlaku.
purchaseTaxType string Beli Jenis Pajak produk dari XDP, jika berlaku.
purchasePriceUSDAmount number Jumlah yang dibayarkan oleh pelanggan untuk add-on, dikonversi ke USD.
purchasePriceLocalAmount number Jumlah yang dibayarkan oleh pelanggan untuk add-on, dalam mata uang wilayah.
purchaseTaxUSDAmount number Jumlah pajak yang diterapkan ke add-on, dikonversi ke USD.
purchaseTaxLocalAmount number Beli Pajak Lokal Jumlah produk dari XDP, jika berlaku.

Contoh tanggapan

Contoh berikut menunjukkan contoh isi respons JSON untuk permintaan ini.

{ 
  "Value": [ 
    { 
            "inAppProductId": "9NBLGGH1864K", 
            "inAppProductName": "866879", 
            "addonProductId": "9NBLGGH1864K", 
            "addonProductName": "866879", 
            "date": "2017-11-05", 
            "applicationId": "9WZDNCRFJ314", 
            "applicationName": "Tetris Blitz", 
            "acquisitionType": "Iap", 
            "age": "35-49", 
            "deviceType": "Phone", 
            "gender": "m", 
            "market": "US", 
            "osVersion": "Windows Phone 8.1", 
            "paymentInstrumentType": "Credit Card", 
            "sandboxId": "RETAIL", 
            "storeClient": "Windows Phone Store (client)", 
            "xboxTitleId": "", 
            "localCurrencyCode": "USD", 
            "xboxProductId": "00000000-0000-0000-0000-000000000000", 
            "availabilityId": "", 
            "skuId": "", 
            "skuDisplayName": "Full", 
            "xboxParentProductId": "", 
            "parentProductName": "Tetris Blitz", 
            "productTypeName": "Add-On", 
            "purchaseTaxType": "", 
            "acquisitionQuantity": 1, 
            "purchasePriceUSDAmount": 1.08, 
            "purchasePriceLocalAmount": 0.09, 
            "purchaseTaxUSDAmount": 1.08, 
            "purchaseTaxLocalAmount": 0.09 
        } 
    ], 

    "@nextLink": null, 
    
    "TotalCount": 7601 
}