Dokumentacja interfejsu JavaScript API do obsługi iframe pośredniego

Na tej stronie znajdziesz opis interfejsu JavaScript API do obsługi pośredniego elementu iframe, który jest używany przez One Tap do manipulowania pośrednim elementem iframe w kolejnych interfejsach.

Więcej informacji o korzystaniu z pośrednich elementów iframe znajdziesz w przewodniku Integracja One Tap za pomocą elementu iframe.

W tabeli poniżej znajdziesz wszystkie dostępne metody i ich działanie.

Metody
verifyParentOrigin przeprowadza weryfikację domeny nadrzędnej,
notifyParentClose powiadamia ramkę nadrzędną, że proces UX One Tap został pominięty;
notifyParentDone informuje ramkę nadrzędną, że proces UX One Tap został zakończony.
notifyParentResize powiadamia ramkę nadrzędną o konieczności zmiany rozmiaru pośredniej ramki iframe.
notifyParentTapOutsideMode informuje ramkę nadrzędną, czy anulować pośredni element iframe, gdy użytkownik kliknie poza niego;

Wczytaj bibliotekę JavaScript obsługującą pośrednie elementy iframe

Umieść poniższy fragment kodu na dowolnych stronach HTML, na których chcesz wczytywać pośredni element iframe:

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

Metoda: google.accounts.id.intermediate.verifyParentOrigin

Metoda google.accounts.id.intermediate.verifyParentOrigin przeprowadza weryfikację domeny nadrzędnej. Oto przykładowy kod metody:

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

Poniższy przykład kodu pokazuje, jak wyświetlać interfejs tylko po zweryfikowaniu domeny nadrzędnej:

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

W tabeli poniżej znajdziesz listę parametrów:

Parametr
origins Źródła, które mogą osadzać pośredni element iframe.
verifiedCallback Metoda wywołania zwrotnego JavaScriptu wywoływana, gdy bieżące źródło nadrzędne może osadzić pośredni element iframe.
verificationFailedCallback Metoda wywołania zwrotnego JavaScriptu uruchamiana, gdy bieżący punkt początkowy elementu nadrzędnego nie może osadzić pośredniego elementu iframe.

źródła,

Źródła, które mogą osadzać pośredni element iframe. Więcej informacji znajdziesz w tabeli poniżej:

Typ Wymagane Przykład
ciąg znaków, tablica ciągów znaków lub funkcja Opcjonalny allowed_parent_origin: "https://example.com"

W tabeli poniżej znajdziesz listę obsługiwanych typów wartości i ich opisy.

Typy wartości
string Identyfikator URI pojedynczej domeny. "https://example.com"
string array Tablica identyfikatorów URI domeny. "https://news.example.com,https://local.example.com"

verifiedCallback

To pole to metoda wywołania zwrotnego JavaScriptu, która jest wywoływana, gdy bieżące źródło elementu nadrzędnego może osadzić pośredni element iframe.

verificationFailedCallback

To pole to metoda wywołania zwrotnego JavaScriptu, która jest wywoływana, gdy bieżące źródło elementu nadrzędnego nie może osadzić pośredniego elementu iframe.

Metoda: google.accounts.id.intermediate.notifyParentClose

Metoda google.accounts.id.intermediate.notifyParentClose powiadamia ramkę nadrzędną o zamknięciu pośredniej ramki iframe, gdy pominięty zostanie proces UX One Tap. Oto przykładowy kod metody:

google.accounts.id.intermediate.notifyParentClose()

Metoda: google.accounts.id.intermediate.notifyParentDone

Metoda google.accounts.id.intermediate.notifyParentClose powiadamia ramkę nadrzędną o konieczności zamknięcia pośredniej ramki iframe i odświeżenia stanu logowania. Oto przykładowy kod metody:

google.accounts.id.intermediate.notifyParentDone()

Metoda: google.accounts.id.intermediate.notifyParentResize

Metoda google.accounts.id.intermediate.notifyParentResize powiadamia ramkę nadrzędną o konieczności zmiany rozmiaru pośredniej ramki iframe. Oto przykład kodu metody:

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

wysokość

Nowa wysokość w pikselach. To pole jest wymagane. Wartość musi być liczbą nieujemną.

Jeśli parametr wysokości jest większy niż 0, ramka iframe pośrednia przyjmuje nową wysokość. Jeśli parametr wysokości ma wartość 0, pośredni element iframe staje się niewidoczny. Ukryty element iframe nie jest zamykany. Można ją później wyświetlić, wywołując inną metodę zmiany rozmiaru.

Metoda: google.accounts.id.intermediate.notifyParentTapOutsideMode

Metoda google.accounts.id.intermediate.notifyParentTapOutsideMode powiadamia ramkę nadrzędną o tym, czy anulować pośredni element iframe, gdy użytkownik kliknie poza niego. Oto przykładowy kod metody:

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

anuluj

Ta wymagana wartość logiczna wskazuje, czy należy anulować pośredni element iframe, gdy użytkownik kliknie poza nim.