Trang này được dịch bởi Cloud Translation API.

Loại: Quảng cáo

Phương thức

getAdId

getAdId() trả về chuỗi

ID quảng cáo được sử dụng để đồng bộ hóa quảng cáo chính và quảng cáo đồng hành.

Trả về: string Mã nhận dạng của quảng cáo hoặc chuỗi trống nếu không có thông tin này.

getAdPodInfo

getAdPodInfo() trả về AdPodInfo

Trả về thông tin nhóm của quảng cáo.

Trả về: non-null AdPodInfo Thông tin nhóm của quảng cáo.

getAdSystem

getAdSystem() trả về chuỗi

Thông tin máy chủ quảng cáo nguồn có trong phản hồi quảng cáo.

Trả về: string Máy chủ quảng cáo nguồn của quảng cáo hoặc chuỗi trống nếu không có thông tin này.

getAdvertiserName

getAdvertiserName() trả về chuỗi

Tên nhà quảng cáo như được xác định bởi bên phân phát.

Trả về: string Tên nhà quảng cáo hoặc chuỗi trống nếu không có thông tin này.

Khung getApi

getApiFramework() trả về chuỗi

Xác định API cần thiết để thực thi quảng cáo. Điều này tương ứng với apiFramework được chỉ định trong vast.

Trả về: nullable string Khung API cần thực thi quảng cáo, hoặc rỗng nếu không có thông tin này.

quảng cáo đồng hành

getCompanionAds(adSlotWidth, adSlotHeight, settings) trả về Mảng Quảng cáo đồng hành có giá trị không rỗng

Nhận quảng cáo đồng hành cho quảng cáo này dựa trên kích thước vùng quảng cáo đồng hành. Tùy chọn cài đặt lựa chọn nâng cao được chấp nhận. Lưu ý rằng phương thức này sẽ chỉ trả về mảng không trống cho các phiên bản quảng cáo có được vào hoặc sau sự kiện STARTED. Cụ thể, quảng cáo từ sự kiện LOADED sẽ trả về một mảng trống.

Thông số
Chiều rộng vùng quảng cáo	số Chiều rộng của thời điểm quảng cáo đồng hành.
Chiều cao quảng cáo	số Chiều cao của vùng quảng cáo đồng hành.
cài đặt	Không bắt buộc Cài đặt quảng cáo đồng hành Chế độ cài đặt lựa chọn cho quảng cáo đồng hành. Giá trị không được rỗng.

Thông số

Chiều rộng vùng quảng cáo

số

Chiều rộng của thời điểm quảng cáo đồng hành.

Chiều cao quảng cáo

số

Chiều cao của vùng quảng cáo đồng hành.

cài đặt

Không bắt buộc

Cài đặt quảng cáo đồng hành

Chế độ cài đặt lựa chọn cho quảng cáo đồng hành.

Giá trị không được rỗng.

Trả về: non-null Array of non-null CompanionAd Mảng quảng cáo đồng hành phù hợp với chế độ cài đặt và kích thước vùng quảng cáo.

loại nội dung

getContentType() trả về chuỗi

Trả về loại nội dung của mẫu quảng cáo hiện được chọn hoặc chuỗi trống nếu không có mẫu quảng cáo nào được chọn hoặc loại nội dung không có sẵn. Đối với quảng cáo tuyến tính, loại nội dung sẽ chỉ có sẵn sau sự kiện START, khi tệp nội dung nghe nhìn được chọn.

Trả về: string Loại nội dung, chuỗi trống nếu không có.

getCreativeAdId

getCreativeAdId() trả về chuỗi

Trả về mã ISCI (Mã số nhận dạng thương mại tiêu chuẩn ngành) cho một quảng cáo hoặc chuỗi trống nếu không có mã. Đây là ID quảng cáo của quảng cáo trong phản hồi VAST.

Trả về: string

Nhận getCreativeId

getCreativeId() trả về chuỗi

Truy lục ID của quảng cáo đã chọn cho quảng cáo.

Trả về: string Mã của tệp sáng tạo đã chọn cho quảng cáo hoặc chuỗi trống nếu không có thông tin này.

Nhận mã thỏa thuận

getDealId() trả về chuỗi

Trả về mã giao dịch đầu tiên có trong chuỗi trình bao bọc cho quảng cáo hiện tại, bắt đầu từ đầu. Trả về chuỗi trống nếu không có sẵn.

Trả về: string

Nhận mô tả

getDescription() trả về chuỗi

Trả về mô tả của quảng cáo này từ phản hồi VAST.

Trả về: string Mô tả này trống nếu không được chỉ định.

Nhận Thời lượng

getDuration() trả về số

Trả về thời lượng của quảng cáo đã chọn hoặc -1 đối với quảng cáo phi tuyến tính.

Trả về: number Thời lượng quảng cáo đã chọn tính bằng giây, -1 nếu phi tuyến tính.

getHeight

getHeight() trả về số

Trả về chiều cao của quảng cáo phi tuyến tính đã chọn.

Trả về: number Chiều cao của mẫu quảng cáo phi tuyến tính đã chọn hoặc bằng 0 đối với mẫu quảng cáo tuyến tính.

Nhận url phương tiện

getMediaUrl() trả về chuỗi

Trả về URL của tệp nội dung nghe nhìn đã chọn từ quảng cáo dựa trên các tùy chọn cài đặt nội dung nghe nhìn hiện đang sử dụng. Trả về giá trị rỗng nếu không có thông tin này. Có sẵn cho sự kiện STARTED.

Trả về: nullable string

getMin đềThời lượng

getMin đềDuration() trả về số

Trả về thời lượng đề xuất tối thiểu tính bằng giây mà quảng cáo phi tuyến tính sẽ được hiển thị. Trả về -2 nếu không xác định được thời lượng đề xuất tối thiểu. Đối với mẫu quảng cáo tuyến tính, mẫu này trả về toàn bộ thời lượng của quảng cáo.

Trả về: number Thời lượng đề xuất tối thiểu tính bằng giây mà quảng cáo sẽ hiển thị.

getskipTimeOffset

getskipTimeOffset() trả về số

Số giây phát lại trước khi quảng cáo có thể bỏ qua. -1 được trả về cho quảng cáo không thể bỏ qua hoặc nếu không có kết quả này.

Trả về: number Chênh lệch tính bằng giây hoặc -1.

UrlCuộc khảo sát

getSurveyUrl() trả về chuỗi

Trả về URL được liên kết với bản khảo sát cho quảng cáo đã cho. Trả về giá trị rỗng nếu không có sẵn.

Trả về: nullable string

getTitle

getTitle() trả về chuỗi

Trả về tiêu đề của quảng cáo này từ phản hồi VAST.

Trả về: string Tiêu đề trống nếu không được chỉ định.

getTraffickingParameters

getTraffickingParameters() trả về Đối tượng có các thuộc tính chuỗi

Xem các thông số tùy chỉnh liên kết với quảng cáo tại thời điểm quản lý quảng cáo.

Trả về: non-null Object with string properties Liên kết các khóa quản lý quảng cáo với giá trị hoặc Đối tượng trống nếu không có thông tin này.

getTraffickingParametersString

getTraffickingParametersString() trả về chuỗi

Xem các thông số tùy chỉnh liên kết với quảng cáo tại thời điểm quản lý quảng cáo. Trả về phiên bản chuỗi thô của các tham số được phân tích cú pháp qua getTraffickingParameters.

Trả về: string Quản lý thông số hoặc chuỗi trống nếu không có thông tin này.

Các phần tử getUiElement

getUiElements() trả về Mảng chuỗi

Trả về thành phần giao diện người dùng đang hiển thị khi phát quảng cáo này. Tham khảo UiElements để biết các phần tử có thể có của mảng được trả về.

Trả về: non-null Array of string Các thành phần trên giao diện người dùng đang hiển thị.

getUniversalAdIdRegistry

getUniversalAdIdRegistry() trả về chuỗi

Tổ chức quản lý tên miền liên kết với việc lập danh mục UniversalAdId của mẫu quảng cáo đã chọn cho quảng cáo.

Không được dùng nữa: Sử dụng ad.getUniversalAdIds() để thay thế
Trả về: string Trả về giá trị đăng ký hoặc "không xác định" nếu không có sẵn.

getUniversalAdIdValue

getUniversalAdIdValue() trả về chuỗi

UniversalAdId của quảng cáo đã chọn cho quảng cáo.

Không được dùng nữa: Sử dụng ad.getUniversalAdIds() để thay thế
Trả về: string Trả về giá trị mã nhận dạng hoặc "không xác định" nếu không có sẵn.

getUniversalAdIds

getUniversalAdIds() trả về Mảng UniversalAdIdInfo không rỗng

Danh sách UniversalAdIds của mẫu quảng cáo đã chọn cho quảng cáo.

Trả về: non-null Array of non-null UniversalAdIdInfo Trả về danh sách thông tin về mã quảng cáo chung áp dụng cho quảng cáo này.

getVastMediaBitrate

getVastMediaBitrate() trả về số

Khi cả tệp quảng cáo và tệp nội dung nghe nhìn đều được SDK chọn, việc này sẽ trả về tốc độ bit cho tệp nội dung nghe nhìn như liệt kê trong nội dung phản hồi vast.

Trả về: number Tốc độ bit cho tệp đa phương tiện đã chọn hoặc 0.

getVastMediaHeight

getVastMediaHeight() trả về số

Trả về chiều cao phương tiện VAST của quảng cáo đã chọn.

Trả về: number Chiều cao phương tiện VAST của mẫu quảng cáo đã chọn hoặc 0 nếu không có mẫu nào được chọn.

getVastMediaWidth

getVastMediaWidth() trả về số

Trả về chiều rộng đa phương tiện VAST của quảng cáo đã chọn.

Trả về: number Chiều rộng phương tiện VAST của mẫu quảng cáo đã chọn hoặc bằng 0 nếu không có mẫu nào được chọn.

getWidth (chiều rộng chiều rộng)

getWidth() trả về số

Trả về chiều rộng của quảng cáo đã chọn.

Trả về: number Chiều rộng của mẫu quảng cáo phi tuyến tính đã chọn hoặc 0 đối với mẫu quảng cáo tuyến tính.

getWrapperAdIds

getWrapperAdIds() trả về Mảng chuỗi

ID quảng cáo được sử dụng cho quảng cáo trình bao bọc. Các mã nhận dạng được trả về bắt đầu từ quảng cáo cùng dòng (trong cùng) và chuyển qua quảng cáo trình bao bọc ngoài cùng. Một mảng trống sẽ được trả về nếu không có quảng cáo trình bao bọc.

Trả về: non-null Array of string Các mã nhận dạng của quảng cáo, bắt đầu ở quảng cáo cùng dòng hoặc một mảng trống nếu không có quảng cáo bao bọc.

getWrapperAdSystems

getWrapperAdSystems() trả về Mảng chuỗi

Hệ thống quảng cáo được sử dụng cho quảng cáo trình bao bọc. Các hệ thống quảng cáo được trả về bắt đầu từ quảng cáo nội tuyến và chuyển đến quảng cáo trình bao bọc ngoài cùng. Một mảng trống sẽ được trả về nếu không có quảng cáo trình bao bọc.

Trả về: non-null Array of string Các hệ thống quảng cáo của quảng cáo, bắt đầu từ quảng cáo nội tuyến hoặc một mảng trống nếu không có quảng cáo bao bọc.

getWrapperCreativeIds

getWrapperCreativeIds() trả về một mảng chuỗi

ID quảng cáo đã chọn được sử dụng cho quảng cáo trình bao bọc. Các mã quảng cáo trả về bắt đầu từ quảng cáo nội tuyến và chuyển đến quảng cáo trình bao bọc ngoài cùng. Một mảng trống sẽ được trả về nếu không có quảng cáo trình bao bọc.

Trả về: non-null Array of string Các mã nhận dạng cho tệp sáng tạo của quảng cáo, bắt đầu từ quảng cáo nội tuyến hoặc một mảng trống nếu không có quảng cáo bao bọc.

isLinear

isLinear() trả về boolean

Cho biết chế độ hoạt động hiện tại của quảng cáo là tuyến tính hay phi tuyến tính. Nếu giá trị là true thì giá trị đó cho biết rằng quảng cáo đang ở chế độ phát tuyến tính. Nếu giá trị là false, thì giá trị này cho biết chế độ phát tuyến tính. Trình phát sẽ kiểm tra thuộc tính tuyến tính và cập nhật trạng thái của nó theo chi tiết của vị trí đặt quảng cáo. Trong khi quảng cáo ở chế độ tuyến tính, trình phát sẽ tạm dừng video nội dung. Nếu tuyến tính lúc đầu là đúng và quảng cáo ở đầu video (được xác định bên ngoài), thì trình phát có thể chọn trì hoãn việc tải video nội dung cho đến khi gần phát lại quảng cáo.

Trả về: boolean Đúng nếu quảng cáo là tuyến tính, ngược lại là sai.