Warning: This data is provided under the Google User Data Policy. Please review and comply with the policy. Failure to do so might result in project or account suspension.

Intermediate Iframe Support JavaScript API

This reference page describes the Intermediate Iframe Support JavaScript API, which allows you to manipulate the intermediate iframe in the subsequent UX.

The following table lists all available methods and their behaviors.

Methods
verifyParentOrigin performs the parent origin verification
notifyParentClose notifies the parent frame the One Tap UX flow is skipped
notifyParentDone notifies the parent frame the One Tap UX flow is done
notifyParentResize notifies the parent frame to resize the intermediate iframe
notifyParentTapOutsideMode notifies the parent frame whether to cancel the intermediate iframe when the user clicks outside the intermediate iframe

Load the Intermediate Iframe Support JavaScript Library

Place the following code snippet into any HTML pages where you want to load the intermediate iframe:

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

Method: google.accounts.id.intermediate.verifyParentOrigin

The google.accounts.id.intermediate.verifyParentOrigin method performs the parent origin verification. See the following code example of the method:

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

The following code example shows how to show UI only after the parent origin is verified:

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

The following table lists the parameters:

Parameter
origins The origins that are allowed to embed the intermediate iframe.
verifiedCallback The JavaScript callback method that will be triggered when current parent origin is allowed to embed the intermediate iframe.
verificationFailedCallback The JavaScript callback method that will be triggered when current parent origin is not allowed to embed the intermediate iframe.

origins

The origins that are allowed to embed the intermediate iframe. See the following table for further information:

Type Required Example
string, string array or function Optional allowed_parent_origin: "https://example.com"

The following table lists the supported value types and their descriptions.

Value Types
string A single domain URI. "https://example.com"
string array An array of domain URIs. "https://news.example.com,https://local.example.com"

verifiedCallback

This field is a JavaScript callback method that will be triggered when current parent origin is allowed to embed the intermediate iframe.

verificationFailedCallback

This field is a JavaScript callback method that will be triggered when current parent origin is not allowed to embed the intermediate iframe.

Method: google.accounts.id.intermediate.notifyParentClose

The google.accounts.id.intermediate.notifyParentClose method notifies the parent frame to close the intermediate iframe when the One Tap UX flow is skipped. See the following code example of the method:

google.accounts.id.intermediate.notifyParentClose()

Method: google.accounts.id.intermediate.notifyParentDone

The google.accounts.id.intermediate.notifyParentClose method notifies the parent frame to close the intermediate iframe, and refresh the login status. See the following code example of the method:

google.accounts.id.intermediate.notifyParentDone()

Method: google.accounts.id.intermediate.notifyParentResize

The google.accounts.id.intermediate.notifyParentResize method notifies the parent frame to resize the intermediate iframe. See the following code example of the method:

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

height

The new height in pixel. This is a required field. The value must be a non-negative number.

If the height parameter is bigger than 0, the intermediate iframe will be set to the new height. If the height parameter is 0, the intermediate iframe becomes invisible. A hidden iframe is not closed. It can be shown later by another resize method call.

Method: google.accounts.id.intermediate.notifyParentTapOutsideMode

The google.accounts.id.intermediate.notifyParentTapOutsideMode method notifies the parent frame whether to cancel the intermediate iframe when the user clicks outside the intermediate iframe. See the following code example of the method:

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

cancel

This required boolean value indicates whether to cancel the intermediate iframe when the user clicks outside the intermediate iframe.