Documentation de référence sur l'API JavaScript de prise en charge des iFrames intermédiaires

Cette page de référence décrit l'API JavaScript de prise en charge des iFrames intermédiaires, utilisée par One Tap pour manipuler l'iFrame intermédiaire dans l'expérience utilisateur ultérieure.

Consultez le guide Intégrer One Tap à l'aide d'un iFrame pour savoir comment utiliser les iFrames intermédiaires.

Le tableau suivant répertorie toutes les méthodes disponibles et leurs comportements.

Charger la bibliothèque JavaScript de prise en charge des iFrames intermédiaires

Placez l'extrait de code suivant dans toutes les pages HTML où vous souhaitez charger l'iFrame intermédiaire :

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

Méthode : google.accounts.id.intermediate.verifyParentOrigin

La méthode google.accounts.id.intermediate.verifyParentOrigin effectue la validation de l'origine parente. Consultez l'exemple de code suivant de la méthode :

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

L'exemple de code suivant montre comment afficher l'UI uniquement après la validation de l'origine parente :

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

Le tableau suivant répertorie les paramètres :

origines

Origines autorisées à intégrer l'iFrame intermédiaire. Pour en savoir plus, consultez le tableau suivant :

Le tableau suivant répertorie les types de valeurs acceptés et leur description.

verifiedCallback

Ce champ est une méthode de rappel JavaScript déclenchée lorsque l'origine parente actuelle est autorisée à intégrer l'iFrame intermédiaire.

verificationFailedCallback

Ce champ est une méthode de rappel JavaScript déclenchée lorsque l'origine parente actuelle n'est pas autorisée à intégrer l'iFrame intermédiaire.

Méthode : google.accounts.id.intermediate.notifyParentClose

La méthode google.accounts.id.intermediate.notifyParentClose avertit le frame parent de fermer l'iframe intermédiaire lorsque le flux UX One Tap est ignoré. Consultez l'exemple de code suivant de la méthode :

google.accounts.id.intermediate.notifyParentClose()

Méthode : google.accounts.id.intermediate.notifyParentDone

La méthode google.accounts.id.intermediate.notifyParentClose avertit le frame parent de fermer l'iframe intermédiaire et d'actualiser l'état de connexion. Consultez l'exemple de code suivant de la méthode :

google.accounts.id.intermediate.notifyParentDone()

Méthode : google.accounts.id.intermediate.notifyParentResize

La méthode google.accounts.id.intermediate.notifyParentResize avertit le frame parent de redimensionner l'iframe intermédiaire. Consultez l'exemple de code suivant de la méthode :

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

hauteur

Nouvelle hauteur en pixels. Ce champ est obligatoire. La valeur doit être un nombre non négatif.

Si le paramètre de hauteur est supérieur à 0, l'iFrame intermédiaire est défini sur la nouvelle hauteur. Si le paramètre de hauteur est défini sur 0, l'iFrame intermédiaire devient invisible. Un iFrame masqué n'est pas fermé. Il peut être affiché ultérieurement par un autre appel de méthode de redimensionnement.

Méthode : google.accounts.id.intermediate.notifyParentTapOutsideMode

La méthode google.accounts.id.intermediate.notifyParentTapOutsideMode indique au frame parent s'il doit annuler l'iFrame intermédiaire lorsque l'utilisateur clique en dehors de celui-ci. Consultez l'exemple de code suivant de la méthode :

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

annuler

Cette valeur booléenne obligatoire indique s'il faut annuler l'iframe intermédiaire lorsque l'utilisateur clique en dehors de celui-ci.