API Laporan Aktivitas Iklan versi Alfa

Perhatian: Terima kasih atas partisipasi Anda dalam versi alfa Laporan Aktivitas Iklan. Tujuan Laporan Aktivitas Iklan tidak berencana untuk keluar dari versi alfa dan tidak didukung lagi. Gunakan Mediation Report API sebagai gantinya. Pelajari lebih lanjut batasan stabilitas alfa channel.

Penting: Peran dan izin pengguna baru akan memengaruhi data ditampilkan oleh AdMob API. Pelajari lebih lanjut

Laporan Aktivitas Iklan adalah tampilan terpusat dari performa iklan Anda. Diagram ini menggabungkan data, metrik, dan dimensi dari API laporan jaringan dan API laporan mediasi, serta data bidding ke dalam satu laporan terpadu.

Ads Activity Report API memberikan peningkatan tambahan dari Mediasi Report API dan Network Report API seperti yang terlihat pada tabel di bawah:

	API Laporan Jaringan	API Laporan Mediasi	API Laporan Aktivitas Iklan
Performa jaringan	✅	✅	✅
Performa waterfall		✅	✅
Performa bidding			✅
Performa Eksperimen A/B dengan mediasi			✅
Pelaporan per jam			✅
Ukuran laporan	100 rb	100 rb	500 rb

Metrik, dimensi, dan filter dimensi

Metrik berikut telah ditambahkan ke Ads Activity Report API di selain banyak metrik yang tersedia di Network Report API dan Mediation Report API.

Metrik	Deskripsi
BID_REQUEST	Jumlah permintaan yang dibuat ke sumber iklan bidding.
BIDS_IN_AUCTION	Jumlah bid yang diajukan oleh sumber iklan yang berpartisipasi dalam lelang bidding.
WINNING_BIDS	Jumlah bid yang memenangkan lelang bidding.

Dimensi baru berikut disertakan dalam Ads Activity Report API.

Dimensi	Deskripsi
MINGGU	Tanggal hari pertama dalam seminggu (sesuai dengan bahasa kode yang disebutkan di setelan pelokalan) dalam format YYYYMMDD (untuk misalnya, "20210701"). Permintaan hanya dapat menentukan salah satu dari DATE, WEEK, atau MONTH dimensi waktu.
JAM	Jam dalam format HH dalam waktu PST. Misalnya, "05" untuk pukul 05.00 PST, "13" untuk pukul 13.00 PST. Dimensi DATE juga harus ditentukan dalam permintaan. J maksimal 28 hari data ditampilkan jika dimensi HOUR ditentukan. Tanggal mulai rentang tanggal yang lebih besar dari 28 hari sebelum tanggal saat ini menghasilkan {i>error<i}.
MEDIATION_AB_TEST (nama eksperimen)	Melihat performa berdasarkan pengujian A/B mediasi. Anda wajib menentukan jika dimensi VARIANT ditentukan.
MEDIATION_AB_TEST_VARIANT (Varian A, Varian B)	Melihat performa berdasarkan varian pengujian A/B mediasi.

Catatan: Semua dimensi dalam laporan Aktivitas Iklan didukung sebagai dimensi filter. Untuk nilai dengan akhiran _NAME dan _ID, akhiran _ID adalah nilai filter yang didukung. Misalnya untuk memfilter unit iklan, gunakan AD_UNIT_ID dimensi sebagai filter dimensi.

Nama dimensi di Mediation Report API	Nama dimensi di Ads Activity Report API	Deskripsi
UNIT_IKLAN^1	AD_UNIT_ID	ID unik unit iklan (misalnya, "123456789").
	AD_UNIT_NAME	Nama unit iklan.
APLIKASI^1	APP_ID	ID unik aplikasi seluler (misalnya, "1234567890").
	APP_NAME	Nama aplikasi.
SUMBER_IKLAN^1	AD_SOURCE_ID	ID unik sumber iklan (misalnya, "1234567890123456789".
	AD_SOURCE_NAME	Nama sumber iklan (misalnya, "Jaringan AdMob").
AD_SOURCE_INSTANCE^1	AD_SOURCE_INSTANCE_ID	ID unik instance sumber iklan (misalnya, "123456789012").
	AD_SOURCE_INSTANCE_NAME	Nama instance sumber iklan (misalnya, "AdMob (default)").
MEDIATION_GROUP^1	MEDIATION_GROUP_ID	ID unik grup mediasi (misalnya, "1234567890").
	MEDIATION_GROUP_NAME	ID unik grup mediasi (misalnya, "AdMob (default)").

¹: Lihat Scalars untuk informasi tambahan.

Dimensi berikut memiliki format yang diperbarui.

Nama dimensi di Mediation Report API	Deskripsi di Mediation Report API	Deskripsi di Ads Activity Report API
ESTIMATED_EARNINGS	Estimasi penghasilan penayang AdMob. Unit mata uang (USD, EUR, atau lainnya) dari metrik penghasilan ditentukan oleh pelokalan untuk mata uang. Jumlahnya dalam mikro. Misalnya, $6,50 akan menjadi yang dinyatakan sebagai 6500000. Estimasi penghasilan per tingkat grup mediasi dan per sumber iklan adalah didukung sejak 20 Oktober 2019. Estimasi penghasilan pihak ketiga akan tampilkan 0 untuk tanggal sebelum 20 Oktober 2019.	Estimasi penghasilan penayang AdMob. Unit mata uang (USD, EUR, atau lainnya) dari metrik penghasilan ditentukan oleh pelokalan untuk mata uang.
OBSERVED_ECPM	Estimasi eCPM rata-rata jaringan iklan pihak ketiga. Unit mata uang (USD, EUR, atau lainnya) dari metrik penghasilan ditentukan oleh pelokalan untuk mata uang. Jumlahnya dalam mikro. Misalnya, $2,30 akan menjadi yang dinyatakan sebagai 2300.000. Estimasi eCPM rata-rata per grup mediasi dan per tingkat instance sumber iklan didukung mulai 20 Oktober 2019. Estimasi rata-rata pihak ketiga eCPM akan menampilkan 0 untuk tanggal sebelum 20 Oktober 2019.	eCPM rata-rata untuk semua iklan. Satuan mata uang (USD, EUR, atau lainnya) untuk metrik penghasilan ditentukan oleh setelan pelokalan untuk mata uang. eCPM rata-rata per grup mediasi dan per tingkat instance sumber iklan adalah didukung sejak 20 Oktober 2019. OBSERVED_ECPM akan menampilkan 0 untuk tanggal sebelum 20 Oktober 2019.

Scalars

Dimensi di bawah telah diperbarui di Ads Activity Report API menjadi nilai skalar dan bukan objek. Ini akan menyederhanakan respons dan mengurangi kompleksitas performa yang signifikan.

Dimensi yang terpengaruh di Mediation Report API dan Network Report API:

• AD_UNIT
• APP
• AD_SOURCE
• AD_SOURCE_INSTANCE
• MEDIATION_GROUP

Contoh data respons laporan
Format dimensi Mediasi / Jaringan API	"AD_UNIT": { "value":"ca-app-pub-XXXXXXXXXXXXXXXXX/YYYYYYYYYY", "displayLabel": "Test ad unit name" }
Format dimensi AAR API	"AD_UNIT_NAME": "Test ad unit name", "AD_UNIT_ID": "ca-app-pub-XXXXXXXXXXXXXXXXX/YYYYYYYYYY"

Pelaporan per jam

Sekarang Anda dapat melihat performa berdasarkan jam di AdMob API. Pelaporan per jam adalah tersedia hingga 28 hari.

Dimensi TANGGAL juga harus ditentukan dalam permintaan untuk mengambil data per jam layanan otomatis dan data skalabel. Data maksimal 28 hari akan ditampilkan jika dimensi HOUR adalah yang ditentukan. Tanggal mulai rentang tanggal yang lebih besar dari 28 hari sebelum tanggal saat ini menampilkan {i>error<i}.

Poin Penting: Data untuk dua jam terakhir mungkin tidak lengkap.

Ukuran laporan yang lebih besar

Ads Activity Report API memungkinkan Anda mengambil total 500.000 baris. Sebagai informasi tambahan, lihat panduan kuota.

Buat permintaan

Ikuti langkah-langkah berikut untuk membuat permintaan.

curl (baris perintah)

Permintaan yang menggunakan curl

1. Muat file rahasia klien dan buat kredensial otorisasi.

   Saat pertama kali Anda melakukan langkah ini, Anda akan diminta untuk menyetujui prompt otorisasi di browser Anda. Sebelum menerima, pastikan Anda login dengan Akun Google yang memiliki akses ke AdMob API. Nama aplikasi akan diberi otorisasi untuk mengakses data atas nama mana pun akun Anda saat ini masuk.

   Untuk autentikasi dan otorisasi, sebaiknya gunakan oauth2l, alat command line sederhana untuk bekerja dengan Google OAuth 2.0. Instal oauth2l dan jalankan di bawah, mengganti path_to_credentials_json dengan jalur ke file credentials.json yang Anda download saat mendaftarkan aplikasi cloud kita. Untuk proses pertama, perintah memandu Anda melalui alur otorisasi OAuth 2.0. Operasi berikutnya akan memuat ulang token secara otomatis.

   ~/go/bin/oauth2l header --json path_to_credentials_json \
           https://www.googleapis.com/auth/admob.readonly
   

2. Buat laporan aktivitas iklan.

   curl -X POST https://admob.googleapis.com/v1alpha/accounts/pub-XXXXXXXXXXXXXXXX/adsActivityReport:generate \
        -H "Content-Type: application/json" \
        -H "$(~/go/bin/oauth2l header --json path_to_credentials_json https://www.googleapis.com/auth/admob.readonly)"  --data @- << EOF
         {
           "report_spec": {
           "date_range": {
             "start_date": {"year": 2023, "month": 1, "day": 1},
             "end_date": {"year": 2023, "month": 1, "day": 2}
           },
           "dimensions": ["DATE", "HOUR", "MEDIATION_AB_TEST", "VARIANT", "AD_SOURCE_ID", "AD_SOURCE_NAME"],
           "metrics": ["CLICKS", "BID_REQUEST","WINNING_BIDS", "IMPRESSIONS", "ESTIMATED_EARNINGS" ],
           "dimension_filters": [{"dimension": "COUNTRY", "matches_any": {"values": ["US"]}}],
           "sort_conditions": [{"metric":"CLICKS", "order": "DESCENDING"}],
           "localization_settings": {"currency_code": "USD", "language_code": "en-US"}
           }
         }
   EOF
   

   Contoh respons:

   {
   "rows": [
     {
       "dimensionValues": {
         "DATE": {
           "value": "20221102"
         },
         "HOUR": {
           "value": "23"
         },
         "MEDIATION_AB_TEST": {
           "value": "Mediation AB Test"
         },
         "VARIANT": {
           "value": "Variant A"
         },
         "AD_SOURCE_ID": {
           "value": "5450213213286189855"
         },
         "AD_SOURCE_NAME": {
           "value": "AdMob Network"
         }
       },
       "metricValues": {
         "CLICKS": {
           "doubleValue": 0
         },
         "BID_REQUEST": {
           "integerValue": "27"
         },
         "WINNING_BIDS": {
           "doubleValue": 0.1111111111111111
         },
         "IMPRESSIONS": {
           "integerValue": "2"
         },
         "ESTIMATED_EARNINGS": {
           "doubleValue": 0
         }
       }
     },
   {
       "dimensionValues": {
         "DATE": {
           "value": "20221102"
         },
         "HOUR": {
           "value": "23"
         },
         "MEDIATION_AB_TEST": {
           "value": "Mediation AB Test"
         },
         "VARIANT": {
           "value": "Variant B"
         },
         "AD_SOURCE_ID": {
           "value": "5450213213286189855"
         },
         "AD_SOURCE_NAME": {
           "value": "AdMob Network"
         }
       },
       "metricValues": {
         "CLICKS": {
           "doubleValue": 1
         },
         "BID_REQUEST": {
           "integerValue": "6"
         },
         "WINNING_BIDS": {
           "doubleValue": 1
         },
         "IMPRESSIONS": {
           "integerValue": "3"
         },
         "ESTIMATED_EARNINGS": {
           "doubleValue": 0.000427519
         }
       }
     }
   ]}