Method: accounts.adUnits.list

Cantumkan unit iklan dalam akun AdMob yang ditentukan.

Permintaan HTTP

GET https://admob.googleapis.com/v1/{parent=accounts/*}/adUnits

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama resource akun untuk mencantumkan unit iklan. Contoh: accounts/pub-9876543210987654

Parameter kueri

Parameter
pageSize

integer

Jumlah maksimum unit iklan yang akan ditampilkan. Jika nilai tidak ditentukan atau 0, maksimal 10.000 unit iklan akan ditampilkan. Nilai maksimum adalah 20.000; nilai di atas 20.000 akan dikonversi menjadi 20.000.

pageToken

string

Nilai yang ditampilkan oleh ListAdUnitsResponse terakhir; menunjukkan bahwa ini merupakan kelanjutan dari panggilan adUnits.list sebelumnya, dan sistem harus menampilkan halaman data berikutnya.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons untuk permintaan daftar unit iklan.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "adUnits": [
    {
      object (AdUnit)
    }
  ],
  "nextPageToken": string
}
Kolom
adUnits[]

object (AdUnit)

Unit iklan yang dihasilkan untuk akun yang diminta.

nextPageToken

string

Jika tidak kosong, menunjukkan bahwa mungkin ada lebih banyak unit iklan untuk permintaan; nilai ini harus diteruskan dalam ListAdUnitsRequest baru.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/admob.readonly

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

AdUnit

Menjelaskan unit iklan AdMob.

Representasi JSON
{
  "name": string,
  "adUnitId": string,
  "appId": string,
  "displayName": string,
  "adFormat": string,
  "adTypes": [
    string
  ]
}
Kolom
name

string

Nama aset untuk unit iklan ini. Formatnya adalah accounts/{publisherId}/adUnits/{ad_unit_id_fragment} Contoh: accounts/pub-9876543210987654/adUnits/0123456789

adUnitId

string

ID unit iklan yang terlihat secara eksternal yang dapat digunakan untuk berintegrasi dengan SDK AdMob. Ini adalah properti hanya baca. Contoh: ca-app-pub-9876543210987654/0123456789

appId

string

ID aplikasi yang terlihat secara eksternal untuk aplikasi yang dikaitkan dengan unit iklan ini. Contoh: ca-app-pub-9876543210987654~0123456789

displayName

string

Nama tampilan unit iklan seperti yang ditampilkan di UI AdMob, yang diberikan oleh pengguna. Panjang maksimum yang diizinkan adalah 80 karakter.

adFormat

string

AdFormat unit iklan. Kemungkinan nilainya adalah sebagai berikut:

"APP_OPEN" - Format iklan di Layar Pembuka Aplikasi. "BANNER" - Format iklan banner. "BANNER_INTERSTITIAL" - Format lama yang dapat digunakan sebagai banner atau interstisial. Format ini tidak dapat dibuat lagi tetapi dapat ditargetkan oleh grup mediasi. "INTERSTITIAL" - Iklan layar penuh. Jenis iklan yang didukung adalah "RICH_MEDIA" dan "VIDEO". "NATIVE" - Format iklan native. "REWARDED" - Iklan yang, setelah dilihat, akan mendapatkan callback yang memverifikasi tampilan sehingga reward dapat diberikan kepada pengguna. Jenis iklan yang didukung adalah "RICH_MEDIA" (interaktif) dan video yang tidak dapat mengecualikan video. "REWARDED_INTERSTITIAL" - Format iklan Interstisial Reward. Hanya mendukung jenis iklan video. Lihat https://support.google.com/admob/answer/9884467.

adTypes[]

string

Jenis media iklan yang didukung oleh unit iklan ini. Nilai yang memungkinkan sebagai berikut:

"RICH_MEDIA" - Teks, gambar, dan media non-video lainnya. "VIDEO" - Media video.