Method: accounts.campaignReport.generate

Menghasilkan Laporan Kampanye berdasarkan spesifikasi yang diberikan.

Permintaan HTTP

POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/campaignReport:generate

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Nama resource akun yang laporannya akan dihasilkan. Contoh: accounts/pub-9876543210987654

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "reportSpec": {
    object (CampaignReportSpec)
  }
}
Kolom
reportSpec

object (CampaignReportSpec)

Spesifikasi laporan kampanye.

Isi respons

Respons Campaign Report API.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "rows": [
    {
      object (ReportRow)
    }
  ]
}
Kolom
rows[]

object (ReportRow)

Data laporan kampanye dari penayang yang ditentukan. Maksimal 100.000 baris akan ditampilkan dari API.

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.

CampaignReportSpec

Spesifikasi untuk membuat laporan Kampanye. Misalnya, spesifikasi untuk mendapatkan IMPRESSIONS dan CLICKS yang dikelompokkan menurut CAMPAIGN_ID dapat terlihat seperti contoh berikut:

{
  "dateRange": {
    "startDate": {"year": 2021, "month": 12, "day": 1},
    "endDate": {"year": 2021, "month": 12, "day": 30}
  },
  "dimensions": ["CAMPAIGN_ID"],
  "metrics": ["IMPRESSIONS", "CLICKS"],
}
Representasi JSON
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "languageCode": string
}
Kolom
dateRange

object (DateRange)

Rentang tanggal pembuatan laporan. Rentang maksimum adalah 30 hari.

dimensions[]

enum (Dimension)

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[]

enum (Metric)

Daftar metrik laporan. Laporan harus mencantumkan setidaknya satu metrik.

languageCode

string

Bahasa yang digunakan untuk teks yang dilokalkan, seperti nilai dimensi tertentu yang berlaku. Tag bahasa ditentukan dalam IETF BCP47. Nilai defaultnya adalah 'en-US' jika tidak ditentukan atau tidak valid.

Dimensi

Dimensi laporan kampanye.

Enum
DIMENSION_UNSPECIFIED Nilai default dimensi yang belum ditentukan. Jangan gunakan.
DATE Tanggal dalam format YYYYMMDD (misalnya, "20210701").
CAMPAIGN_ID ID unik kampanye, misalnya "123456789", yang konsisten dengan ID kampanye dari API daftar kampanye.
CAMPAIGN_NAME Nama kampanye.
AD_ID ID unik iklan, misalnya "123456789".
AD_NAME Nama iklan, yang tidak boleh unik.
PLACEMENT_ID ID unik khusus vendor dari aplikasi tempat iklan ditempatkan. Misalnya, com.goog.bar untuk Android dan 123456789 untuk aplikasi iOS.
PLACEMENT_NAME Nama aplikasi tempat iklan ditempatkan.
PLACEMENT_PLATFORM Platform aplikasi tempat iklan ditempatkan.
COUNTRY Nama negara yang ditargetkan.
FORMAT Format unit iklan (misalnya, "banner", "native"), dimensi penayangan iklan.

Metrik

Metrik laporan kampanye.

Enum
METRIC_UNSPECIFIED Nilai default untuk kolom yang tidak ditetapkan. Jangan gunakan.
IMPRESSIONS Frekuensi iklan ditampilkan kepada pengguna.
CLICKS Frekuensi pengguna mengklik iklan.
CLICK_THROUGH_RATE Jumlah klik yang diterima iklan dibagi dengan frekuensi iklan ditampilkan.
INSTALLS Frekuensi aplikasi didownload ke perangkat.
ESTIMATED_COST Estimasi biaya penayangan iklan kampanye, bukan iklan yang menghasilkan pendapatan. Mata uang ini adalah mata uang pelaporan untuk kampanye.
AVERAGE_CPI Biaya-per-instal rata-rata. Ini berarti jumlah rata-rata yang dibelanjakan untuk mengakuisisi pengguna baru. Mata uang ini adalah mata uang pelaporan untuk kampanye.
INTERACTIONS Frekuensi pengguna berinteraksi dengan iklan. Metrik ini terdiri dari klik dan engagement.