Документация по JavaScript API для поддержки промежуточных фреймов iframe

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

Подробнее о том, как использовать промежуточные окна iframe, рассказывается в руководстве Как интегрировать One Tap с помощью iframe.

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

Методы
verifyParentOrigin выполняет проверку родительского источника;
notifyParentClose уведомляет родительский фрейм о том, что процесс One Tap UX пропущен.
notifyParentDone Уведомляет родительский фрейм о том, что процесс входа в одно касание завершен.
notifyParentResize уведомляет родительский фрейм о необходимости изменить размер промежуточного фрейма iframe;
notifyParentTapOutsideMode уведомляет родительский фрейм о том, нужно ли отменить промежуточный фрейм 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"

verifiedCallback

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

verificationFailedCallback

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

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

Метод google.accounts.id.intermediate.notifyParentClose уведомляет родительский фрейм о том, что нужно закрыть промежуточное окно iframe, если пользователь пропустил UX-поток One Tap. Пример кода:

google.accounts.id.intermediate.notifyParentClose()

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

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

google.accounts.id.intermediate.notifyParentDone()

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

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

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

высота

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

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

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

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

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

отмена

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