Mendapatkan data performa iklan
Gunakan metode ini di API analitik Microsoft Store untuk mendapatkan data performa iklan agregat untuk aplikasi Anda selama rentang tanggal tertentu dan filter opsional lainnya. Metode ini mengembalikan data dalam format JSON.
Metode ini mengembalikan data yang sama yang disediakan oleh laporan performa Periklanan 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.
Untuk informasi selengkapnya, lihat Mengakses data analitik menggunakan layanan Microsoft Store.
Permintaan
Minta sintaks
| Metode | URI Permintaan |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance |
Header permintaan
| Header | Jenis | Deskripsi |
|---|---|---|
| Otorisasi | string | Harus diisi. Token akses Microsoft Azure ACTIVE Directory dalam bentuk token> Pembawa<. |
Parameter permintaan
Untuk mengambil data performa iklan untuk aplikasi tertentu, gunakan parameter applicationId . Untuk mengambil data performa iklan untuk semua aplikasi yang terkait dengan akun pengembang Anda, hilangkan parameter applicationId .
| Parameter | Jenis | Deskripsi | Wajib diisi |
|---|---|---|---|
| applicationId | string | ID Penyimpanan aplikasi yang ingin Anda ambil data performa iklannya. | No |
| startDate | date | Tanggal mulai dalam rentang tanggal data performa iklan untuk diambil, dalam format YYYY/MM/DD. Defaultnya adalah tanggal saat ini dikurangi 30 hari. | No |
| endDate | date | Tanggal akhir dalam rentang tanggal data performa iklan untuk diambil, dalam format YYYY/MM/DD. Defaultnya adalah tanggal saat ini dikurangi satu hari. | 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. 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:
Parameter groupby dapat digunakan dengan parameter agregasiLevel . Misalnya: &groupby=applicationId&aggregationLevel=week |
No |
Memfilter bidang
Parameter filter isi 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 parameter filter :
- filter=market eq 'US' dan deviceType eq 'phone'
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 iklan ditayangkan. |
| deviceType | Salah satu string berikut: PC/Tablet atau Telepon. |
| adUnitId | String yang menentukan ID unit iklan untuk diterapkan ke filter. |
| pubCenterAppName | String yang menentukan nama pubCenter untuk aplikasi saat ini untuk diterapkan ke filter. |
| adProvider | String yang menentukan nama penyedia iklan untuk diterapkan ke filter. |
| date | String yang menentukan tanggal dalam format YYYY/MM/DD untuk diterapkan ke filter. |
Contoh permintaan
Contoh berikut menunjukkan beberapa permintaan untuk mendapatkan data performa iklan. Ganti nilai applicationId dengan ID Toko untuk aplikasi Anda.
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance?applicationId=9NBLGGH4R315&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/adsperformance?applicationId=9NBLGGH4R315&startDate=8/1/2015&endDate=8/31/2015&skip=0&$filter=market eq 'US' and deviceType eq 'phone’ eq 'US'; 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 performa iklan agregat. Untuk informasi selengkapnya tentang data di setiap objek, lihat bagian nilai performa iklan 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 5 tetapi ada lebih dari 5 item data untuk kueri. |
| TotalCount | int | Jumlah total baris dalam hasil data untuk kueri. |
Nilai performa iklan
Elemen dalam array Nilai berisi nilai berikut.
| Value | Jenis | Deskripsi |
|---|---|---|
| date | string | Tanggal pertama dalam rentang tanggal untuk data performa iklan. 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 performa iklan. |
| applicationName | string | Nama tampilan aplikasi. |
| adUnitId | string | ID unit iklan. |
| adUnitName | string | Nama unit iklan, seperti yang ditentukan oleh pengembang di Pusat Mitra. |
| adProvider | string | Nama penyedia iklan |
| deviceType | string | Jenis perangkat tempat iklan ditayangkan. Untuk daftar string yang didukung, lihat bagian bidang filter di atas. |
| market | string | Kode negara ISO 3166 pasar tempat iklan ditayangkan. |
| accountCurrencyCode | string | Kode mata uang untuk akun. |
| pubCenterAppName | string | Nama aplikasi pubCenter yang terkait dengan aplikasi di Pusat Mitra. |
| adProviderRequests | int | Jumlah permintaan iklan untuk penyedia iklan yang ditentukan. |
| Tayangan | int | Jumlah tayangan iklan. |
| Klik | int | Jumlah klik iklan. |
| revenueInAccountCurrency | number | Pendapatan, dalam mata uang untuk negara/wilayah akun. |
| permintaan | int | Jumlah permintaan iklan. |
Contoh tanggapan
Contoh berikut menunjukkan contoh isi respons JSON untuk permintaan ini.
{
"Value": [
{
"date": "2015-03-09",
"applicationId": "9NBLGGH4R315",
"applicationName": "Contoso Demo",
"market": "US",
"deviceType": "phone",
"adUnitId":"10765920",
"adUnitName":"TestAdUnit",
"revenueInAccountCurrency": 10.0,
"impressions": 1000,
"requests": 10000,
"clicks": 1,
"accountCurrencyCode":"USD"
},
{
"date": "2015-03-09",
"applicationId": "9NBLGGH4R315",
"applicationName": "Contoso Demo",
"market": "US",
"deviceType": "phone",
"adUnitId":"10795110",
"adUnitName":"TestAdUnit2",
"revenueInAccountCurrency": 20.0,
"impressions": 2000,
"requests": 20000,
"clicks": 3,
"accountCurrencyCode":"USD"
},
],
"@nextLink": "adsperformance?applicationId=9NBLGGH4R315&aggregationLevel=week&startDate=2015/03/01&endDate=2016/02/01&top=2&skip=2",
"TotalCount": 191753
}
Topik terkait
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