Промежуточная поддержка Iframe JavaScript API

На этой справочной странице описан API JavaScript для поддержки промежуточного iframe, который позволяет манипулировать промежуточным iframe в последующем пользовательском интерфейсе.

См. руководство «Интеграция одним нажатием» с использованием Iframe, чтобы узнать, как использовать промежуточные iframe.

В следующей таблице перечислены все доступные методы и их поведение.

Методы
verifyParentOrigin выполняет проверку родительского происхождения
notifyParentClose уведомляет родительский фрейм о том, что поток One Tap UX пропущен
notifyParentDone уведомляет родительский фрейм о завершении процесса One Tap UX
notifyParentResize уведомляет родительский фрейм об изменении размера промежуточного iframe
notifyParentTapOutsideMode уведомляет родительский фрейм, следует ли отменить промежуточный iframe, когда пользователь щелкает за пределами промежуточного iframe

Загрузите библиотеку JavaScript для промежуточной поддержки iframe

Поместите следующий фрагмент кода на любую HTML-страницу, на которую вы хотите загрузить промежуточный iframe:

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

Метод: google.accounts.id.intermediate.verifyParentOrigin

Метод google.accounts.id.intermediate.verifyParentOrigin выполняет проверку родительского происхождения. См. следующий пример кода метода:

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

В следующем примере кода показано, как отображать пользовательский интерфейс только после проверки родительского источника:

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

В следующей таблице перечислены параметры:

Параметр
origins Источники, которым разрешено встраивать промежуточный iframe.
verifiedCallback Метод обратного вызова JavaScript срабатывает, когда текущему родительскому источнику разрешено встроить промежуточный iframe.
verificationFailedCallback Метод обратного вызова JavaScript срабатывает, когда текущему родительскому источнику не разрешено встраивать промежуточный iframe.

происхождение

Источники, которым разрешено встраивать промежуточный iframe. Дополнительную информацию смотрите в следующей таблице:

Тип Необходимый Пример
строка, массив строк или функция Необязательный allowed_parent_origin: "https://example.com"

В следующей таблице перечислены поддерживаемые типы значений и их описания.

Типы значений
string URI одного домена. "https://example.com"
string array Массив URI домена. "https://news.example.com, https://local.example.com"

провереноОбратный вызов

Это поле представляет собой метод обратного вызова JavaScript, который активируется, когда текущему родительскому источнику разрешено встроить промежуточный iframe.

проверкаFailedCallback

Это поле представляет собой метод обратного вызова JavaScript, который активируется, когда текущему родительскому источнику не разрешено встраивать промежуточный iframe.

Метод: google.accounts.id.intermediate.notifyParentClose

Метод google.accounts.id.intermediate.notifyParentClose уведомляет родительский фрейм о необходимости закрытия промежуточного iframe, когда поток пользовательского интерфейса One Tap пропускается. См. следующий пример кода метода:

google.accounts.id.intermediate.notifyParentClose()

Метод: google.accounts.id.intermediate.notifyParentDone

Метод google.accounts.id.intermediate.notifyParentClose уведомляет родительский фрейм о необходимости закрытия промежуточного iframe и обновления статуса входа. См. следующий пример кода метода:

google.accounts.id.intermediate.notifyParentDone()

Метод: google.accounts.id.intermediate.notifyParentResize

Метод google.accounts.id.intermediate.notifyParentResize уведомляет родительский фрейм о необходимости изменить размер промежуточного iframe. См. следующий пример кода метода:

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

высота

Новая высота в пикселях. Это обязательное поле. Значение должно быть неотрицательным числом.

Если параметр высоты больше 0, для промежуточного iframe устанавливается новая высота. Если параметр высоты равен 0, промежуточный iframe становится невидимым. Скрытый iframe не закрывается. Это можно показать позже, вызвав другой метод изменения размера.

Метод: google.accounts.id.intermediate.notifyParentTapOutsideMode.

Метод google.accounts.id.intermediate.notifyParentTapOutsideMode уведомляет родительский фрейм, следует ли отменить промежуточный iframe, когда пользователь щелкает за пределами промежуточного iframe. См. следующий пример кода метода:

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

отмена

Это обязательное логическое значение указывает, следует ли отменить промежуточный iframe, когда пользователь щелкает за пределами промежуточного iframe.