Trang tham khảo này mô tả API JavaScript hỗ trợ Iframe trung gian, cho phép bạn thao tác với iframe trung gian trong trải nghiệm người dùng tiếp theo.
Xem hướng dẫn Tích hợp một lần chạm bằng cách sử dụng Iframe để tìm hiểu cách sử dụng iframe trung gian.
Bảng sau liệt kê tất cả phương thức hiện có và hành vi của các phương thức đó.
Phương thức | |
---|---|
verifyParentOrigin |
thực hiện xác minh điểm gốc gốc |
notifyParentClose |
thông báo cho khung chính thì quy trình Trải nghiệm người dùng bằng một lần chạm bị bỏ qua |
notifyParentDone |
thông báo cho khung chính là quy trình Trải nghiệm người dùng bằng một lần chạm đã hoàn tất |
notifyParentResize |
thông báo cho khung mẹ để đổi kích thước iframe trung gian |
notifyParentTapOutsideMode |
thông báo cho khung chính liệu có huỷ iframe trung gian hay không khi người dùng nhấp vào bên ngoài iframe trung gian |
Tải Thư viện JavaScript hỗ trợ Iframe trung gian
Đặt đoạn mã sau vào bất kỳ trang HTML nào mà bạn muốn tải iframe trung gian:
<script src="https://accounts.google.com/gsi/intermediatesupport"></script>
Phương thức: google.accounts.id.intermediate.verifyParentOrigin
Phương thức google.accounts.id.intermediate.verifyParentOrigin
thực hiện việc xác minh nguồn gốc gốc. Hãy xem mã ví dụ sau đây của phương thức này:
google.accounts.id.intermediate.verifyParentOrigin(
origins, verifiedCallback, verificationFailedCallback)
Mã ví dụ sau đây cho thấy cách chỉ hiển thị giao diện người dùng sau khi nguồn gốc gốc được xác minh:
<script>
window.onload = () => {
google.accounts.id.intermediate.verifyParentOrigin(
"https://example.com", showUI, showError);
};
</script>
Bảng sau đây liệt kê các thông số:
Thông số | |
---|---|
origins |
Các nguồn gốc được phép nhúng iframe trung gian. |
verifiedCallback |
Phương pháp gọi lại JavaScript được kích hoạt khi nguồn gốc hiện tại được phép nhúng iframe trung gian. |
verificationFailedCallback |
Phương pháp gọi lại JavaScript được kích hoạt khi nguồn gốc hiện tại không được phép nhúng iframe trung gian. |
nguồn gốc
Các nguồn gốc được phép nhúng iframe trung gian. Hãy xem bảng sau để biết thêm thông tin:
Loại | Bắt buộc | Ví dụ: |
---|---|---|
chuỗi, mảng chuỗi hoặc hàm | Không bắt buộc | allowed_parent_origin: "https://example.com" |
Bảng sau đây liệt kê các loại giá trị được hỗ trợ và nội dung mô tả của các loại giá trị đó.
Loại giá trị | ||
---|---|---|
string |
Một URI miền duy nhất. | "https://vidu.com" |
string array |
Một mảng URI miền. | "https://news.example.com,https://local.example.com" |
validationCallback
Trường này là phương thức gọi lại JavaScript được kích hoạt khi nguồn gốc hiện tại được phép nhúng iframe trung gian.
validationFailedCallback
Trường này là phương thức gọi lại JavaScript được kích hoạt khi nguồn gốc hiện tại không được phép nhúng iframe trung gian.
Phương thức: google.accounts.id.intermediate.notifyParentClose
Phương thức google.accounts.id.intermediate.notifyParentClose
thông báo cho khung gốc để đóng iframe trung gian khi quy trình Trải nghiệm người dùng bằng một lần chạm bị bỏ qua. Hãy xem mã ví dụ sau đây của phương thức này:
google.accounts.id.intermediate.notifyParentClose()
Phương thức: google.accounts.id.intermediate.notifyParentDone
Phương thức google.accounts.id.intermediate.notifyParentClose
thông báo cho khung mẹ để đóng iframe trung gian và làm mới trạng thái đăng nhập. Hãy xem mã ví dụ sau đây về phương thức này:
google.accounts.id.intermediate.notifyParentDone()
Phương thức: google.accounts.id.intermediate.notifyParentResize
Phương thức google.accounts.id.intermediate.notifyParentResize
thông báo cho khung mẹ để đổi kích thước iframe trung gian. Hãy xem mã ví dụ sau đây của phương thức:
google.accounts.id.intermediate.notifyParentResize(height)
độ cao
Chiều cao mới tính theo pixel. Đây là trường bắt buộc. Giá trị phải là một số âm.
Nếu tham số chiều cao lớn hơn 0, thì iframe trung gian sẽ được đặt thành chiều cao mới. Nếu tham số chiều cao bằng 0, iframe trung gian sẽ không hiển thị. iframe ẩn chưa đóng. Mã này có thể hiển thị sau bằng một lệnh gọi phương thức đổi kích thước khác.
Phương thức: google.accounts.id.intermediate.notifyParentTapOutsideMode
Phương thức google.accounts.id.intermediate.notifyParentTapOutsideMode
thông báo cho khung gốc liệu có huỷ iframe trung gian khi người dùng nhấp vào bên ngoài iframe trung gian hay không. Hãy xem mã ví dụ sau đây của phương thức này:
google.accounts.id.intermediate.notifyParentTapOutsideMode(cancel)
huỷ
Giá trị boolean bắt buộc này cho biết liệu có huỷ iframe trung gian khi người dùng nhấp vào bên ngoài iframe trung gian hay không.