Method: accounts.adUnits.list

Liệt kê các đơn vị quảng cáo trong tài khoản AdMob được chỉ định.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
parent

string

Bắt buộc. Tên tài nguyên của tài khoản để liệt kê các đơn vị quảng cáo. Ví dụ: accounts/pub-9876543210987654

Tham số truy vấn

Thông số
pageSize

integer

Số lượng đơn vị quảng cáo tối đa cần trả về. Nếu bạn không chỉ định hoặc chỉ định giá trị 0, thì hệ thống sẽ trả về tối đa 10.000 đơn vị quảng cáo. Giá trị tối đa là 20.000; các giá trị trên 20.000 sẽ được chuyển đổi thành 20.000.
pageToken

string

Giá trị được trả về bởi ListAdUnitsResponse gần nhất; giá trị này cho biết đây là phần tiếp theo của lệnh gọi adUnits.list trước đó và hệ thống sẽ trả về trang dữ liệu tiếp theo.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Phản hồi cho yêu cầu danh sách đơn vị quảng cáo.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "adUnits": [
    {
      object (AdUnit)
    }
  ],
  "nextPageToken": string
}
Trường
adUnits[]

object (AdUnit)

Các đơn vị quảng cáo thu được cho tài khoản được yêu cầu.
nextPageToken

string

Nếu giá trị này không trống, thì điều đó có nghĩa là có thể có nhiều đơn vị quảng cáo hơn cho yêu cầu này; khi đó, bạn phải chuyển giá trị này vào trong một ListAdUnitsRequest mới.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.

AdUnit

Mô tả một đơn vị quảng cáo AdMob.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "adUnitId": string,
  "appId": string,
  "displayName": string,
  "adFormat": string,
  "adTypes": [
    string
  ]
}
Trường
name

string

Tên tài nguyên cho đơn vị quảng cáo này. Định dạng là accounts/{publisherId}/adUnits/{ad_unit_id_fragment} Ví dụ: accounts/pub-9876543210987654/adUnits/0123456789
adUnitId

string

Mã nhận dạng hiển thị bên ngoài của đơn vị quảng cáo. Bạn có thể dùng mã này để tích hợp với AdMob SDK. Đây là một thuộc tính chỉ đọc. Ví dụ: ca-app-pub-9876543210987654/0123456789
appId

string

Mã nhận dạng có thể nhìn thấy bên ngoài của ứng dụng mà đơn vị quảng cáo này được liên kết. Ví dụ: ca-app-pub-9876543210987654~0123456789
displayName

string

Tên hiển thị của đơn vị quảng cáo như xuất hiện trong giao diện người dùng AdMob, do người dùng cung cấp. Độ dài tối đa được phép là 80 ký tự.
adFormat

string

AdFormat của đơn vị quảng cáo. Các giá trị có thể là:

"APP_OPEN" – Định dạng quảng cáo khi mở ứng dụng. "BANNER" – Định dạng quảng cáo biểu ngữ. "BANNER_INTERSTITIAL" – Định dạng cũ có thể dùng làm biểu ngữ hoặc quảng cáo xen kẽ. Bạn không thể tạo định dạng này nữa nhưng có thể nhắm đến định dạng này bằng các nhóm dàn xếp. "QUẢNG CÁO KẼ HỞ" – Một quảng cáo toàn màn hình. Các loại quảng cáo được hỗ trợ là "RICH_MEDIA" và "VIDEO". "NATIVE" – Định dạng quảng cáo gốc. "REWARDED" – Một quảng cáo mà sau khi được xem, sẽ nhận được một lệnh gọi lại xác minh lượt xem để có thể tặng thưởng cho người dùng. Các loại quảng cáo được hỗ trợ là "RICH_MEDIA" (tương tác) và video (không thể loại trừ video). "REWARDED_INTERSTITIAL" – Định dạng quảng cáo xen kẽ có tặng thưởng. Chỉ hỗ trợ loại quảng cáo dạng video. Hãy xem https://support.google.com/admob/answer/9884467.
adTypes[]

string

Loại phương tiện quảng cáo được đơn vị quảng cáo này hỗ trợ. Các giá trị có thể có như sau:

"RICH_MEDIA" – Văn bản, hình ảnh và các nội dung nghe nhìn không phải video. "VIDEO" – Nội dung nghe nhìn dạng video.