API JavaScript Dukungan Iframe Menengah

Halaman referensi ini menjelaskan Intermediate Iframe Support JavaScript API, yang memungkinkan Anda memanipulasi iframe perantara di UX berikutnya.

Lihat panduan Mengintegrasikan Sekali Ketuk menggunakan Iframe untuk mempelajari cara menggunakan iframe menengah.

Tabel berikut mencantumkan semua metode yang tersedia dan perilakunya.

Metode
verifyParentOrigin	melakukan verifikasi origin induk
notifyParentClose	memberi tahu frame induk bahwa alur UX Sekali Ketuk dilewati
notifyParentDone	memberi tahu frame induk bahwa alur UX Sekali Ketuk selesai
notifyParentResize	memberi tahu frame induk untuk mengubah ukuran iframe perantara
notifyParentTapOutsideMode	memberi tahu frame induk apakah akan membatalkan iframe perantara saat pengguna mengklik di luar iframe perantara

Memuat Library JavaScript Dukungan Iframe Menengah

Tempatkan cuplikan kode berikut ke dalam halaman HTML mana pun tempat Anda ingin memuat iframe perantara:

<script src="https://accounts.google.com/gsi/intermediatesupport"></script>

Metode: google.accounts.id.intermediate.verifyParentOrigin

Metode google.accounts.id.intermediate.verifyParentOrigin akan melakukan verifikasi origin induk. Lihat contoh kode berikut untuk metode tersebut:

google.accounts.id.intermediate.verifyParentOrigin(
    origins, verifiedCallback, verificationFailedCallback)

Contoh kode berikut menunjukkan cara menampilkan UI hanya setelah asal induk diverifikasi:

<script>
  window.onload = () => {
    google.accounts.id.intermediate.verifyParentOrigin(
        "https://example.com", showUI, showError);
  };
</script>

Tabel berikut mencantumkan parameter:

Parameter
origins	Asal yang diizinkan untuk menyematkan iframe perantara.
verifiedCallback	Metode callback JavaScript dipicu saat asal induk saat ini diizinkan untuk menyematkan iframe perantara.
verificationFailedCallback	Metode callback JavaScript dipicu saat origin induk saat ini tidak diizinkan untuk menyematkan iframe perantara.

origin

Asal yang diizinkan untuk menyematkan iframe perantara. Lihat tabel berikut untuk informasi lebih lanjut:

Type	Wajib	Contoh
string, array string, atau fungsi	Opsional	allowed_parent_origin: "https://example.com"

Tabel berikut mencantumkan jenis nilai yang didukung dan deskripsinya.

Jenis Nilai
string	URI domain tunggal.	"https://example.com"
string array	Array URI domain.	"https://news.example.com,https://local.example.com"

Catatan: String dengan URI yang dipisahkan koma tidak valid. Gunakan objek Array JavaScript.

terverifikasiCallback

Kolom ini adalah metode callback JavaScript yang dipicu saat origin induk saat ini diizinkan untuk menyematkan iframe perantara.

verifikasiGagalCallback

Kolom ini adalah metode callback JavaScript yang dipicu saat origin induk saat ini tidak diizinkan untuk menyematkan iframe perantara.

Peringatan: jika halaman konten tidak merespons permintaan verifikasi domain, proses verifikasi akan menunggu selamanya. Dalam hal ini, verifiedCallback atau verificationFailedCallback tidak dipanggil.

Metode: google.accounts.id.intermediate.notifyParentClose

Metode google.accounts.id.intermediate.notifyParentClose memberi tahu frame induk untuk menutup iframe perantara saat alur UX Sekali Ketuk dilewati. Lihat contoh kode berikut untuk metode tersebut:

google.accounts.id.intermediate.notifyParentClose()

Metode: google.accounts.id.intermediate.notifyParentDone

Metode google.accounts.id.intermediate.notifyParentClose memberi tahu frame induk untuk menutup iframe perantara dan memuat ulang status login. Lihat contoh kode metode berikut:

google.accounts.id.intermediate.notifyParentDone()

Metode: google.accounts.id.intermediate.notifyParentResize

Metode google.accounts.id.intermediate.notifyParentResize memberi tahu frame induk untuk mengubah ukuran iframe perantara. Lihat contoh kode berikut untuk metode tersebut:

google.accounts.id.intermediate.notifyParentResize(height)

Catatan: Anda tidak dapat mengubah lebar iframe perantara.

tinggi

Tinggi baru dalam piksel. Bidang ini harus diisi. Nilainya harus berupa angka yang tidak negatif.

Jika parameter tinggi lebih besar dari 0, iframe perantara disetel ke tinggi baru. Jika parameter tinggi adalah 0, iframe perantara menjadi tidak terlihat. Iframe tersembunyi tidak ditutup. Hal ini dapat ditampilkan nanti oleh panggilan metode pengubahan ukuran lainnya.

Metode: google.accounts.id.intermediate.notifyParentTap outsideMode

Metode google.accounts.id.intermediate.notifyParentTapOutsideMode memberi tahu frame induk apakah akan membatalkan iframe perantara saat pengguna mengklik di luar iframe perantara. Lihat contoh kode berikut untuk metode tersebut:

google.accounts.id.intermediate.notifyParentTapOutsideMode(cancel)

batal

Nilai boolean yang diperlukan ini menunjukkan apakah akan membatalkan iframe perantara saat pengguna mengklik di luar iframe perantara.