API JavaScript de compatibilité intermédiaire intermédiaire

Cette page de référence décrit l'API JavaScript intermédiaire de compatibilité iFrame, qui vous permet de manipuler l'iFrame intermédiaire dans l'expérience utilisateur suivante.

Remarque : Consultez la section Intégrer en un seul geste via un iFrame pour obtenir des informations générales sur l'iFrame intermédiaire et l'expérience utilisateur ultérieure.

Le tableau suivant répertorie toutes les méthodes disponibles et leur comportement.

Méthodes
verifyParentOrigin	effectue la validation de l'origine parente
notifyParentClose	indique au cadre parent que le parcours d'expérience utilisateur One Tap est ignoré ;
notifyParentDone	indique au cadre parent que le parcours de l'expérience utilisateur One Tap est terminé.
notifyParentResize	indique au frame parent de redimensionner l'iFrame intermédiaire.
notifyParentTapOutsideMode	Indique au frame parent s'il faut annuler le iFrame intermédiaire lorsque l'utilisateur clique en dehors du cadre iFrame intermédiaire.

Charger la bibliothèque JavaScript de l'assistance iFrame intermédiaire

Insérez l'extrait de code suivant dans les pages HTML sur lesquelles vous souhaitez charger l'iFrame intermédiaire:

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

Méthode: google.accounts.id.intermédiaire.verifyParentOrigin

La méthode google.accounts.id.intermediate.verifyParentOrigin vérifie l'origine parente. Consultez l'exemple de code suivant pour cette méthode:

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

L'exemple de code suivant montre comment afficher l'interface utilisateur 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:

Paramètre
origins	Origines autorisées à intégrer l'iFrame intermédiaire.
verifiedCallback	Méthode de rappel JavaScript qui est déclenchée lorsque l'origine du parent actuel est autorisée à intégrer l'iFrame intermédiaire.
verificationFailedCallback	Méthode de rappel JavaScript qui est déclenchée lorsque l'origine parente actuelle n'est pas autorisée à intégrer l'iFrame intermédiaire.

origines

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

Type	Obligatoire	Exemple
chaîne, tableau de chaînes ou fonction	Facultative	allowed_parent_origin: "https://example.com"

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

Types de valeurs
string	Un seul URI de domaine.	"https://example.com"
string array	Tableau d'URI de domaine.	"https://news.example.com/https://local.example.com"

Remarque:Une chaîne comportant des URI séparés par une virgule n'est pas valide. Utilisez plutôt un objet JavaScript Array.

rappel validé

Ce champ est une méthode de rappel JavaScript qui est 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 qui est déclenchée lorsque l'origine du parent actuel n'est pas autorisée à intégrer l'iFrame intermédiaire.

Avertissement:Si la page de contenu ne répond pas à la demande de validation du domaine, le processus de validation attend indéfiniment. Dans ce cas, ni verifiedCallback, ni verificationFailedCallback ne seront appelés.

Méthode: google.accounts.id.intermédiaire.notifyParentClose

La méthode google.accounts.id.intermediate.notifyParentClose indique au cadre parent de fermer l'iFrame intermédiaire lorsque le flux d'expérience utilisateur One Tap est ignoré. Consultez l'exemple de code suivant pour cette méthode:

google.accounts.id.intermediate.notifyParentClose()

Méthode: google.accounts.id.intermédiaire.notifyParentDone

La méthode google.accounts.id.intermediate.notifyParentClose indique au cadre parent de fermer l'iFrame intermédiaire et d'actualiser l'état de connexion. Consultez l'exemple de code suivant pour cette méthode:

google.accounts.id.intermediate.notifyParentDone()

Méthode: google.accounts.id.intermédiaire.notifyParentRedimensionner

La méthode google.accounts.id.intermediate.notifyParentResize indique au cadre parent de redimensionner l'iFrame intermédiaire. Consultez l'exemple de code suivant de la méthode:

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

Remarque:Vous ne pouvez pas modifier la largeur de l'iFrame intermédiaire.

hauteur

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

Si le paramètre de hauteur est supérieur à 0, l'iFrame intermédiaire sera défini sur la nouvelle hauteur. Si le paramètre de hauteur est 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.intermédiaire.notifyParentTapOutsideMode

La méthode google.accounts.id.intermediate.notifyParentTapOutsideMode indique au cadre parent s'il faut 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 si l'iFrame intermédiaire est annulé lorsque l'utilisateur clique en dehors du cadre iFrame intermédiaire.