Loại: ImaSdkSettings

google.ima.ImaSdkSettings

class public tĩnh

Lớp này chứa các chế độ cài đặt trên toàn SDK.

Bảng liệt kê

Chế độ chèn lấp đồng hành

Constant static

chuỗi

Xác định một tập hợp các hằng số cho chế độ cài đặt chèn lấp đồng hành. Chế độ cài đặt này cho biết liệu có nên chèn lấp quảng cáo đồng hành trong nhiều tình huống hay không.

Nếu giá trị là ALWAYS, thì tính năng chèn lấp đồng hành sẽ được cố gắng trong mọi trường hợp, ngay cả khi không có quảng cáo chính nào được trả về.

Nếu giá trị là ON_MASTER_AD, thì quảng cáo đồng hành sẽ được thử nếu có quảng cáo chính có ít quảng cáo đồng hành hơn so với vùng quảng cáo đồng hành. Những quảng cáo đồng hành bị thiếu sẽ được chèn lấp.

Giá trị mặc định là ALWAYS.

Xin lưu ý rằng tính năng chèn lấp đồng hành phía máy khách yêu cầu gắn thẻ đồng hành đúng cách bằng Thẻ nhà xuất bản của Google (GPT). Để bật tính năng chèn lấp, bạn cần thực hiện những thay đổi sau đây đối với việc thiết lập GPT chuẩn: 
...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();
Đối với video tự động phát, bạn nên thực hiện thay đổi bổ sung sau đây để ngăn quảng cáo đồng hành tải trước, sau đó thay thế ngay bằng quảng cáo đồng hành. 
googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

Giá trị

LUÔN LUÔN

BẬT_M_NHA_MAD

Chế độ Vpaid

Constant static

number

Một tập hợp các hằng số để bật chức năng VPAID.

Giá trị

ĐÃ TẮT

Quảng cáo VPAID sẽ không phát và sẽ có lỗi được trả về.

ĐÃ BẬT

Quảng cáo VPAID được bật bằng cách sử dụng iframe chéo miền. Quảng cáo VPAID không thể truy cập vào trang web. Quảng cáo VPAID phụ thuộc vào quyền truy cập iframe thân thiện có thể có lỗi. Đây là tuỳ chọn mặc định.

KHÔNG AN TOÀN

Bạn có thể bật quảng cáo VPAID bằng cách sử dụng iframe thân thiện. Thao tác này cho phép quảng cáo truy cập vào trang web thông qua JavaScript.

Thuộc tính

Chế độ chèn lấp đồng hành

Constant static

chuỗi

Xác định một tập hợp các hằng số cho chế độ cài đặt chèn lấp đồng hành. Chế độ cài đặt này cho biết liệu có nên chèn lấp quảng cáo đồng hành trong nhiều tình huống hay không.

Nếu giá trị là ALWAYS, thì tính năng chèn lấp đồng hành sẽ được cố gắng trong mọi trường hợp, ngay cả khi không có quảng cáo chính nào được trả về.

Nếu giá trị là ON_MASTER_AD, thì quảng cáo đồng hành sẽ được thử nếu có quảng cáo chính có ít quảng cáo đồng hành hơn so với vùng quảng cáo đồng hành. Những quảng cáo đồng hành bị thiếu sẽ được chèn lấp.

Giá trị mặc định là ALWAYS.

Xin lưu ý rằng tính năng chèn lấp đồng hành phía máy khách yêu cầu gắn thẻ đồng hành đúng cách bằng Thẻ nhà xuất bản của Google (GPT). Để bật tính năng chèn lấp, bạn cần thực hiện những thay đổi sau đây đối với việc thiết lập GPT chuẩn: 
...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();
Đối với video tự động phát, bạn nên thực hiện thay đổi bổ sung sau đây để ngăn quảng cáo đồng hành tải trước, sau đó thay thế ngay bằng quảng cáo đồng hành. 
googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

Giá trị

LUÔN LUÔN

BẬT_M_NHA_MAD

Chế độ Vpaid

Constant static

number

Một tập hợp các hằng số để bật chức năng VPAID.

Giá trị

ĐÃ TẮT

Quảng cáo VPAID sẽ không phát và sẽ có lỗi được trả về.

ĐÃ BẬT

Quảng cáo VPAID được bật bằng cách sử dụng iframe chéo miền. Quảng cáo VPAID không thể truy cập vào trang web. Quảng cáo VPAID phụ thuộc vào quyền truy cập iframe thân thiện có thể có lỗi. Đây là tuỳ chọn mặc định.

KHÔNG AN TOÀN

Bạn có thể bật quảng cáo VPAID bằng cách sử dụng iframe thân thiện. Thao tác này cho phép quảng cáo truy cập vào trang web thông qua JavaScript.

Phương pháp

getCompanionBackfill

getCompanionBackfill() trả về CompanionBackfillMode

Trả về chế độ chèn lấp hiện tại.

Trả về

non-null CompanionBackfillMode Giá trị hiện tại.

nhận videoDisableCustomPlaybackForIOS10Plus

getDisabledCustomPlaybackForIOS10Plus() trả về boolean

Xem có tắt tính năng phát tuỳ chỉnh trên các trình duyệt iOS 10 trở lên hay không. Giá trị mặc định là sai.

Trả về

boolean 

nhận tính năng gắn cờ

getFeatureFlags() trả về Đối tượng có bất kỳ thuộc tính loại nào

Trả về một đối tượng có các khoá dưới dạng cờ tính năng và các giá trị dưới dạng trạng thái hiện tại của các đối tượng đó.

Trả về

non-null Object with any type properties 

nhận ngôn ngữ

getLocale() trả về chuỗi

Trả về ngôn ngữ do nhà xuất bản cung cấp.

Trả về

string Ngôn ngữ do nhà xuất bản cung cấp.

nhận Chuyển hướng chuyển đổi

getNumredirects() trả về số

Trả về số lượng lệnh chuyển hướng tối đa cho các lệnh chuyển hướng tiếp theo sẽ bị từ chối.

Trả về

number số lần chuyển hướng tối đa.

nhận

getPlayerType() trả về chuỗi

Trả về loại người chơi do đối tác cung cấp.

Trả về

string Kiểu người chơi đối tác.

nhận phiên bản người chơi

getPlayerVersion() trả về chuỗi

Trả về phiên bản trình phát do đối tác cung cấp.

Trả về

string Phiên bản trình phát đối tác.

nhận IPPid

getPpid() trả về (null hoặc string)

Trả về mã do nhà xuất bản cung cấp.

Trả về

Mã (null or string) do nhà xuất bản cung cấp.

Đã bật cookie

isCookieEnabled() trả về boolean

Trả về

boolean Nhà xuất bản có cho phép sử dụng cookie hay không.

setAutoPlayAdBreaks

setAutoPlayAdBreaks(autoPlayAdBreaks) trả về vô hiệu

Đặt liệu điểm chèn quảng cáo của VMAP và các quy tắc quảng cáo có tự động phát hay không

Thông số

Điểm chèn quảng cáo tự động trên Play

boolean

Chọn có tự động phát quảng cáo hay không.
Trả về

void 

setCompanionBackfill

setCompanionBackfill(mode) trả về vô hiệu

Đặt chế độ chèn lấp đồng hành. Xem các chế độ có sẵn trong ImaSdkSettings.CompanionBackfillMode.

Chế độ mặc định là ImaSdkSettings.CompanionBackfillMode.ALWAYS.

Thông số

chế độ

Chế độ chèn lấp đồng hành

Chế độ chèn lấp đồng hành đã chọn.

Không được để trống giá trị.
Trả về

void 

Đã bật setCookie

setCookieEnabled(cookiesEnabled) trả về

SDK có nên lưu trữ cookie Google Ad Manager (Cookie GFP) trên miền của nhà xuất bản dưới dạng cookie của bên thứ nhất hay không. Điều này cho phép lưu trữ dữ liệu qua nhiều lần truy cập vào cùng một miền mà không cần dùng cookie của bên thứ ba. Giá trị mặc định là đúng.

Chế độ cài đặt này sẽ không ảnh hưởng đến các cookie khác do các bên khác đặt hoặc cho các mục đích khác. Việc người dùng đồng ý và chọn không hiển thị cũng có thể vô hiệu hoá việc sử dụng cookie của bên thứ nhất. Nhà xuất bản sẽ sử dụng những thông tin này của Nhà cung cấp dịch vụ quản lý sự đồng ý tuân thủ IAB nếu có trong cùng một khung.

Thông số

Đã bật cookie

boolean
Trả về

void 

setDisableCustomPlaybackForIOS10Plus

setdisableCustomPlaybackForIOS10Plus(vô hiệu) trả về vô hiệu

Đặt xem có tắt tính năng phát tuỳ chỉnh trên các trình duyệt iOS 10 trở lên hay không. Nếu đúng, quảng cáo sẽ phát nội tuyến nếu video nội dung cùng dòng. Điều này cho phép quảng cáo TrueView có thể bỏ qua. Tuy nhiên, quảng cáo này sẽ vẫn ở cùng dòng và không hỗ trợ chế độ toàn màn hình của iOS. Khi bạn nhập sai, quảng cáo sẽ phát trong cùng một trình phát với nội dung. Giá trị đặt tại đây khi AdAdContainer được tạo sẽ được sử dụng trong suốt thời gian của vùng chứa. Giá trị mặc định là sai.

Thông số

tắt

boolean

Liệu có tắt tính năng phát lại tùy chỉnh hay không.
Trả về

void 

setFeatureFlags

setFeatureFlags(featureFlags) trả hàng

Đặt giá trị cho mọi cờ tính năng. Bạn nên đặt càng sớm càng tốt trước khi yêu cầu quảng cáo. Các chế độ cài đặt sẽ không đổi cho đến yêu cầu quảng cáo tiếp theo. Việc gọi lại phương thức này sẽ đặt lại mọi cờ tính năng cho yêu cầu quảng cáo tiếp theo.

Thông số

Tính năng cờ

Đối tượng có một loại thuộc tính bất kỳ

Không được để trống giá trị.
Trả về

void 

setLocale

setLocale(locale) trả về vô hiệu

Đặt ngôn ngữ do nhà xuất bản cung cấp. Phải được gọi trước khi tạo AdsLoader hoặc AdDisplayContainer. Ngôn ngữ này chỉ định ngôn ngữ để hiển thị các thành phần trên giao diện người dùng. Bạn có thể xem các mã được hỗ trợ trong bài viết Bản địa hoá ngôn ngữ và ngôn ngữ.

Thông số

ngôn ngữ

chuỗi

Ngôn ngữ do nhà xuất bản cung cấp.
Trả về

void 

setNumChuyển hướng

setNumredirects(numredirects) trả về khoảng trống

Xác định số lượng lệnh chuyển hướng tối đa trước khi lệnh chuyển hướng tiếp theo bị từ chối và lượt tải quảng cáo bị huỷ. Số lượt chuyển hướng trực tiếp ảnh hưởng đến độ trễ và do đó ảnh hưởng đến trải nghiệm người dùng. Điều này áp dụng cho tất cả các quảng cáo trình bao bọc VAST.

Thông số

numredirect

number

số lần chuyển hướng tối đa.
Trả về

void 

setPlayerType

setPlayerType(playerType) trả hàng

Đặt loại người chơi do đối tác cung cấp. Bạn nên sử dụng chế độ cài đặt này để chỉ định tên của trình phát đang được tích hợp với SDK. Kiểu người chơi dài hơn 20 ký tự sẽ bị cắt ngắn. Kiểu người chơi được chỉ định phải ngắn gọn và riêng biệt. Đây là một tuỳ chọn cài đặt không bắt buộc dùng để cải thiện khả năng sử dụng SDK bằng cách theo dõi các kiểu người chơi.

Ví dụ: 


settings.setPlayerType('google/gmf-player');

Thông số

PlayerType

chuỗi

Kiểu người chơi đối tác.
Trả về

void 

setPlayerVersion

setPlayerVersion(playerVersion) trả hàng

Thiết lập phiên bản trình phát do đối tác cung cấp. Bạn nên sử dụng chế độ cài đặt này để chỉ định phiên bản trình phát của đối tác đang được tích hợp với SDK. Phiên bản trình phát dài hơn 20 ký tự sẽ bị cắt ngắn. Đây là một chế độ cài đặt không bắt buộc dùng để cải thiện khả năng sử dụng SDK bằng cách theo dõi phiên bản trình phát.

Ví dụ: 


settings.setPlayerVersion('1.0.0');

Thông số

phiên bản trình phát

chuỗi

Phiên bản của trình phát đối tác.
Trả về

void 

setPpid

setPpid(ppid) trả về vô hiệu

Đặt mã do nhà xuất bản cung cấp.

Thông số

ppi

chuỗi

mã nhà xuất bản cung cấp.
Trả về

void 

setSessionId

setSessionId(sessionId) trả về vô hiệu

Mã phiên là mã ngẫu nhiên tạm thời. Giá trị này được dùng riêng cho giới hạn tần suất. Mã phiên phải là mã UUID.

Thông số

ID phiên

chuỗi

Một UUID tạm thời dùng để giới hạn tần suất.
Trả về

void 

setVpaidAllowed

setVpaidAllowed(allowVpaid) trả về vô hiệu

Không dùng nữa. Sử dụng setVpaidMode. Đặt xem có cho phép quảng cáo VPAID hay không.

Thông số

allowVpaid

boolean

Có cho phép quảng cáo VPAID hay không.
Trả về

void 

setVpaidMode

setVpaidMode(vpaidMode) trả về vô hiệu

Đặt chế độ phát VPAID.

Thông số

Chế độ vpaid

Chế độ Vpaid

Đặt cách phát quảng cáo VPAID. Chế độ mặc định là chế độ bảo mật.

Không được để trống giá trị.
Trả về

void