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ê đơn vị quảng cáo. Ví dụ: accounts/pub-9876543210987654

Tham số truy vấn

Tham số
pageSize

integer

Số đơn vị quảng cáo tối đa cần trả về. Nếu bạn không chỉ định hoặc đặt giá trị là 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; nếu trên 20.000 thì bị buộc thành 20.000.
pageToken

string

Giá trị được ListAdUnitsResponse gần đây nhất trả về; 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)

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

string

Nếu không trống, điều này cho biết rằng có thể có nhiều đơn vị quảng cáo hơn cho yêu cầu; giá trị này phải được truyền trong 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 bài viết Tổng quan về OAuth 2.0.

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ã hiển thị bên ngoài của đơn vị quảng cáo có thể được dùng để tích hợp với AdMob SDK. Đây là tài sản chỉ có thể đọc. Ví dụ: ca-app-pub-9876543210987654/0123456789
appId

string

Mã hiển thị bên ngoài của ứng dụng liên kết với đơn vị quảng cáo này. Ví dụ: ca-app-pub-9876543210987654~0123456789
displayName

string

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

string

Định dạng quảng cáo của đơn vị quảng cáo. Các giá trị có thể có như sau:

"APP_OPEN" – Định dạng quảng cáo khi mở ứng dụng. "BIỂU NGỮ" – Định dạng quảng cáo biểu ngữ. "BANNER_INTERSTITIAL" - Định dạng cũ có thể được sử 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 mục tiêu theo nhóm dàn xếp. "XEN KẼ" – Quảng cáo toàn màn hình. Các loại quảng cáo được hỗ trợ là "MULTI_MEDIA" và "VIDEO". "GỐC" – Định dạng quảng cáo gốc. "ĐƯỢC TẶNG THƯỞNG" - Sau khi được xem, quảng cáo sẽ nhận được lệnh gọi lại xác minh lượt xem để có thể trao phần thưởng cho người dùng. Các loại quảng cáo được hỗ trợ là "MULTI_MEDIA" (tương tác) và video trong đó 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ó thể sử dụng các giá trị sau:

"Đa phương tiện" – Văn bản, hình ảnh và các phương tiện khác không phải video. "VIDEO" – Phương tiện video.