Ara iFrame desteği JavaScript API referansı

Bu referans sayfasında, One Tap tarafından sonraki kullanıcı deneyiminde ara iFrame'i değiştirmek için kullanılan Intermediate iframe Support JavaScript API açıklanmaktadır.

Ara iframe'lerin nasıl kullanılacağını öğrenmek için Iframe kullanarak One Tap'i entegre etme kılavuzuna bakın.

Aşağıdaki tabloda, mevcut tüm yöntemler ve davranışları listelenmiştir.

Yöntemler
verifyParentOrigin üst kaynak doğrulamasını gerçekleştirir
notifyParentClose Üst çerçeveye, One Tap kullanıcı deneyimi akışının atlandığını bildirir.
notifyParentDone Üst çerçeveye, One Tap kullanıcı deneyimi akışının tamamlandığını bildirir.
notifyParentResize Üst çerçeveye, ara iFrame'i yeniden boyutlandırmasını bildirir.
notifyParentTapOutsideMode Kullanıcı, ara iFrame'in dışını tıkladığında ara iFrame'in iptal edilip edilmeyeceğini üst çerçeveye bildirir.

Ara iFrame Desteği JavaScript Kitaplığı'nı yükleme

Aşağıdaki kod snippet'ini, ara iframe'i yüklemek istediğiniz HTML sayfalarına yerleştirin:

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

Yöntem: google.accounts.id.intermediate.verifyParentOrigin

google.accounts.id.intermediate.verifyParentOrigin yöntemi, üst kaynak doğrulamasını gerçekleştirir. Yöntemin aşağıdaki kod örneğine bakın:

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

Aşağıdaki kod örneğinde, kullanıcı arayüzünün yalnızca üst kaynak doğrulandıktan sonra nasıl gösterileceği açıklanmaktadır:

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

Aşağıdaki tabloda parametreler listelenmiştir:

Parametre
origins Ara iFrame'i yerleştirmesine izin verilen kaynaklar.
verifiedCallback Mevcut üst kaynağın ara iFrame'i yerleştirmesine izin verildiğinde tetiklenen JavaScript geri çağırma yöntemi.
verificationFailedCallback Mevcut üst kaynağın ara iframe'i yerleştirmesine izin verilmediğinde tetiklenen JavaScript geri çağırma yöntemi.

origins

Ara iFrame'i yerleştirmesine izin verilen kaynaklar. Daha fazla bilgi için aşağıdaki tabloya bakın:

Tür Zorunlu Örnek
dize, dize dizisi veya işlev İsteğe bağlı allowed_parent_origin: "https://example.com"

Aşağıdaki tabloda desteklenen değer türleri ve açıklamaları listelenmiştir.

Değer Türleri
string Tek bir alan adı URI'si. "https://example.com"
string array Alan URI'leri dizisi. "https://news.example.com,https://local.example.com"

verifiedCallback

Bu alan, mevcut üst kaynağın ara iframe'i yerleştirmesine izin verildiğinde tetiklenen bir JavaScript geri çağırma yöntemidir.

verificationFailedCallback

Bu alan, mevcut üst kaynağın ara iframe'i yerleştirmesine izin verilmediğinde tetiklenen bir JavaScript geri çağırma yöntemidir.

Yöntem: google.accounts.id.intermediate.notifyParentClose

google.accounts.id.intermediate.notifyParentClose yöntemi, One Tap kullanıcı deneyimi akışı atlandığında ara iframe'i kapatması için üst çerçeveyi bilgilendirir. Yöntemin aşağıdaki kod örneğine bakın:

google.accounts.id.intermediate.notifyParentClose()

Yöntem: google.accounts.id.intermediate.notifyParentDone

google.accounts.id.intermediate.notifyParentDone yöntemi, üst çerçeveye ara iFrame'i kapatmasını ve giriş durumunu yenilemesini bildirir. Yöntemin aşağıdaki kod örneğine bakın:

google.accounts.id.intermediate.notifyParentDone()

Yöntem: google.accounts.id.intermediate.notifyParentResize

google.accounts.id.intermediate.notifyParentResize yöntemi, ara iFrame'i yeniden boyutlandırması için üst çerçeveyi bilgilendirir. Yöntemin aşağıdaki kod örneğine bakın:

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

yükseklik

Piksel cinsinden yeni yükseklik. Bu alanının doldurulması zorunludur. Değer, negatif olmayan bir sayı olmalıdır.

Yükseklik parametresi 0'dan büyükse ara iFrame yeni yüksekliğe ayarlanır. Yükseklik parametresi 0 ise ara iframe görünmez olur. Gizli bir iframe kapatılmamış. Daha sonra başka bir yeniden boyutlandırma yöntemi çağrısıyla gösterilebilir.

Yöntem: google.accounts.id.intermediate.notifyParentTapOutsideMode

google.accounts.id.intermediate.notifyParentTapOutsideMode yöntemi, kullanıcı ara iFrame'in dışını tıkladığında ara iFrame'in iptal edilip edilmeyeceğini üst çerçeveye bildirir. Yöntemin aşağıdaki kod örneğine bakın:

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

iptal

Bu zorunlu boole değeri, kullanıcı ara iFrame'in dışını tıkladığında ara iFrame'in iptal edilip edilmeyeceğini belirtir.