Справочник JavaScript API по поддержке промежуточных фреймов

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

Чтобы узнать, как использовать промежуточные фреймы, ознакомьтесь с руководством по интеграции One Tap с помощью 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.

проверкаНеудачный обратный вызов

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

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

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

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)

высота

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

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

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

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

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

отмена

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