google.
Không gian tên google.ima cho phép truy cập vào các lớp, giao diện, liệt kê và thuộc tính của SDK.
Lớp
Quảng cáo
Một lớp quảng cáo được mở rộng bằng các lớp đại diện cho nhiều loại quảng cáo.
AdCuePoints
Danh sách điểm dừng thể hiện lịch biểu cho các điểm chèn quảng cáo. Xin lưu ý rằng các quảng cáo riêng lẻ trong điểm chèn quảng cáo không có trong lịch biểu.
AdDisplayContainer
Lớp này đại diện cho một vùng chứa để hiển thị quảng cáo. SDK sẽ tự động tạo các cấu trúc bên trong thông số containerElement để chứa quảng cáo video và quảng cáo lớp phủ.
Khi một thực thể của lớp này được tạo, thực thể này sẽ tạo một IFRAME trong vùng chứa phần tử và tải lõi SDK. IFRAME này phải được giữ nguyên để SDK hoạt động bình thường. Sau khi tất cả quảng cáo đã được phát
và SDK không còn cần thiết nữa, hãy sử dụng phương thức destroy()
để gỡ tải SDK.
Thông số chứa phần tử phải là một phần tử thuộc DOM. Cần phải định vị chính xác vùng chứa phần tử để quảng cáo hiển thị đúng. Bạn nên đặt nút này lên trên trình phát video nội dung và đặt kích thước cho toàn bộ trình phát video. Hãy tham khảo tài liệu về SDK để biết thông tin chi tiết về các phương thức triển khai được đề xuất.
Lưu ý: Luôn cần gọi phương thức initialize() trong mã được gọi trực tiếp bằng một hành động của người dùng (chẳng hạn như nhấp hoặc nhấn).
Lỗi quảng cáo
AdError hiển thị thông tin cho người dùng về việc liệu có xảy ra lỗi trong khi tải hoặc phát quảng cáo hay không. Trình truy cập errorType cung cấp thông tin về lỗi xảy ra trong quá trình tải quảng cáo hay phát quảng cáo.
Sự kiện lỗi
Sự kiện này được nêu ra khi xảy ra lỗi khi tải quảng cáo từ các máy chủ của Google hoặc DoubleClick. Bạn có thể đăng ký các loại sự kiện này trên AdsLoader và AdsManager.
Sự kiện quảng cáo
Quảng cáo này sẽ hiển thị loại sự kiện này dưới dạng thông báo khi trạng thái quảng cáo thay đổi và khi người dùng tương tác với quảng cáo. Ví dụ: khi quảng cáo bắt đầu phát, được nhấp vào và nhiều thông tin khác. Bạn có thể đăng ký các sự kiện khác nhau đã thay đổi trạng thái trên AdsManager.
Sự kiện siêu dữ liệu quảng cáo
Lớp này không còn được dùng nữa. Sử dụng API AdsManager.getCuePoints(). Một sự kiện quảng cáo cụ thể mang siêu dữ liệu.
AdPodInfo
Quảng cáo có thể là một phần của một nhóm quảng cáo. Đối tượng này hiển thị siêu dữ liệu liên quan đến nhóm đó, chẳng hạn như số lượng quảng cáo trong nhóm và vị trí quảng cáo trong nhóm.
API getTotalAds có trong đối tượng này thường
chính xác, nhưng trong một số trường hợp nhất định, API này đại diện cho dự đoán tốt nhất của SDK. Hãy xem
tài liệu của phương thức đó để biết thêm thông tin.
Dữ liệu tiến trình quảng cáo
Đối tượng này hiển thị thông tin về tiến trình hiện tại khi một quảng cáo đang phát.
Trình tải quảng cáo
AdsLoader cho phép khách hàng yêu cầu quảng cáo từ máy chủ quảng cáo. Để làm như vậy, người dùng phải đăng ký sự kiện AdsManagerLoadedEvent rồi yêu cầu quảng cáo.
Trình quản lý quảng cáo
Cung cấp API công khai bên ngoài cho nhà xuất bản và giao tiếp với phiên bản bên trong của trình quản lý quảng cáo.
Sự kiện AdsManagerLoadedEvent
Sự kiện này được nâng lên khi quảng cáo được tải thành công từ máy chủ quảng cáo Google hoặc DoubleClick thông qua AdsLoader. Bạn có thể đăng ký tham gia sự kiện này trên AdsLoader.
Cài đặt kết xuất quảng cáo
Xác định các thông số kiểm soát việc hiển thị quảng cáo.
Yêu cầu quảng cáo
Một lớp chỉ định các thuộc tính của yêu cầu quảng cáo.
Quảng cáo đồng hành
Đại diện cho quảng cáo đồng hành.
Cài đặt quảng cáo đồng hành
Bạn dùng đối tượng companionAdSelectionSettings để xác định tiêu chí lựa chọn khi gọi hàm ima.Ad.getCompanionAds.
Cài đặt ImaSdk
Lớp này chứa các chế độ cài đặt trên toàn SDK.
UniversalAdIdInfo
Đối tượng này hiển thị thông tin về mã quảng cáo chung liên kết với quảng cáo, bao gồm cả giá trị mã quảng cáo và sổ đăng ký mã quảng cáo.
Bảng liệt kê
Chế độ truy cập Omid
chuỗi
Các chế độ truy cập hiện có dành cho OMID cho web. Chế độ này kiểm soát mức độ truy cập vào tập lệnh xác minh.
Giá trị |
|
|---|---|
|
GIỚI HẠN |
Tập lệnh xác minh có dạng hộp cát và không thể truy cập vào trang mẫu quảng cáo hoặc trang nhà xuất bản cũng như không thể trực tiếp xác nhận miền của nhà xuất bản đang hiển thị. |
|
TÊN MIỀN |
Tập lệnh xác minh có dạng hộp cát và không thể truy cập vào tệp sáng tạo hoặc trang của nhà xuất bản. Tuy nhiên, tập lệnh được tải theo cách có thể trực tiếp xác nhận miền của nhà xuất bản đang hiển thị. |
|
ĐẦY |
Tập lệnh xác minh có quyền truy cập trực tiếp vào tệp sáng tạo và trang của nhà xuất bản. |
Nhà cung cấp dịch vụ xác minh Omid
số
Xác định nhà cung cấp dịch vụ xác minh OMID. Các nhà cung cấp được liệt kê theo thứ tự bảng chữ cái.
Giá trị |
|
|---|---|
|
Hàm COMSCORE |
|
|
Xác minh DOUBLE |
|
|
|
|
|
TÍCH HỢP_QUẢNG CÁO |
|
|
Hàm MEETRICS |
|
|
MOAT |
|
|
Hàm NIELSEN |
|
|
PIXELATE |
|
|
KHÁC |
Nhà cung cấp mặc định sẽ sử dụng khi URL của tập lệnh không khớp với bất kỳ nhà cung cấp nào khác. |
Phần tử UiElement
chuỗi
Liệt kê các phần tử giao diện người dùng khác nhau có thể được định cấu hình để hiển thị hoặc bị ẩn. Các tùy chọn cài đặt này có thể bị bỏ qua đối với quảng cáo AdSense và ADX.
Giá trị |
|
|---|---|
|
THUỘC TÍNH QUẢNG CÁO |
Hiển thị văn bản "Quảng cáo" trong giao diện người dùng quảng cáo. Phải có mặt để hiển thị đồng hồ đếm ngược. |
|
COUNTDOWN |
Cần có thuộc tính quảng cáo để hiển thị đồng hồ đếm ngược. Cả |
Chế độ xem
chuỗi
Liệt kê các chế độ xem VPAID khác nhau cho quảng cáo.
Giá trị |
|
|---|---|
|
BÌNH THƯỜNG |
Chế độ xem quảng cáo bình thường. |
|
MÀN HÌNH ĐẦY ĐỦ |
Chế độ xem quảng cáo toàn màn hình. Cho người quản lý quảng cáo biết rằng nhà xuất bản xem cách sắp xếp AdDisplayContainer hiện tại là toàn màn hình (ví dụ: chế độ toàn màn hình). Điều này không khiến trình quản lý quảng cáo chuyển sang chế độ toàn màn hình. |
- Không được dùng nữa
Thuộc tính
Chế độ truy cập Omid
chuỗi
Các chế độ truy cập hiện có dành cho OMID cho web. Chế độ này kiểm soát mức độ truy cập vào tập lệnh xác minh.
Giá trị |
|
|---|---|
|
GIỚI HẠN |
Tập lệnh xác minh có dạng hộp cát và không thể truy cập vào trang mẫu quảng cáo hoặc trang nhà xuất bản cũng như không thể trực tiếp xác nhận miền của nhà xuất bản đang hiển thị. |
|
TÊN MIỀN |
Tập lệnh xác minh có dạng hộp cát và không thể truy cập vào tệp sáng tạo hoặc trang của nhà xuất bản. Tuy nhiên, tập lệnh được tải theo cách có thể trực tiếp xác nhận miền của nhà xuất bản đang hiển thị. |
|
ĐẦY |
Tập lệnh xác minh có quyền truy cập trực tiếp vào tệp sáng tạo và trang của nhà xuất bản. |
Nhà cung cấp dịch vụ xác minh Omid
số
Xác định nhà cung cấp dịch vụ xác minh OMID. Các nhà cung cấp được liệt kê theo thứ tự bảng chữ cái.
Giá trị |
|
|---|---|
|
Hàm COMSCORE |
|
|
Xác minh DOUBLE |
|
|
|
|
|
TÍCH HỢP_QUẢNG CÁO |
|
|
Hàm MEETRICS |
|
|
MOAT |
|
|
Hàm NIELSEN |
|
|
PIXELATE |
|
|
KHÁC |
Nhà cung cấp mặc định sẽ sử dụng khi URL của tập lệnh không khớp với bất kỳ nhà cung cấp nào khác. |
Phần tử UiElement
chuỗi
Liệt kê các phần tử giao diện người dùng khác nhau có thể được định cấu hình để hiển thị hoặc bị ẩn. Các tùy chọn cài đặt này có thể bị bỏ qua đối với quảng cáo AdSense và ADX.
Giá trị |
|
|---|---|
|
THUỘC TÍNH QUẢNG CÁO |
Hiển thị văn bản "Quảng cáo" trong giao diện người dùng quảng cáo. Phải có mặt để hiển thị đồng hồ đếm ngược. |
|
COUNTDOWN |
Cần có thuộc tính quảng cáo để hiển thị đồng hồ đếm ngược. Cả |
Chế độ xem
chuỗi
Liệt kê các chế độ xem VPAID khác nhau cho quảng cáo.
Giá trị |
|
|---|---|
|
BÌNH THƯỜNG |
Chế độ xem quảng cáo bình thường. |
|
MÀN HÌNH ĐẦY ĐỦ |
Chế độ xem quảng cáo toàn màn hình. Cho người quản lý quảng cáo biết rằng nhà xuất bản xem cách sắp xếp AdDisplayContainer hiện tại là toàn màn hình (ví dụ: chế độ toàn màn hình). Điều này không khiến trình quản lý quảng cáo chuyển sang chế độ toàn màn hình. |
- Không được dùng nữa
cài đặt
Cài đặt ImaSdk không rỗng
Phiên bản cài đặt singleton toàn cầu.