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

Na tej stronie referencyjnej opisano interfejs JavaScript API obsługujący pośredni element iframe, który jest używany przez funkcję One Tap do manipulowania pośrednim elementem iframe w późniejszym interfejsie użytkownika.

Aby dowiedzieć się, jak używać pośrednich elementów iframe, zapoznaj się z przewodnikiem Integracja funkcji One Tap za pomocą elementu iframe.

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

Metody
verifyParentOrigin	przeprowadza weryfikację źródła nadrzędnego,
notifyParentClose	powiadamia ramkę nadrzędną, że proces UX logowania jednym dotknięciem został pominięty;
notifyParentDone	powiadamia ramkę nadrzędną o zakończeniu procesu UX logowania jednym dotknięciem.
notifyParentResize	powiadamia ramkę nadrzędną o konieczności zmiany rozmiaru pośredniej ramki iframe,
notifyParentTapOutsideMode	powiadamia ramkę nadrzędną, czy anulować pośredni element iframe, gdy użytkownik kliknie poza nim;

Wczytywanie biblioteki JavaScript obsługującej pośrednie elementy iframe

Umieść poniższy fragment kodu na wszystkich 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ę źródła nadrzędnego. Oto przykładowy kod metody:

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

Poniższy przykładowy kod pokazuje, jak wyświetlić interfejs dopiero po zweryfikowaniu źródła nadrzędnego:

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

W tabeli poniżej znajdziesz parametry:

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

źródła

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

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

W tabeli poniżej znajdziesz obsługiwane typy wartości i ich opisy.

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

Uwaga: ciąg znaków z identyfikatorami URI rozdzielonymi przecinkami jest nieprawidłowy. Zamiast tego użyj obiektu tablicy w Javascripcie.

verifiedCallback

To pole jest metodą wywołania zwrotnego JavaScriptu, która jest wywoływana, gdy bieżące źródło nadrzędne może umieścić pośredni element iframe.

verificationFailedCallback

To pole jest metodą wywołania zwrotnego JavaScriptu, która jest aktywowana, gdy bieżące źródło nadrzędne nie może umieścić pośredniego elementu iframe.

Ostrzeżenie: jeśli strona treści nie odpowie na prośbę o weryfikację domeny, proces weryfikacji będzie czekać w nieskończoność. W takim przypadku nie są wywoływane ani verifiedCallback, ani verificationFailedCallback.

Metoda: google.accounts.id.intermediate.notifyParentClose

Metoda google.accounts.id.intermediate.notifyParentClose powiadamia ramkę nadrzędną o zamknięciu pośredniego elementu iframe, gdy proces UX logowania jednym dotknięciem zostanie pominięty. Oto przykładowy kod metody:

google.accounts.id.intermediate.notifyParentClose()

Metoda: google.accounts.id.intermediate.notifyParentDone

Metoda google.accounts.id.intermediate.notifyParentDone 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ładowy kod metody:

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

Uwaga: nie możesz zmienić szerokości pośredniego elementu iframe.

wysokość

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

Jeśli parametr wysokości jest większy niż 0, pośredni element iframe jest ustawiany na nową wysokość. Jeśli parametr wysokości wynosi 0, pośredni element iframe staje się niewidoczny. Ukryty element iframe nie jest zamknięty. Można go wyświetlić później, wywołując ponownie metodę zmiany rozmiaru.

Metoda: google.accounts.id.intermediate.notifyParentTapOutsideMode

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

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

anuluj

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