このページは、2020 年にサポートが終了した Chrome アプリプラットフォームに関するドキュメントの一部です。Enterprise および Education のお客様については、少なくとも 2025 年 1 月までは ChromeOS で引き続きサポートされます。詳しくは、アプリの移行をご覧ください。

このページは Cloud Translation API によって翻訳されました。

chrome.webviewTag

説明

webview タグを使用すると、ライブコンテンツをネットワーク経由でアクティブに読み込み、Chrome アプリに埋め込めます。アプリでは、webview の外観の制御、ウェブコンテンツの操作、埋め込みウェブページでのナビゲーションの開始、内部で発生したエラーイベントへの対応などを行うことができます（使用方法をご覧ください）。

権限

webview

型

ClearDataOptions

clearData で消去するデータを決定するオプション。

プロパティ

開始:

number（省略可）

この日付以降に蓄積されたクリアデータ。エポックからのミリ秒数で表されます（JavaScript Date オブジェクトの getTime メソッドでアクセスできます）。指定されていない場合のデフォルトは 0 です（すべての閲覧データが削除されます）。

ClearDataTypeSet

データ型のセット。欠落しているプロパティは false として解釈されます。

プロパティ

appcache

ブール値（省略可）

ウェブサイトのアプリキャッシュ。
cache

ブール値（省略可）

Chrome 44 以降

Chrome 43 以降。ブラウザのキャッシュ。注: データを削除すると、指定した範囲に限定されず、キャッシュ全体が削除されます。
Cookie

ブール値（省略可）

パーティションの Cookie。
fileSystems

ブール値（省略可）

ウェブサイトのファイルシステム。
indexedDB

ブール値（省略可）

ウェブサイトの IndexedDB データ。
localStorage

ブール値（省略可）

ウェブサイトのローカルストレージデータ。
persistentCookies

ブール値（省略可）

Chrome 58 以降

パーティションの永続的な Cookie。
sessionCookies

ブール値（省略可）

Chrome 58 以降

パーティションのセッション Cookie。
webSQL

ブール値（省略可）

ウェブサイトの WebSQL データ。

ContentScriptDetails

Chrome 44 以降

挿入するコンテンツスクリプトの詳細。詳しくは、コンテンツスクリプトのドキュメントをご覧ください。

プロパティ

all_frames

ブール値（省略可）

all_frames が true の場合は、JavaScript または CSS を現在のページのすべてのフレームに挿入する必要があります。デフォルトでは、all_frames は false であり、JavaScript または CSS はトップフレームにのみ挿入されます。
css

InjectionItems 省略可

一致するページに挿入する CSS コードまたは CSS ファイルのリストです。これらは、ページに対して DOM が構築または表示される前に、表示された順序で挿入されます。
exclude_globs

string[] 省略可

この glob に一致する URL を除外するために、一致後に適用されます。@exclude Greasemonkey キーワードをエミュレートすることを目的としています。
exclude_matches

string[] 省略可

このコンテンツのスクリプトが挿入されるページは除外されます。
include_globs

string[] 省略可

一致後、この glob にも一致する URL のみが含まれるように適用されます。@include Greasemonkey キーワードをエミュレートすることを目的としています。
js

InjectionItems 省略可

一致するページに挿入する JavaScript コードまたは JavaScript ファイルのリスト。これらは表示された順序で挿入されます。
match_about_blank

ブール値（省略可）

about:blank と about:srcdoc にコンテンツスクリプトを挿入するかどうか。コンテンツスクリプトがページに挿入されるのは、その継承 URL が、matchs フィールド内で宣言されたパターンのいずれかと一致した場合のみです。継承 URL は、フレームまたはウィンドウを作成したドキュメントの URL です。コンテンツスクリプトをサンドボックス化されたフレームに挿入することはできません。
一致

string[]

このコンテンツのスクリプトを挿入するページを指定します。
name

文字列

挿入するコンテンツスクリプトの名前。
run_at

RunAt（省略可）

JavaScript または CSS がタブに挿入される最短時間。デフォルトは「document_idle」です。

ContentWindow

ゲストウィンドウへのメッセージハンドル。

プロパティ

postMessage

void

埋め込みコンテンツが元のページを表示している限り、埋め込みウェブコンテンツにメッセージを投稿します。このメソッドは、ページの読み込みが完了すると使用可能になります。contentload イベントをリッスンし、メソッドを呼び出します。

ゲストは、受信したメッセージイベントで event.source にメッセージを投稿することで、エンベダに返信できます。

この API は、ウェブページ間の通信に使用される HTML5 postMessage API と同じです。エンベダーは、自身のフレームに message イベントリスナーを追加することで、レスポンスをリッスンできます。

postMessage 関数は次のようになります。
```
(message: any,targetOrigin: string)=> {...}
```
- メッセージ
  
  任意
  
  ゲストに送信するメッセージオブジェクト。
- targetOrigin
  
  文字列
  
  イベントをディスパッチするために必要となるゲストウィンドウのオリジンを指定します。

ContextMenuCreateProperties

Chrome 44 以降

プロパティ

ON

ブール値（省略可）

チェックボックスまたはラジオボタンの初期状態。オンの場合は true、選択解除の場合は false です。1 つのラジオアイテムの特定のグループで、一度に選択できるラジオアイテムは 1 つのみです。
コンテキスト

[ContextType,...ContextType[]] 省略可

このメニュー項目が表示されるコンテキストのリスト。指定しない場合のデフォルトは ['page'] です。
documentUrlPatterns

string[] 省略可

指定したパターンのいずれかに一致する URL を持つドキュメントにのみアイテムを適用するよう制限できます。（これはフレームについても同様です）。パターンの形式の詳細については、一致パターンをご覧ください。
有効

ブール値（省略可）

このコンテキストメニュー項目が有効か無効か。デフォルトは true です。
id

string（省略可）

このアイテムに割り当てる一意の ID です。イベントページでは必須。この拡張機能の別の ID と同じにすることはできません。
parentId

string|number（省略可）

親メニューアイテムの ID。これにより、アイテムは以前に追加されたアイテムの子になります。
targetUrlPatterns

string[] 省略可

documentUrlPatterns と似ていますが、img/audio/video タグの src 属性とアンカータグの href に基づいてフィルタできます。
title

string（省略可）

アイテムに表示されるテキスト。type が「区切り記号」でない限り、必須です。コンテキストが「selection」の場合、文字列内で %s を使用すると、選択したテキストを表示できます。たとえば、このパラメータの値が「'%s' をピッグラテン語に翻訳」で、ユーザーが「クール」という単語を選択した場合、選択のコンテキストメニュー項目は「「クール」をピッグラテン語に翻訳」となります。
type

ItemType 省略可

メニュー項目のタイプ。指定しない場合のデフォルトは「normal」です。
onclick

void 省略可

メニュー項目がクリックされたときに呼び出される関数。

onclick 関数は次のようになります。
```
(info: OnClickData)=> {...}
```
- 情報
  
  OnClickData
  
  クリックされたアイテムに関する情報と、クリックが発生した状況。

ContextMenus

Chrome 44 以降

プロパティ

onShow

イベント<functionvoidvoid>

この webview でコンテキストメニューが表示される前に呼び出されます。event.preventDefault() を呼び出すことで、このコンテキストメニューを無効にするために使用できます。

onShow.addListener 関数は次のようになります。
```
(callback: function)=> {...}
```
- callback
  
  機能
  
  callback パラメータは次のようになります。
```
(event: object)=>void
```
  - event
    
    オブジェクト
    
    preventDefault
    
    void
    
    呼び出すと、コンテキストメニューが表示されなくなります。
    
    preventDefault 関数は次のようになります。
    ()=> {...}
create

void

新しいコンテキストメニュー項目を作成します。作成中にエラーが発生した場合は、作成コールバックが呼び出されるまで確認できないことがあります（詳細は runtime.lastError にあります）。

create 関数は次のようになります。
```
(createProperties: object,callback?: function)=> {...}
```
- createProperties
  
  オブジェクト
  
  アイテムの作成に使用されるプロパティ
- callback
  
  関数（省略可）
  
  callback パラメータは次のようになります。
```
()=>void
```
- 戻り値
  string|number
  
  新しく作成されたアイテムの ID。
remove

void

コンテキストメニュー項目を削除します。

remove 関数は次のようになります。
```
(menuItemId: string|number,callback?: function)=> {...}
```
- menuItemId
  
  string|number
  
  削除するコンテキストメニュー項目の ID。
- callback
  
  関数（省略可）
  
  callback パラメータは次のようになります。
```
()=>void
```
removeAll

void

この webview に追加されたすべてのコンテキストメニュー項目を削除します。

removeAll 関数は次のようになります。
```
(callback?: function)=> {...}
```
- callback
  
  関数（省略可）
  
  callback パラメータは次のようになります。
```
()=>void
```
update

void

以前に作成したコンテキストメニュー項目を更新します。

update 関数は次のようになります。
```
(id: string|number,updateProperties: object,callback?: function)=> {...}
```
- id
  
  string|number
  
  更新する商品アイテムの ID。
- updateProperties
  
  オブジェクト
  
  更新するプロパティ。create 関数と同じ値を受け入れます。
- callback
  
  関数（省略可）
  
  callback パラメータは次のようになります。
```
()=>void
```

ContextMenuUpdateProperties

Chrome 44 以降

プロパティ

ON

ブール値（省略可）

チェックボックスまたはラジオボタンの状態。オンの場合は true、選択解除の場合は false です。1 つのラジオアイテムの特定のグループで、一度に選択できるラジオアイテムは 1 つのみです。
コンテキスト

[ContextType,...ContextType[]] 省略可

このメニュー項目が表示されるコンテキストのリスト。
documentUrlPatterns

string[] 省略可

指定したパターンのいずれかに一致する URL を持つドキュメントにのみアイテムを適用するよう制限できます。（これはフレームについても同様です）。パターンの形式の詳細については、一致パターンをご覧ください。
有効

ブール値（省略可）

このコンテキストメニュー項目が有効か無効か。
parentId

string|number（省略可）

親メニューアイテムの ID。これにより、アイテムは以前に追加されたアイテムの子になります。注: アイテムをその子孫の子に変更することはできません。
targetUrlPatterns

string[] 省略可

documentUrlPatterns と似ていますが、img/audio/video タグの src 属性とアンカータグの href に基づいてフィルタできます。
title

string（省略可）

アイテムに表示されるテキストです。
type

ItemType 省略可

メニュー項目のタイプ。
onclick

void 省略可

メニュー項目がクリックされたときに呼び出される関数。

onclick 関数は次のようになります。
```
(info: OnClickData)=> {...}
```
- 情報
  
  OnClickData
  
  クリックされたアイテムに関する情報と、クリックが発生した状況。

ContextType

Chrome 44 以降

メニューが表示されるさまざまなコンテキスト。「all」を指定すると、他のすべてのコンテキストを組み合わせるのと同じことになります。

列挙型

"frame"

"selection"

"image"

"audio"

DialogController

dialog DOM イベントにアタッチされたインターフェース。

プロパティ

cancel

void

ダイアログを拒否する。[confirm] または [prompt] ダイアログで [キャンセル] をクリックするのと同じです。

cancel 関数は次のようになります。
```
()=> {...}
```
OK

void

ダイアログに同意します。これは、alert、confirm、prompt のダイアログで [OK] をクリックするのと同じです。

ok 関数は次のようになります。
```
(response?: string)=> {...}
```
- レスポンス
  
  string（省略可）
  
  prompt ダイアログを受け入れるときにゲストに提供するレスポンス文字列。

DownloadPermissionRequest

download permissionrequest DOM イベントに伴う request オブジェクトのタイプ。

プロパティ

requestMethod

文字列

ダウンロードリクエストに関連付けられた HTTP リクエストタイプ（例: GET）。
URL

文字列

リクエストされたダウンロード URL。
allow

void

権限リクエストを許可します。

allow 関数は次のようになります。
```
()=> {...}
```
拒否

void

権限リクエストを拒否します。allow が呼び出されない場合、これがデフォルトの動作です。

deny 関数は次のようになります。
```
()=> {...}
```

FileSystemPermissionRequest

filesystem permissionrequest DOM イベントに伴う request オブジェクトのタイプ。

プロパティ

URL

文字列

ローカルファイルシステムへのアクセスをリクエストするフレームの URL。
allow

void

権限リクエストを許可します。

allow 関数は次のようになります。
```
()=> {...}
```
拒否

void

権限リクエストを拒否します。

deny 関数は次のようになります。
```
()=> {...}
```

FindCallbackResults

検索リクエストのすべての結果が含まれます。

プロパティ

activeMatchOrdinal

数値

現在の一致の序数。
キャンセル済み

boolean

この検索リクエストがキャンセルされたかどうかを示します。
numberOfMatches

数値

ページで searchText が一致した回数。
selectionRect

SelectionRect

画面座標でアクティブな一致を囲む長方形を表示します。

FindOptions

検索リクエストのオプション。

プロパティ

後ろ

ブール値（省略可）

逆の順序で一致を検索するフラグ。デフォルト値は false です。
matchCase

ブール値（省略可）

大文字と小文字を区別するフラグ。デフォルト値は false です。

FullscreenPermissionRequest

Chrome 43 以降

fullscreen permissionrequest DOM イベントに伴う request オブジェクトのタイプ。

プロパティ

出所

文字列

全画面表示リクエストを開始した webview 内のフレームの起点。
allow

void

権限リクエストを許可します。

allow 関数は次のようになります。
```
()=> {...}
```
拒否

void

権限リクエストを拒否します。

deny 関数は次のようになります。
```
()=> {...}
```

GeolocationPermissionRequest

geolocation permissionrequest DOM イベントに伴う request オブジェクトのタイプ。

プロパティ

URL

文字列

位置情報データへのアクセスをリクエストするフレームの URL。
allow

void

権限リクエストを許可します。

allow 関数は次のようになります。
```
()=> {...}
```
拒否

void

権限リクエストを拒否します。allow が呼び出されない場合、これがデフォルトの動作です。

deny 関数は次のようになります。
```
()=> {...}
```

HidPermissionRequest

保留中

hid permissionrequest DOM イベントに伴う request オブジェクトのタイプ。

プロパティ

URL

文字列

HID API へのアクセスをリクエストするフレームの URL。
allow

void

権限リクエストを許可します。

allow 関数は次のようになります。
```
()=> {...}
```
拒否

void

権限リクエストを拒否します。allow が呼び出されない場合、これがデフォルトの動作です。

deny 関数は次のようになります。
```
()=> {...}
```

InjectDetails

挿入するスクリプトまたは CSS の詳細。コードまたはファイルプロパティのいずれかを設定する必要がありますが、両方を同時に設定することはできません。

プロパティ

コード

string（省略可）

挿入する JavaScript または CSS コード。

警告: code パラメータは慎重に使用してください。使い方を間違えると、アプリがクロスサイトスクリプティング攻撃を受けるおそれがあります。
あなた宛てに表示されます。

string（省略可）

挿入する JavaScript または CSS ファイル。

InjectionItems

Chrome 44 以降

インジェクションアイテムのタイプ（コードまたはファイルのセット）。

プロパティ

コード

string（省略可）

一致するページに挿入する JavaScript コードまたは CSS。
ファイル

string[] 省略可

一致するページに挿入される JavaScript ファイルまたは CSS ファイルのリストです。これらは、この配列に出現する順序で挿入されます。

LoadPluginPermissionRequest

loadplugin permissionrequest DOM イベントに伴う request オブジェクトのタイプ。

プロパティ

identifier

文字列

プラグインの識別子の文字列。
name

文字列

プラグインの表示名。
allow

void

権限リクエストを許可します。deny が呼び出されない場合、これがデフォルトの動作です。

allow 関数は次のようになります。
```
()=> {...}
```
拒否

void

権限リクエストを拒否します。

deny 関数は次のようになります。
```
()=> {...}
```

MediaPermissionRequest

media permissionrequest DOM イベントに伴う request オブジェクトのタイプ。

プロパティ

URL

文字列

ユーザーメディアへのアクセスをリクエストするフレームの URL。
allow

void

権限リクエストを許可します。

allow 関数は次のようになります。
```
()=> {...}
```
拒否

void

権限リクエストを拒否します。allow が呼び出されない場合、これがデフォルトの動作です。

deny 関数は次のようになります。
```
()=> {...}
```

NewWindow

newwindow DOM イベントにアタッチされたインターフェース。

プロパティ

アタッチする

void

リクエストされたターゲットページを既存の webview 要素に追加します。

attach 関数は次のようになります。
```
(webview: object)=> {...}
```
- webview
  
  オブジェクト
  
  ターゲットページを関連付ける webview 要素。
破棄

void

新しいウィンドウのリクエストをキャンセルします。

discard 関数は次のようになります。
```
()=> {...}
```

PointerLockPermissionRequest

pointerLock permissionrequest DOM イベントに伴う request オブジェクトのタイプ。

プロパティ

lastUnlockedBySelf

boolean

リクエスト側のフレームが、ポインタロックを保持する最新のクライアントであったかどうか。
URL

文字列

ポインタロックをリクエストしているフレームの URL。
userGesture

boolean

ユーザーの入力操作の結果としてポインタのロックがリクエストされたかどうか。
allow

void

権限リクエストを許可します。

allow 関数は次のようになります。
```
()=> {...}
```
拒否

void

権限リクエストを拒否します。allow が呼び出されない場合、これがデフォルトの動作です。

deny 関数は次のようになります。
```
()=> {...}
```

SelectionRect

画面座標で長方形を記述します。

包含セマンティクスは配列のようなものです。つまり、座標 (left, top) は長方形に含まれているとみなされますが、座標 (left + width, top) は四角形に含まれていると見なされます。

プロパティ

身長

数値

長方形の高さ。
左

数値

画面の左端から長方形の左端までの距離。
上

数値

画面の上端から長方形の上端までの距離。
幅

数値

長方形の幅。

WebRequestEventInterface

Chrome 44 以降

ゲストページの webRequest イベントにアクセスするためのインターフェース。webRequest のライフサイクルと関連する概念について詳しくは、 chrome.webRequest 拡張機能 API をご覧ください。注: chrome.webRequest.onActionIgnored イベントは WebView ではサポートされていません。

拡張機能の webRequest API との使用方法の違いを説明するために、*://www.evil.com/* に一致する URL に対するゲストリクエストをすべてブロックする次のコード例について考えてみましょう。

webview.request.onBeforeRequest.addListener(
  function(details) { return {cancel: true}; },
  {urls: ["*://www.evil.com/*"]},
  ["blocking"]);

また、このインターフェースでは、onRequest イベントと onMessage イベントを通じて宣言型の webRequest ルールがサポートされています。API の詳細については、declarativeWebRequest をご覧ください。

宣言型 WebView の webRequest の条件とアクションは、対応する chrome.webViewRequest.* からインスタンス化する必要があります。次のサンプルコードは、WebView myWebview の "example.com" に対するすべてのリクエストを宣言的にブロックします。

var rule = {
  conditions: [
    new chrome.webViewRequest.RequestMatcher({ url: { hostSuffix: 'example.com' } })
  ],
  actions: [ new chrome.webViewRequest.CancelRequest() ]
};
myWebview.request.onRequest.addRules([rule]);

ZoomMode

Chrome 43 以降

webview でズームを処理する方法を定義します。

列挙型

"per-origin"
ズームの変更はズームされたページの原点に保持されます。つまり、同じパーティション内の同じ原点に移動する他のすべての WebView もズームされます。さらに、per-origin のズーム変更は原点とともに保存されます。つまり、同じ原点にある他のページに移動すると、それらはすべて同じズーム倍率にズームされます。

"per-view"
ズームの変更はこの WebView でのみ有効で、他の WebView でズームを変更してもこの WebView のズームには影響しません。また、per-view のズーム変更はナビゲーション時にリセットされます。WebView 内を移動すると、常にオリジンごとのズーム係数でページが読み込まれます（パーティションのスコープ内）。

"disabled"
WebView のすべてのズームを無効にします。コンテンツはデフォルトのズームレベルに戻り、試行されたズーム変更はすべて無視されます。

プロパティ

contentWindow

ゲストページにメッセージを投稿するために使用できるオブジェクト参照。

タイプ

ContentWindow

contextMenus

Chrome 44 以降

Chrome の ContextMenus API に似ていますが、ブラウザではなく webview に適用されます。webview のコンテキストメニューにアイテムを追加するには、webview.contextMenus API を使用します。画像、ハイパーリンク、ページなど、コンテキストメニューに追加するオブジェクトの種類を選択できます。

タイプ

ContextMenus

request

ゲストページの webRequest イベントにアクセスするためのインターフェース。

タイプ

WebRequestEventInterface

Methods

addContentScripts()

Chrome 44 以降

chrome.webviewTag.addContentScripts(
  contentScriptList: [ContentScriptDetails,...ContentScriptDetails[]],
)

コンテンツスクリプトインジェクションルールを webview に追加します。webview が 1 つ以上のルールに一致するページに移動すると、関連するスクリプトが挿入されます。プログラムでルールを追加したり、既存のルールを更新したりできます。

次の例では、「myRule」と「 anotherRule」の 2 つのルールを webview に追加します。

webview.addContentScripts([
  {
    name: 'myRule',
    matches: ['http://www.foo.com/*'],
    css: { files: ['mystyles.css'] },
    js: { files: ['jquery.js', 'myscript.js'] },
    run_at: 'document_start'
  },
  {
    name: 'anotherRule',
    matches: ['http://www.bar.com/*'],
    js: { code: "document.body.style.backgroundColor = 'red';" },
    run_at: 'document_end'
  }]);
 ...

// Navigates webview.
webview.src = 'http://www.foo.com';

スクリプトの挿入が必要になるまで、addContentScripts の呼び出しを延期できます。

次の例は、既存のルールを上書きする方法を示しています。

webview.addContentScripts([{
    name: 'rule',
    matches: ['http://www.foo.com/*'],
    js: { files: ['scriptA.js'] },
    run_at: 'document_start'}]);

// Do something.
webview.src = 'http://www.foo.com/*';
 ...
// Overwrite 'rule' defined before.
webview.addContentScripts([{
    name: 'rule',
    matches: ['http://www.bar.com/*'],
    js: { files: ['scriptB.js'] },
    run_at: 'document_end'}]);

webview がオリジン（foo.com など）に移動され、webview.addContentScripts を呼び出して「myRule」を追加した場合は、次のナビゲーションを待機してスクリプトを挿入する必要があります。すぐに挿入する場合は、executeScript が正しい処理を行います。

ゲストプロセスがクラッシュまたは強制終了した場合でも、または webview の親が変更された場合でも、ルールは保持されます。

詳しくは、コンテンツスクリプトのドキュメントをご覧ください。

パラメータ

contentScriptList

[ContentScriptDetails,...ContentScriptDetails[]]

追加するコンテンツスクリプトの詳細。

back()

chrome.webviewTag.back(
  callback?: function,
)

可能であれば、履歴エントリを 1 つ戻します。go(-1) と同じです。

パラメータ

callback

関数（省略可）

Chrome 44 以降

callback パラメータは次のようになります。
```
(success: boolean)=>void
```
- success
  
  boolean
  
  ナビゲーションが成功したかどうかを示します。

canGoBack()

chrome.webviewTag.canGoBack()

履歴をさかのぼって表示できるかどうかを示します。この関数の状態はキャッシュに保存され、loadcommit ごとに更新されるため、呼び出すのに最適な場所は loadcommit です。

戻り値

boolean

canGoForward()

chrome.webviewTag.canGoForward()

履歴を進むことができるかどうかを示します。この関数の状態はキャッシュに保存され、loadcommit ごとに更新されるため、呼び出すのに最適な場所は loadcommit です。

戻り値

boolean

captureVisibleRegion()

Chrome 50 以降

chrome.webviewTag.captureVisibleRegion(
  options?: ImageDetails,
  callback: function,
)

WebView の表示領域をキャプチャします。

パラメータ

オプション

ImageDetails 省略可
callback

機能

callback パラメータは次のようになります。
```
(dataUrl: string)=>void
```
- dataUrl
  
  文字列
  
  キャプチャしたタブの表示領域の画像をエンコードするデータ URL。HTML Image 要素の「src」プロパティに割り当てて表示できます。

clearData()

chrome.webviewTag.clearData(
  options: ClearDataOptions,
  types: ClearDataTypeSet,
  callback?: function,
)

webview パーティションの閲覧データを削除します。

パラメータ

オプション

ClearDataOptions

消去するデータを指定するオプション。
タイプ

ClearDataTypeSet

クリアするデータの種類。
callback

関数（省略可）

callback パラメータは次のようになります。
```
()=>void
```

executeScript()

chrome.webviewTag.executeScript(
  details: InjectDetails,
  callback?: function,
)

ゲストページに JavaScript コードを挿入します。

次のサンプルコードでは、スクリプトインジェクションを使用してゲストページの背景色を赤に設定しています。

webview.executeScript({ code: "document.body.style.backgroundColor = 'red'" });

パラメータ

詳細

InjectDetails

実行するスクリプトの詳細。
callback

関数（省略可）

callback パラメータは次のようになります。
```
(result?: any[])=>void
```
- 件の結果
  
  any[] 省略可
  
  挿入された各フレームのスクリプトの結果。

find()

chrome.webviewTag.find(
  searchText: string,
  options?: FindOptions,
  callback?: function,
)

ページ内検索リクエストを開始します。

パラメータ

searchText

文字列

ページ内で検索する文字列です。
オプション

FindOptions 省略可

検索リクエストのオプション。
callback

関数（省略可）

callback パラメータは次のようになります。
```
(results?: FindCallbackResults)=>void
```
- 結果
  
  FindCallbackResults 省略可
  
  検索リクエストのすべての結果が含まれます。コールバック関数本体で results が使用されていない場合は、省略できます。たとえば、検索リクエストが完了したタイミングを識別するためにのみコールバックを使用する場合などです。

forward()

chrome.webviewTag.forward(
  callback?: function,
)

可能であれば、履歴エントリを 1 つ進めます。go(1) と同じです。

パラメータ

callback

関数（省略可）

Chrome 44 以降

callback パラメータは次のようになります。
```
(success: boolean)=>void
```
- success
  
  boolean
  
  ナビゲーションが成功したかどうかを示します。

getAudioState()

Chrome 62 以降

chrome.webviewTag.getAudioState(
  callback: function,
)

音声の状態をクエリします。

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(audible: boolean)=>void
```
- Audible
  
  boolean

getProcessId()

chrome.webviewTag.getProcessId()

ゲストウェブページの現在のプロセスに対する Chrome の内部プロセス ID を返します。これにより、プロセスの終了によって影響を受けるゲストの数を埋め込み者が把握できるようになります。2 人のゲストは、同じアプリに属し、同じストレージパーティション ID を持つ場合に限り、プロセスを共有します。この呼び出しは同期的であり、エンベダーがキャッシュした現在のプロセス ID の概念を返します。プロセス ID は、オペレーティングシステムのプロセス ID とは異なります。

戻り値

数値

getUserAgent()

chrome.webviewTag.getUserAgent()

ゲストページのリクエストに対して webview が使用するユーザーエージェント文字列を返します。

戻り値

文字列

getZoom()

chrome.webviewTag.getZoom(
  callback: function,
)

現在のズーム倍率を取得します。

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(zoomFactor: number)=>void
```
- zoomFactor
  
  数値
  
  現在のズーム倍率。

getZoomMode()

Chrome 43 以降

chrome.webviewTag.getZoomMode(
  callback: function,
)

現在のズームモードを取得します。

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(ZoomMode: ZoomMode)=>void
```
- ZoomMode
  
  ZoomMode
  
  webview の現在のズームモード。

go()

chrome.webviewTag.go(
  relativeIndex: number,
  callback?: function,
)

現在のナビゲーションに対応する履歴インデックスを使用して、履歴エントリに移動します。リクエストされたナビゲーションが不可能な場合、このメソッドは効果がありません。

パラメータ

relativeIndex

数値

webview の移動先となる相対的な履歴インデックス。たとえば、値を 2 にすると、可能であれば 2 つの履歴エントリを進めることになります。-3 に設定すると、3 つのエントリが前に戻ります。
callback

関数（省略可）

callback パラメータは次のようになります。
```
(success: boolean)=>void
```
- success
  
  boolean
  
  ナビゲーションが成功したかどうかを示します。

insertCSS()

chrome.webviewTag.insertCSS(
  details: InjectDetails,
  callback?: function,
)

CSS をゲストページに挿入します。

パラメータ

詳細

InjectDetails

挿入する CSS の詳細です。
callback

関数（省略可）

callback パラメータは次のようになります。
```
()=>void
```

isAudioMuted()

Chrome 62 以降

chrome.webviewTag.isAudioMuted(
  callback: function,
)

音声がミュートされているかどうかをクエリします。

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(muted: boolean)=>void
```
- ミュート中
  
  boolean

isSpatialNavigationEnabled()

Chrome 71 以降

chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
)

WebView で空間ナビゲーションが有効になっているかどうかをクエリします。

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(enabled: boolean)=>void
```
- 有効
  
  boolean

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden()

webview のユーザーエージェント文字列が webviewTag.setUserAgentOverride によってオーバーライドされているかどうかを示します。

loadDataWithBaseUrl()

chrome.webviewTag.loadDataWithBaseUrl(
  dataUrl: string,
  baseUrl: string,
  virtualUrl?: string,
)

相対リンクに使用する指定されたベース URL を持つデータ URL を読み込みます。必要に応じて、データ URL の代わりに仮想 URL をユーザーに表示することもできます。

パラメータ

dataUrl

文字列

読み込むデータの URL。
baseUrl

文字列

相対リンクに使用されるベース URL。
virtualUrl

string（省略可）

ユーザーに表示される URL（アドレスバー内）。

print()

chrome.webviewTag.print()

webview の内容を出力します。これは、webview 自体からスクリプトされた出力関数を呼び出すのと同じです。

reload()

chrome.webviewTag.reload()

現在の最上位ページを再読み込みします。

removeContentScripts()

Chrome 44 以降

chrome.webviewTag.removeContentScripts(
  scriptNameList?: string[],
)

webview からコンテンツスクリプトを削除します。

次の例では、前に追加された「myRule」を削除します。

webview.removeContentScripts(['myRule']);

すべてのルールを削除するには、次を呼び出します。

webview.removeContentScripts();

パラメータ

scriptNameList

string[] 省略可

削除されるコンテンツスクリプトの名前のリスト。リストが空の場合、webview に追加されたすべてのコンテンツスクリプトが削除されます。

setAudioMuted()

Chrome 62 以降

chrome.webviewTag.setAudioMuted(
  mute: boolean,
)

WebView の音声ミュート状態を設定します。

パラメータ

ミュート

boolean

音声をミュートする値

setSpatialNavigationEnabled()

Chrome 71 以降

chrome.webviewTag.setSpatialNavigationEnabled(
  enabled: boolean,
)

WebView の空間ナビゲーション状態を設定します。

パラメータ

有効

boolean

空間ナビゲーションの状態の値。

setUserAgentOverride()

chrome.webviewTag.setUserAgentOverride(
  userAgent: string,
)

ゲストページのリクエストに対して webview が使用するユーザーエージェント文字列をオーバーライドします。オーバーライドすると、User-Agent Client Hints ヘッダーの値と navigator.userAgentData によって返される値は、オーバーライドが適用されるゲストページリクエストで空になります。

パラメータ

userAgent

文字列

使用するユーザーエージェント文字列。

setZoom()

chrome.webviewTag.setZoom(
  zoomFactor: number,
  callback?: function,
)

ページのズーム倍率を変更します。この変更の範囲と永続性は、WebView の現在のズームモードによって決まります（webviewTag.ZoomMode を参照）。

パラメータ

zoomFactor

数値

新しいズーム倍率。
callback

関数（省略可）

callback パラメータは次のようになります。
```
()=>void
```

setZoomMode()

Chrome 43 以降

chrome.webviewTag.setZoomMode(
  ZoomMode: ZoomMode,
  callback?: function,
)

webview のズームモードを設定します。

パラメータ

ZoomMode

ZoomMode

webview でズームを処理する方法を定義します。
callback

関数（省略可）

callback パラメータは次のようになります。
```
()=>void
```

stop()

chrome.webviewTag.stop()

現在の webview ナビゲーションの読み込みが進行中の場合は、読み込みを停止します。

stopFinding()

chrome.webviewTag.stopFinding(
  action?: "clear" 
 |"keep" 
 |"activate" 
 ,
)

現在の検索セッションを終了し（すべてのハイライト表示をクリア）、進行中のすべての検索リクエストをキャンセルします。

パラメータ

action

省略可

検索セッションが終了した後にアクティブな一致をどのように処理するかを決定します。clear は、アクティブな一致のハイライト表示をクリアします。keep は、有効な一致をハイライト表示したままにします。activate は、有効な一致をハイライトしたままにして、その一致をユーザーがクリックする操作をシミュレートします。デフォルトのアクションは keep です。

terminate()

chrome.webviewTag.terminate()

ゲストウェブページのレンダラプロセスを強制終了します。同じプロセスを共有している場合、現在のアプリの複数の webview タグに影響する可能性がありますが、他のアプリの webview タグには影響しません。

イベント

close

chrome.webviewTag.close.addListener(
  callback: function,
)

ゲストウィンドウが自身を閉じようとしたときに呼び出されます。

次のサンプルコードは、ゲストが自身を閉じようとしたときに、webview を about:blank に移動させます。

webview.addEventListener('close', function() {
  webview.src = 'about:blank';
});

パラメータ

callback

機能

callback パラメータは次のようになります。
```
()=>void
```

consolemessage

chrome.webviewTag.consolemessage.addListener(
  callback: function,
)

ゲストウィンドウがコンソールメッセージをログに記録したときに呼び出されます。

次のサンプルコードでは、ログレベルやその他のプロパティに関係なく、すべてのログメッセージを埋め込みのコンソールに転送します。

webview.addEventListener('consolemessage', function(e) {
  console.log('Guest page logged a message: ', e.message);
});

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(level: number,message: string,line: number,sourceId: string)=>void
```
- level
  
  数値
- メッセージ
  
  文字列
- 線
  
  数値
- sourceId
  
  文字列

contentload

chrome.webviewTag.contentload.addListener(
  callback: function,
)

ゲストウィンドウが load イベントが発生したとき（新しいドキュメントが読み込まれたとき）に呼び出されます。これには、現在のドキュメント内のページナビゲーションや非同期リソースの読み込みは含まれません。

次のサンプルコードでは、ページの読み込み後にゲストの body 要素のデフォルトのフォントサイズを変更します。

webview.addEventListener('contentload', function() {
  webview.executeScript({ code: 'document.body.style.fontSize = "42px"' });
});

パラメータ

callback

機能

callback パラメータは次のようになります。
```
()=>void
```

dialog

chrome.webviewTag.dialog.addListener(
  callback: function,
)

ゲストウィンドウが window.alert、window.confirm、または window.prompt を介してモーダルダイアログを開こうとしたときに呼び出されます。

このイベントを処理すると、各イベントリスナーが戻るか、dialog オブジェクトに到達不能になるまで（preventDefault() が呼び出された場合）、ゲストプロセスがブロックされます。

デフォルトの動作では、ダイアログはキャンセルされます。

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(messageType: "alert" 
 |"confirm" 
 |"prompt" 
 ,messageText: string,dialog: DialogController)=>void
```
- messageType
- messageText
  
  文字列
- ダイアログ
  
  DialogController

exit

chrome.webviewTag.exit.addListener(
  callback: function,
)

ゲストウェブコンテンツのレンダリングプロセスが終了したときに呼び出されます。

次のサンプルコードは、ゲストページがクラッシュするたびに、終了メッセージを表示します。

webview.addEventListener('exit', function(e) {
  if (e.reason === 'crash') {
    webview.src = 'data:text/plain,Goodbye, world!';
  }
});

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(processID: number,reason: "normal" 
 |"abnormal" 
 |"crash" 
 |"kill" 
 )=>void
```
- processID
  
  数値
- reason

findupdate

chrome.webviewTag.findupdate.addListener(
  callback: function,
)

アクティブな検索リクエストで新しい検索結果が利用可能になったときに発生します。これは、1 つの検索リクエストで一致するものが見つかると、複数回発生することがあります。

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(searchText: string,numberOfMatches: number,activeMatchOrdinal: number,selectionRect: SelectionRect,canceled: boolean,finalUpdate: string)=>void
```
- searchText
  
  文字列
- numberOfMatches
  
  数値
- activeMatchOrdinal
  
  数値
- selectionRect
  
  SelectionRect
- キャンセル済み
  
  boolean
- finalUpdate
  
  文字列

loadabort

chrome.webviewTag.loadabort.addListener(
  callback: function,
)

トップレベルの読み込みが commit されずに中止されると呼び出されます。イベントがデフォルトで禁止されている場合を除き、エラーメッセージがコンソールに出力されます。

注: リソースの読み込みが中止されると、最後の loadstop イベント（存在する場合）以降に commit された読み込みがすべて中止された場合でも、最終的には loadabort イベントの後で loadstop イベントが発生します。

注: about URL または JavaScript URL の読み込みが中止されると、loadabort が呼び出され、webview が「about:blank」に移動します。

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(url: string,isTopLevel: boolean,code: number,reason: "ERR_ABORTED" 
 |"ERR_INVALID_URL" 
 |"ERR_DISALLOWED_URL_SCHEME" 
 |"ERR_BLOCKED_BY_CLIENT" 
 |"ERR_ADDRESS_UNREACHABLE" 
 |"ERR_EMPTY_RESPONSE" 
 |"ERR_FILE_NOT_FOUND" 
 |"ERR_UNKNOWN_URL_SCHEME" 
 )=>void
```
- URL
  
  文字列
- isTopLevel
  
  boolean
- コード
  
  数値
- reason
  
  "ERR_ABORTED"
  |"ERR_INVALID_URL"
  |"ERR_DISALLOWED_URL_SCHEME"
  |"ERR_BLOCKED_BY_CLIENT"
  |"ERR_ADDRESS_UNREACHABLE"
  |"ERR_EMPTY_FILE_UNKNOWN
  "ERR_NOTY_RESPONSE"_
  |"

loadcommit

chrome.webviewTag.loadcommit.addListener(
  callback: function,
)

負荷が commit されると呼び出されます。これには、現在のドキュメント内のナビゲーションとサブフレームのドキュメントレベルの読み込みが含まれますが、非同期リソースの読み込みは含まれません。

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(url: string,isTopLevel: boolean)=>void
```
- URL
  
  文字列
- isTopLevel
  
  boolean

loadredirect

chrome.webviewTag.loadredirect.addListener(
  callback: function,
)

トップレベルの読み込みリクエストが別の URL にリダイレクトされたときに呼び出されます。

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(oldUrl: string,newUrl: string,isTopLevel: boolean)=>void
```
- oldUrl
  
  文字列
- newUrl
  
  文字列
- isTopLevel
  
  boolean

loadstart

chrome.webviewTag.loadstart.addListener(
  callback: function,
)

読み込みの開始時に呼び出されます。

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(url: string,isTopLevel: boolean)=>void
```
- URL
  
  文字列
- isTopLevel
  
  boolean

loadstop

chrome.webviewTag.loadstop.addListener(
  callback: function,
)

ゲストページ内のすべてのフレームレベルの読み込み（すべてのサブフレームを含む）が完了すると呼び出されます。これには、現在のドキュメント内のナビゲーションとサブフレームのドキュメントレベルの読み込みが含まれますが、非同期リソースの読み込みは含まれません。このイベントは、ドキュメントレベルの読み込み回数が 1 以上から 0 に遷移するたびに発生します。たとえば、読み込みがすでに完了しているページ（loadstop がすでに 1 回呼び出されている）は、ページを読み込む新しい iframe を作成し、iframe のページの読み込みが完了すると 2 つ目の loadstop を呼び出します。このパターンは、広告を読み込むページでよく見られます。

注: commit された読み込みが中止されると、最後の loadstop イベント（存在する場合）以降に commit された読み込みがすべて中止された場合でも、最終的に loadabort イベントに続いて loadstop イベントが発生します。

パラメータ

callback

機能

callback パラメータは次のようになります。
```
()=>void
```

newwindow

chrome.webviewTag.newwindow.addListener(
  callback: function,
)

ゲストページが新しいブラウザウィンドウを開こうとしたときに呼び出されます。

次のサンプルコードでは、リクエストされた新しいウィンドウごとに、新しい webview をエンベダーで作成して移動します。

webview.addEventListener('newwindow', function(e) {
  var newWebview = document.createElement('webview');
  document.body.appendChild(newWebview);
  e.window.attach(newWebview);
});

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(window: NewWindow,targetUrl: string,initialWidth: number,initialHeight: number,name: string,windowOpenDisposition: "ignore" 
 |"save_to_disk" 
 |"current_tab" 
 |"new_background_tab" 
 |"new_foreground_tab" 
 |"new_window" 
 |"new_popup" 
 )=>void
```
- クリックします。
  
  NewWindow
- targetUrl
  
  文字列
- initialWidth
  
  数値
- initialHeight
  
  数値
- name
  
  文字列
- windowOpenDisposition
  
  "ignore"
  |"save_to_disk"
  |"current_tab"
  |"new_background_tab"
  |"new_foreground_tab"
  |"new_window"
  |"new_popup"

permissionrequest

chrome.webviewTag.permissionrequest.addListener(
  callback: function,
)

ゲストページがエンベダーに特別な権限をリクエストする必要がある場合に呼び出されます。

次のサンプルコードは、ゲストページに webkitGetUserMedia API へのアクセス権を付与します。このサンプルコードを使用するアプリ自体が、audioCapture や videoCapture マニフェスト権限を指定する必要があります。

webview.addEventListener('permissionrequest', function(e) {
  if (e.permission === 'media') {
    e.request.allow();
  }
});

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(permission: "media" 
 |"geolocation" 
 |"pointerLock" 
 |"download" 
 |"loadplugin" 
 |"filesystem" 
 |"fullscreen" 
 |"hid" 
 ,request: object)=>void
```
- 権限
  
  "media"
  |"geolocation"
  |"pointerLock"
  |"ダウンロード"
  |"loadplugin"
  |"filesystem"
  |"fullscreen"
  |"hid"
- request
  
  オブジェクト

responsive

chrome.webviewTag.responsive.addListener(
  callback: function,
)

ゲストウェブコンテンツのレンダリングプロセスが応答しなくなった後、再び応答するようになったときに呼び出されます。

次のサンプルコードは、webview 要素が反応したり反応しなくなったりしたときに、フェードインまたはフェードアウトします。

webview.style.webkitTransition = 'opacity 250ms';
webview.addEventListener('unresponsive', function() {
  webview.style.opacity = '0.5';
});
webview.addEventListener('responsive', function() {
  webview.style.opacity = '1';
});

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(processID: number)=>void
```
- processID
  
  数値

sizechanged

chrome.webviewTag.sizechanged.addListener(
  callback: function,
)

埋め込まれたウェブコンテンツが autosize によってサイズ変更されると呼び出されます。autosize が有効になっている場合にのみ発生します。

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(oldWidth: number,oldHeight: number,newWidth: number,newHeight: number)=>void
```
- oldWidth
  
  数値
- oldHeight
  
  数値
- newWidth
  
  数値
- newHeight
  
  数値

unresponsive

chrome.webviewTag.unresponsive.addListener(
  callback: function,
)

ゲストウェブコンテンツをレンダリングするプロセスが応答しなくなったときに呼び出されます。ゲストが再び応答し始めると、一致するレスポンシブイベントとともにこの予定が 1 回生成されます。

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(processID: number)=>void
```
- processID
  
  数値

zoomchange

chrome.webviewTag.zoomchange.addListener(
  callback: function,
)

ページのズームが変更されたときに呼び出されます。

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(oldZoomFactor: number,newZoomFactor: number)=>void
```
- oldZoomFactor
  
  数値
- newZoomFactor
  
  数値