Ara iFrame desteği JavaScript API referansı

Bu referans sayfasında, sonraki kullanıcı deneyiminde ara iFrame'i değiştirmek için Tek Dokunma ile kullanılan Intermediate iFrame Support JavaScript API'si açıklanmaktadır.

Ara iframe'leri nasıl kullanacağınızı öğrenmek için iframe kullanarak Tek Dokunma'yı entegre etme kılavuzuna bakın.

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

Yöntemler
verifyParentOrigin üst öğe kaynağı doğrulamasını gerçekleştirir
notifyParentClose One Tap kullanıcı deneyimi akışının atlandığını üst çerçeveye bildirir.
notifyParentDone Tek Dokunma kullanıcı deneyimi akışının tamamlandığını üst çerçeveye bildirir.
notifyParentResize ara iframe'in yeniden boyutlandırılması için üst çerçeveyi bilgilendirir.
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ükleyin

Aşağıdaki kod snippet'ini, ara iframe'i yüklemek istediğiniz tüm 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ı 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'in yerleştirilmesine izin verilen kaynaklar.
verifiedCallback Mevcut üst öğe kaynağının ara iframe'i yerleştirmesine izin verildiğinde tetiklenen JavaScript geri çağırma yöntemi.
verificationFailedCallback Geçerli üst kaynak, ara iFrame'in yerleştirilmesine izin vermediğinde tetiklenen JavaScript geri çağırma yöntemi.

kökenler

Ara iframe'in yerleştirilmesine 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'lerinin dizisi. "https://news.example.com,https://local.example.com"

verifiedCallback

Bu alan, mevcut üst kaynak, ara iframe'in yerleştirilmesine izin verdiğinde tetiklenen bir JavaScript geri çağırma yöntemidir.

verificationFailedCallback

Bu alan, mevcut üst kaynak, 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, tek dokunma kullanıcı deneyimi akışı atlandığında üst çerçeveye ara iframe'in kapatılması için bildirim gönderir. 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.notifyParentClose yöntemi, üst çerçeveye ara iFrame'i kapatması ve giriş durumunu yenilemesi için bildirim gönderir. 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, üst çerçeveye ara iframe'i yeniden boyutlandırması için bildirim gönderir. Yöntemin aşağıdaki kod örneğine bakın:

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

yükseklik

Yeni yükseklik (piksel cinsinden). 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 hale gelir. Gizli bir iframe kapatılmamıştır. 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.