警告: このデータは Google ユーザーデータに関するポリシーに基づいて提供されています。ポリシーを確認して遵守してください。実際の広告でテストすると、プロジェクトまたはアカウントが停止される場合があります。

中間IframeサポートJavaScriptAPI

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

このリファレンスページでは、後続のUXで中間iframeを操作できる中間IframeサポートJavaScriptAPIについて説明します。

次の表に、使用可能なすべてのメソッドとその動作を示します。

メソッド
verifyParentOrigin親の起源の検証を実行します
notifyParentCloseワンタップUXフローがスキップされることを親フレームに通知します
notifyParentDoneワンタップUXフローが完了したことを親フレームに通知します
notifyParentResize中間iframeのサイズを変更するように親フレームに通知します
notifyParentTapOutsideModeユーザーが中間iframeの外側をクリックしたときに、中間iframeをキャンセルするかどうかを親フレームに通知します

中間IframeサポートJavaScriptライブラリをロードする

次のコードスニペットを、中間iframeをロードするHTMLページに配置します。

<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)

次のコード例は、親オリジンが検証された後にのみUIを表示する方法を示しています。

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

次の表に、パラメーターを示します。

パラメータ
origins中間iframeの埋め込みが許可されているオリジン。
verifiedCallback現在の親オリジンが中間iframeの埋め込みを許可されたときにトリガーされるJavaScriptコールバックメソッド。
verificationFailedCallback現在の親オリジンが中間iframeの埋め込みを許可されていない場合にトリガーされるJavaScriptコールバックメソッド。

起源

中間iframeの埋め込みが許可されているオリジン。詳細については、次の表を参照してください。

タイプ必須
文字列、文字列配列または関数オプションallowed_parent_origin: "https://example.com"

次の表に、サポートされている値の種類とその説明を示します。

値型
string単一ドメインURI。 「https://example.com」
string arrayドメインURIの配列。 「https://news.example.com,https://local.example.com」

検証済みコールバック

このフィールドは、現在の親オリジンが中間iframeの埋め込みを許可されたときにトリガーされるJavaScriptコールバックメソッドです。

verifyFailedCallback

このフィールドは、現在の親オリジンが中間iframeの埋め込みを許可されていない場合にトリガーされるJavaScriptコールバックメソッドです。

メソッド:google.accounts.id.intermediate.notifyParentClose

google.accounts.id.intermediate.notifyParentCloseメソッドは、 google.accounts.id.intermediate.notifyParentCloseフローがスキップされたときに中間iframeを閉じるように親フレームに通知します。メソッドの次のコード例を参照してください。

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)

高さ

ピクセル単位の新しい高さ。これは必要項目です。値は負でない数でなければなりません。

高さパラメータが0より大きい場合、中間iframeは新しい高さに設定されます。高さパラメータが0の場合、中間iframeは非表示になります。非表示のiframeは閉じられません。後で別のresizeメソッド呼び出しで表示できます。

メソッド:google.accounts.id.intermediate.notifyParentTapOutsideMode

google.accounts.id.intermediate.notifyParentTapOutsideModeメソッドは、ユーザーが中間iframeの外側をクリックしたときに中間iframeをキャンセルするかどうかを親フレームに通知します。メソッドの次のコード例を参照してください。

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

キャンセル

この必須のブール値は、ユーザーが中間iframeの外側をクリックしたときに中間iframeをキャンセルするかどうかを示します。