Mendapatkan konversi add-on berdasarkan channel

Gunakan metode ini di API analitik Microsoft Store untuk mendapatkan konversi agregat berdasarkan saluran untuk add-on selama rentang tanggal tertentu dan filter opsional lainnya.

  • Konversi berarti bahwa pelanggan (yang masuk dengan akun Microsoft) baru saja memperoleh lisensi untuk add-on Anda (apakah Anda mengenakan biaya atau Anda telah menawarkannya secara gratis).
  • Saluran adalah metode di mana pelanggan tiba di halaman daftar aplikasi Anda (misalnya, melalui Toko atau kampanye promosi aplikasi khusus).

Informasi ini juga tersedia dalam laporan akuisisi Add-on di Partner Center.

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/inappchannelconversions

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 aplikasi tempat Anda ingin mengambil data konversi add-on. Contoh ID Toko adalah 9WZDNCRFJ3Q8. Ya
inAppProductId string ID Penyimpanan add-on tempat Anda ingin mengambil data konversi. Ya
startDate tanggal Tanggal mulai dalam rentang tanggal data konversi untuk diambil. Defaultnya adalah 1/1/2016. Tidak
endDate tanggal Tanggal akhir dalam rentang tanggal data konversi untuk diambil. Defaultnya adalah tanggal saat ini. Tidak
top 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, badan respons menyertakan tautan berikutnya yang dapat Anda gunakan untuk meminta halaman data berikutnya. Tidak
skip int Jumlah baris yang akan dilewati dalam kueri. Gunakan parameter ini untuk halaman melalui kumpulan data besar. Misalnya, top=10000 dan skip=0 mengambil 10000 baris data pertama, top=10000 dan skip=10000 mengambil 10000 baris data berikutnya, dan seterusnya. Tidak
filter string Satu atau beberapa pernyataan yang menyaring badan respons. Setiap pernyataan dapat menggunakan operator eq atau ne , dan pernyataan dapat digabungkan menggunakan dan atau atau atau. Anda dapat menentukan string berikut dalam pernyataan filter. Untuk deskripsi, lihat bagian nilai konversi di artikel ini.
  • applicationName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • pasar

Berikut adalah contoh parameter filter : filter=deviceType eq 'PC'.

Tidak
tingkat agregasi string Menentukan rentang waktu untuk mengambil data agregat. Bisa menjadi salah satu string berikut: hari, minggu, atau bulan. Jika tidak ditentukan, default adalah hari. Tidak
orderby string Pernyataan yang memesan nilai data hasil untuk setiap konversi. Sintaksnya adalah orderby=field [order],field [order],.... Parameter bidang dapat menjadi salah satu string berikut:
  • date
  • applicationName
  • inAppProductName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • pasar

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

Berikut adalah contoh string orderby : orderby=date,market

Tidak
groupby string Pernyataan yang menerapkan agregasi data hanya ke bidang yang ditentukan. Anda dapat menentukan bidang berikut:

  • date
  • applicationName
  • inAppProductName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • deviceType
  • pasar

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

  • date
  • applicationId
  • inAppProductId
  • inAppProductName
  • konversiCount
  • klik Jumlah

Parameter groupby dapat digunakan dengan parameter aggregationLevel . Misalnya: groupby=ageGroup,marketaggregationLevel&=week

Tidak

Contoh permintaan

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

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

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

Respons

Isi respons

Nilai Jenis Deskripsi
Nilai array Array objek yang berisi data konversi agregat untuk add-on. Untuk informasi selengkapnya tentang data di setiap objek, lihat bagian nilai konversi 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 10 tetapi ada lebih dari 10 baris data konversi untuk kueri.
Jumlah Total int Jumlah total baris dalam hasil data untuk kueri.

Nilai konversi

Objek dalam array Nilai berisi nilai-nilai berikut.

Nilai Jenis Deskripsi
tanggal string Tanggal pertama dalam rentang tanggal untuk data konversi. Jika permintaan ditentukan satu hari, nilai ini adalah tanggal tersebut. Jika permintaan ditentukan dalam rentang minggu, bulan, atau tanggal lainnya, nilai ini adalah tanggal pertama dalam rentang tanggal tersebut.
inAppProductId string ID Toko add-on tempat Anda mengambil data konversi.
inAppProductName string Nama tampilan add-on tempat Anda mengambil data konversi.
applicationId string ID Toko aplikasi tempat Anda mengambil data konversi.
applicationName string Nama tampilan aplikasi tempat Anda mengambil data konversi.
appType string Jenis produk tempat Anda mengambil data konversi. Untuk metode ini, satu-satunya nilai yang didukung adalah Add-On.
customCampaignId string String ID untuk kampanye promosi aplikasi kustom yang terkait dengan aplikasi.
referrerUriDomain string Menentukan domain tempat listingan aplikasi dengan ID kampanye promosi aplikasi kustom diaktifkan.
channelType string Salah satu string berikut yang menentukan saluran untuk konversi:
  • CustomCampaignId
  • Lalu Lintas Toko
  • Lainnya
storeClient string Versi Toko tempat konversi terjadi. Saat ini, satu-satunya nilai yang didukung adalah SFC.
deviceType string Salah satu string berikut:
  • PC
  • Telepon
  • Xbox One Konsol
  • Xbox Series X Konsol
  • IoT
  • Holografik
  • Tidak dikenal
market string Kode negara ISO 3166 dari pasar tempat konversi terjadi.
klik Jumlah number Jumlah klik pelanggan pada tautan daftar aplikasi Anda.
konversiCount number Jumlah konversi pelanggan.

Contoh respons

Contoh berikut menunjukkan contoh badan respons JSON untuk permintaan ini.

{
  "Value": [
    {
      "date": "2016-01-01",
      "inAppProductId": "9NBLGGH3LHKL",
      "inAppProductName": "Contoso Add-On",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso App",
      "appType": "Add-On",
      "customCampaignId": "",
      "referrerUriDomain": "Universal Client Store",
      "channelType": "Store Traffic",
      "storeClient": "SFC",
      "deviceType": "PC",
      "market": "CN",
      "clickCount": 1,
      "conversionCount": 0
    }
  ],
  "@nextLink": null,
  "TotalCount": 1
}