- Permintaan HTTP
- Parameter lokasi
- Isi permintaan
- Isi respons
- Cakupan otorisasi
- NetworkReportSpec
- Dimensi
- Metrik
- DimensionFilter
- SortCondition
- Contoh
- Cobalah!
Membuat laporan Jaringan AdMob berdasarkan spesifikasi laporan yang diberikan. Menampilkan hasil RPC streaming sisi server. Hasilnya ditampilkan dalam urutan respons.
Permintaan HTTP
POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/networkReport:generate
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
parent |
Nama resource akun yang laporannya akan dibuat. Contoh: accounts/pub-9876543210987654 |
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{
"reportSpec": {
object ( |
Kolom | |
---|---|
reportSpec |
Spesifikasi laporan jaringan. |
Isi respons
Respons streaming untuk laporan Jaringan AdMob dengan respons pertama berisi header laporan, lalu aliran respons baris, dan terakhir footer sebagai pesan respons terakhir.
Contoh:
[{
"header": {
"dateRange": {
"startDate": {"year": 2018, "month": 9, "day": 1},
"endDate": {"year": 2018, "month": 9, "day": 1}
},
"localizationSettings": {
"currencyCode": "USD",
"languageCode": "en-US"
}
}
},
{
"row": {
"dimensionValues": {
"DATE": {"value": "20180918"},
"APP": {
"value": "ca-app-pub-8123415297019784~1001342552",
displayLabel: "My app name!"
}
},
"metricValues": {
"ESTIMATED_EARNINGS": {"microsValue": 6500000}
}
}
},
{
"footer": {"matchingRowCount": 1}
}]
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union payload . Setiap pesan respons streaming berisi satu jenis payload. payload hanya ada berupa salah satu diantara berikut: |
|
header |
Setelan pembuatan laporan yang mendeskripsikan konten laporan, seperti rentang tanggal laporan dan setelan pelokalan. |
row |
Data laporan aktual. |
footer |
Informasi tambahan tentang laporan yang dihasilkan, seperti peringatan tentang data. |
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/admob.readonly
https://www.googleapis.com/auth/admob.report
Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
NetworkReportSpec
Spesifikasi untuk membuat laporan Jaringan AdMob. Misalnya, spesifikasi untuk mendapatkan klik dan estimasi penghasilan hanya untuk negara 'US' dan 'CN' dapat terlihat seperti contoh berikut:
{
'dateRange': {
'startDate': {'year': 2021, 'month': 9, 'day': 1},
'endDate': {'year': 2021, 'month': 9, 'day': 30}
},
'dimensions': ['DATE', 'APP', 'COUNTRY'],
'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'],
'dimensionFilters': [
{
'dimension': 'COUNTRY',
'matchesAny': {'values': [{'value': 'US', 'value': 'CN'}]}
}
],
'sortConditions': [
{'dimension':'APP', order: 'ASCENDING'},
{'metric':'CLICKS', order: 'DESCENDING'}
],
'localizationSettings': {
'currencyCode': 'USD',
'languageCode': 'en-US'
}
}
Untuk mendapatkan pemahaman yang lebih baik, Anda dapat memperlakukan spesifikasi sebelumnya seperti pseudo SQL berikut:
SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS
FROM NETWORK_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
AND COUNTRY IN ('US', 'CN')
GROUP BY DATE, APP, COUNTRY
ORDER BY APP ASC, CLICKS DESC;
Representasi JSON |
---|
{ "dateRange": { object ( |
Kolom | |
---|---|
dateRange |
Rentang tanggal pembuatan laporan. |
dimensions[] |
Daftar dimensi laporan. Kombinasi nilai dimensi ini menentukan baris laporan. Jika tidak ada dimensi yang ditentukan, laporan akan menampilkan satu baris metrik yang diminta untuk seluruh akun. |
metrics[] |
Daftar metrik laporan. Laporan harus mencantumkan setidaknya satu metrik. |
dimensionFilters[] |
Menjelaskan baris laporan yang akan dicocokkan berdasarkan nilai dimensinya. |
sortConditions[] |
Menjelaskan pengurutan baris laporan. Urutan kondisi dalam daftar menentukan prioritasnya; semakin awal kondisi, semakin tinggi prioritasnya. Jika tidak ada kondisi pengurutan yang ditentukan, pengurutan baris tidak ditentukan. |
localizationSettings |
Setelan pelokalan laporan. |
maxReportRows |
Jumlah maksimum baris data laporan yang akan ditampilkan. Jika nilai tidak disetel, API akan menampilkan baris sebanyak mungkin, hingga 100.000. Nilai yang dapat diterima adalah 1-100000, inklusif. Nilai yang lebih besar dari 100.000 akan menampilkan error. |
timeZone |
Zona waktu laporan. Menerima nilai nama IANA TZ, seperti "America/Los_Angeles". Jika zona waktu tidak ditentukan, setelan default akun akan diterapkan. Periksa nilai default dengan tindakan get account. Peringatan: "America/Los_Angeles" adalah satu-satunya nilai yang didukung saat ini. |
Dimensi
Dimensi laporan jaringan. Dimensi adalah atribut data untuk menguraikan atau menyempurnakan pengukuran kuantitatif (metrik) dengan atribut tertentu, seperti format iklan atau platform tempat iklan dilihat.
Enum | |
---|---|
DIMENSION_UNSPECIFIED |
Nilai default untuk kolom yang tidak ditetapkan. Jangan gunakan. |
DATE |
Tanggal dalam format YYYYMMDD (misalnya, "20210701"). Permintaan dapat menentukan maksimal satu dimensi waktu. |
MONTH |
Bulan dalam format YYYYMM (misalnya, "202107"). Permintaan dapat menentukan maksimal satu dimensi waktu. |
WEEK |
Tanggal hari pertama dalam seminggu dalam format YYYYMMDD (misalnya, "20210701"). Permintaan dapat menentukan maksimal satu dimensi waktu. |
AD_UNIT |
ID unik unit iklan (misalnya, "ca-app-pub-1234/1234"). Jika dimensi AD_UNIT ditentukan, APP akan otomatis disertakan. |
APP |
ID unik aplikasi seluler (misalnya, "ca-app-pub-1234~1234"). |
AD_TYPE |
Jenis iklan (misalnya, "teks" atau "gambar"), dimensi penayangan iklan. Peringatan: Dimensi ini tidak kompatibel dengan metrik AD_REQUESTS, MATCH_RATE, dan IMPRESSION_RPM. |
COUNTRY |
Kode negara CLDR tempat penayangan/klik iklan terjadi (misalnya, "US" atau "FR"). Ini adalah dimensi geografi. |
FORMAT |
Format unit iklan (misalnya, "banner", "native"), dimensi penayangan iklan. |
PLATFORM |
Platform OS seluler aplikasi (misalnya, "Android" atau "iOS"). |
MOBILE_OS_VERSION |
Versi sistem operasi seluler, misalnya "iOS 13.5.1". |
GMA_SDK_VERSION |
Versi GMA SDK, misalnya "iOS 7.62.0". |
APP_VERSION_NAME |
Untuk Android, nama versi aplikasi dapat ditemukan di versionName dalam PackageInfo. Untuk iOS, nama versi aplikasi dapat ditemukan di CFBundleShortVersionString. |
SERVING_RESTRICTION |
Mode pembatasan untuk penayangan iklan (misalnya, "Iklan yang tidak dipersonalisasi"). |
Metrik
Metrik laporan jaringan. Metrik merupakan pengukuran kuantitatif yang menunjukkan performa bisnis penayang. Metrik ini digabungkan dari masing-masing peristiwa iklan dan dikelompokkan menurut dimensi laporan. Nilai metrik dapat berupa bilangan bulat atau desimal (tanpa pembulatan).
Enum | |
---|---|
METRIC_UNSPECIFIED |
Nilai default untuk kolom yang tidak ditetapkan. Jangan gunakan. |
AD_REQUESTS |
Jumlah permintaan iklan. Nilainya berupa bilangan bulat. Peringatan: Metrik tidak kompatibel dengan dimensi AD_TYPE. |
CLICKS |
Frekuensi pengguna mengklik iklan. Nilainya berupa bilangan bulat. |
ESTIMATED_EARNINGS |
Estimasi penghasilan penayang AdMob. Unit mata uang (USD, EUR, atau lainnya) dari metrik penghasilan ditentukan oleh setelan pelokalan untuk mata uang. Jumlahnya dalam mikro. Misalnya, Rp65.000 akan direpresentasikan sebagai 6.500.000. |
IMPRESSIONS |
Total jumlah iklan yang ditampilkan kepada pengguna. Nilainya berupa bilangan bulat. |
IMPRESSION_CTR |
Rasio klik terhadap tayangan. Nilainya adalah nilai desimal dengan presisi ganda (perkiraan). |
IMPRESSION_RPM |
Estimasi penghasilan per seribu tayangan iklan. Nilainya dalam mikro. Misalnya, $1,03 akan direpresentasikan sebagai 1030000. Setara dengan eCPM di UI AdMob. Peringatan: Metrik tidak kompatibel dengan dimensi AD_TYPE. |
MATCHED_REQUESTS |
Frekuensi iklan ditampilkan sebagai tanggapan atas permintaan. Nilainya berupa bilangan bulat. |
MATCH_RATE |
Rasio permintaan iklan yang cocok terhadap total permintaan iklan. Nilainya adalah nilai desimal dengan presisi ganda (perkiraan). Peringatan: Metrik tidak kompatibel dengan dimensi AD_TYPE. |
SHOW_RATE |
Rasio iklan yang ditampilkan di atas iklan yang dihasilkan, yang didefinisikan sebagai tayangan / permintaan yang sesuai. Nilainya adalah nilai desimal dengan presisi ganda (perkiraan). |
DimensionFilter
Menjelaskan baris laporan yang akan dicocokkan berdasarkan nilai dimensinya.
Representasi JSON |
---|
{ "dimension": enum ( |
Kolom | |
---|---|
dimension |
Menerapkan kriteria filter ke dimensi yang ditentukan. |
Kolom union operator . Operator filter yang akan diterapkan. operator hanya ada berupa salah satu diantara berikut: |
|
matchesAny |
Mencocokkan baris jika nilai untuk dimensi yang ditentukan berada dalam salah satu nilai yang ditentukan dalam kondisi ini. |
SortCondition
Arah pengurutan yang akan diterapkan pada dimensi atau metrik.
Representasi JSON |
---|
{ "order": enum ( |
Kolom | |
---|---|
order |
Urutan pengurutan dimensi atau metrik. |
Kolom union sort_on . Mengidentifikasi nilai mana yang akan diurutkan. sort_on hanya ada berupa salah satu diantara berikut: |
|
dimension |
Mengurutkan berdasarkan dimensi yang ditentukan. |
metric |
Mengurutkan berdasarkan metrik yang ditentukan. |