Mendapatkan data performa kampanye iklan

Artikel
04/02/2022
4 menit untuk membaca

Gunakan metode ini di API analitik Microsoft Store untuk mendapatkan ringkasan agregat data performa kampanye iklan promosi 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 kampanye Iklan di Pusat Mitra. Untuk informasi selengkapnya tentang kampanye iklan, lihat Membuat kampanye iklan untuk aplikasi Anda.

Untuk membuat, memperbarui, atau mengambil detail untuk kampanye iklan, Anda dapat menggunakan metode Kelola kampanye iklan di API promosi Microsoft Store.

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/promotion`

Header permintaan

Header	Jenis	Deskripsi
Authorization	string	Wajib diisi. Token akses Azure AD dalam bentuk Bearertoken<>.

Parameter permintaan

Untuk mengambil data performa kampanye iklan untuk aplikasi tertentu, gunakan parameter applicationId . Untuk mengambil data performa iklan untuk semua aplikasi yang terkait dengan akun developer Anda, hilangkan parameter applicationId .

Parameter	Jenis	Deskripsi	Diperlukan
applicationId	string	ID Toko aplikasi tempat Anda ingin mengambil data performa kampanye iklan.	Tidak
startDate	tanggal	Tanggal mulai dalam rentang tanggal data performa kampanye iklan untuk diambil, dalam format YYYY/MM/DD. Defaultnya adalah tanggal saat ini dikurangi 30 hari.	Tidak
endDate	tanggal	Tanggal akhir dalam rentang tanggal data performa kampanye iklan untuk diambil, dalam format YYYY/MM/DD. Defaultnya adalah tanggal saat ini dikurangi satu hari.	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 memfilter baris dalam respons. Satu-satunya filter yang didukung adalah campaignId. Setiap pernyataan dapat menggunakan operator eq atau ne , dan pernyataan dapat digabungkan menggunakan dan atau atau atau. Berikut adalah contoh parameter filter : `filter=campaignId eq '100023'`.	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 memerintahkan nilai data hasil untuk data performa kampanye iklan. Sintaksnya adalah orderby=field [order],field [order],.... Parameter bidang dapat menjadi salah satu string berikut: date campaignId 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,campaignId	Tidak
groupby	string	Pernyataan yang menerapkan agregasi data hanya ke bidang yang ditentukan. Anda dapat menentukan bidang berikut: campaignId applicationId date currencyCode Parameter groupby dapat digunakan dengan parameter aggregationLevel . Misalnya: &groupby=applicationIdaggregationLevel&=week	Tidak

Contoh permintaan

Contoh berikut menunjukkan beberapa permintaan untuk mendapatkan data performa kampanye iklan.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?aggregationLevel=week&groupby=applicationId,campaignId,date  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?applicationId=9NBLGGH0XK8Z&startDate=2015/1/20&endDate=2016/8/31&skip=0&filter=campaignId eq '31007388' HTTP/1.1
Authorization: Bearer <your access token>

Respons

Isi respons

Nilai	Jenis	Deskripsi
Nilai	array	Array objek yang berisi data performa kampanye iklan agregat. Untuk informasi selengkapnya tentang data di setiap objek, lihat bagian objek performa kampanye 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.
Jumlah Total	int	Jumlah total baris dalam hasil data untuk kueri.

Objek performa kampanye

Elemen dalam array Nilai berisi nilai berikut.

Nilai	Jenis	Deskripsi
tanggal	string	Tanggal pertama dalam rentang tanggal untuk data performa kampanye iklan. 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.
applicationId	string	ID Toko aplikasi tempat Anda mengambil data performa kampanye iklan.
campaignId	string	ID kampanye iklan.
lineId	string	ID lini pengiriman kampanye iklan yang menghasilkan data performa ini.
currencyCode	string	Kode mata uang dari anggaran kampanye.
membelanjakan	string	Jumlah anggaran yang telah dihabiskan untuk kampanye iklan.
Tayangan	long	Jumlah tayangan iklan untuk kampanye.
Menginstal	long	Jumlah penginstalan aplikasi yang terkait dengan kampanye.
Klik	long	Jumlah klik iklan untuk kampanye.
iapInstalls	long	Jumlah add-on (juga disebut pembelian dalam aplikasi atau IAP) diinstal terkait dengan kampanye.
activeUsers	long	Jumlah pengguna yang telah mengklik iklan yang merupakan bagian dari kampanye dan kembali ke aplikasi.

Contoh respons

Contoh berikut menunjukkan contoh badan respons JSON untuk permintaan ini.

{
  "Value": [
    {
      "date": "2015-04-12",
      "applicationId": "9WZDNCRFJ31Q",
      "campaignId": "4568",
      "lineId": "0001",
      "currencyCode": "USD",
      "spend": 700.6,
      "impressions": 200,
      "installs": 30,
      "clicks": 8,
      "iapInstalls": 0,
      "activeUsers": 0
    },
    {
      "date": "2015-05-12",
      "applicationId": "9WZDNCRFJ31Q",
      "campaignId": "1234",
      "lineId": "0002",
      "currencyCode": "USD",
      "spend": 325.3,
      "impressions": 20,
      "installs": 2,
      "clicks": 5,
      "iapInstalls": 0,
      "activeUsers": 0
    }
  ],
  "@nextLink": "promotion?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2015/1/20&endDate=2016/8/31&top=2&skip=2",
  "TotalCount": 1917
}