chrome.networking.onc

説明

chrome.networking.onc API は、ネットワーク接続（モバイル、イーサネット、VPN、Wi-Fi）の構成に使用されます。この API は、自動起動の ChromeOS キオスク セッションで使用できます。

ネットワーク接続の構成は、Open Network Configuration（ONC）仕様に従って指定されます。

注: ONC の仕様と一致するように、ほとんどのディクショナリ プロパティと列挙値では、JavaScript の lowerCamelCase 規則ではなく UpperCamelCase が使用されています。

権限

networking.onc

対象

Chrome 59 以降 ChromeOS のみ をご覧ください。

型

ActivationStateType

列挙型

「Activated」

「有効にしています」

「NotActivated」

「一部有効化」

CaptivePortalStatus

列挙型

「不明」

「オフライン」

オンライン

「ポータル」

"ProxyAuthRequired"

CellularProperties

プロパティ

  • ActivationState

    ActivationStateType 省略可

    携帯通信会社のアカウントの有効化状態。

  • ActivationType

    文字列（省略可）

    モバイル ネットワークの有効化タイプ。

  • AllowRoaming

    ブール値（省略可）

    ネットワークでローミングが許可されているかどうか。

  • AutoConnect

    ブール値（省略可）

    モバイル ネットワークを自動的に接続するかどうかを指定します（範囲内の場合）。

  • 家族向け

    文字列（省略可）

    モバイル デバイスの技術ファミリー - CDMA または GSM。

  • FirmwareRevision

    文字列（省略可）

    セルラーモデムに読み込まれたファームウェアのリビジョン。

  • FoundNetworks

    FoundNetworkProperties[] 省略可

    最新のネットワーク スキャンで検出されたネットワークのリスト。

  • HardwareRevision

    文字列（省略可）

    セルラーモデムのハードウェアのリビジョン。

  • HomeProvider

    CellularProviderProperties オプション

    モデムに現在挿入されている SIM カードの携帯通信会社に関する情報。

  • メーカー

    文字列（省略可）

    セルラーモデムのメーカー。

  • ModelID

    文字列（省略可）

    セルラーモデムのモデル ID。

  • NetworkTechnology

    文字列（省略可）

    モデムがネットワークに登録されている場合、現在使用しているネットワーク技術。

  • PaymentPortal

    PaymentPortal（オプション）

    ユーザーがモバイルデータ プランの申し込みや変更に使用できるオンライン決済ポータル。

  • RoamingState

    文字列（省略可）

    現在のネットワーク上のセルラーモデムのローミング状態。

  • SIMLockStatus

    SIMLockStatus （省略可）

    GSM ファミリー ネットワークの SIM ロックの状態。

  • SIMPresent

    ブール値（省略可）

    SIM カードが挿入されているかどうか。

  • スキャン

    ブール値（省略可）

    Chrome 63 以降

    モバイル ネットワーク スキャンが進行中の場合は true。

  • ServingOperator

    CellularProviderProperties オプション

    モデムが現在登録されているネットワークの事業者に関する情報。

  • SignalStrength

    数値（省略可）

    現在のネットワークの電波強度。

  • SupportNetworkScan

    ブール値（省略可）

    モバイル ネットワークがスキャンに対応しているかどうか。

CellularProviderProperties

プロパティ

  • コード

    文字列

    ネットワークの MCC（モバイル カントリー コード）と MNC（モバイル ネットワーク コード）を単純に連結したモバイル ネットワーク ID。

  • 国

    文字列（省略可）

    2 文字の国コード。

  • 名前

    文字列

    演算子名。

CellularStateProperties

プロパティ

CertificatePattern

プロパティ

  • EnrollmentURI

    文字列 [] 省略可

    このパターンに一致する証明書が見つからない場合にユーザーを転送できる URI のリスト。

  • 発行元

    IssuerSubjectPattern オプション

    設定した場合、X.509 発行者の設定と照合する必要があるパターン。

  • IssuerCARef

    文字列 [] 省略可

    認証局の CA 証明書のリスト。このパターンに一致するには、いずれかのプロバイダによって証明書が署名されている必要があります。

  • 件名

    IssuerSubjectPattern オプション

    設定した場合、X.509 サブジェクト設定と照合する必要があるパターン。

ClientCertificateType

列挙型

「Ref」

"パターン"

ConnectionStateType

列挙型

「接続済み」

「接続中」

「NotConnected」

DeviceStateProperties

プロパティ

  • SIMLockStatus

    SIMLockStatus （省略可）

    Chrome 62 以降

    Type = Cellular かつ SIMPresent = True の場合の SIM ロック ステータス。

  • SIMPresent

    ブール値（省略可）

    Chrome 62 以降

    デバイスタイプがモバイルの場合は、SIM 表示状態に設定します。

  • スキャン

    ブール値（省略可）

    デバイスが有効な場合に設定します。デバイスが現在スキャン中の場合は true。

  • デバイスの現在の状態。

  • タイプ

    NetworkType

    デバイスに関連付けられているネットワークの種類（モバイル、イーサネット、Wi-Fi）。

DeviceStateType

列挙型

「初期化されていません」
デバイスは使用可能ですが、初期化されていません。

「無効」
デバイスは初期化されていますが、有効になっていません。

"enabling"
有効な状態がリクエストされましたが、完了していません。

"Enabled"
デバイスは有効になっています。

「禁止」
デバイスは禁止されています。

EAPProperties

プロパティ

  • AnonymousIdentity

    文字列（省略可）

  • ClientCertPKCS11Id

    文字列（省略可）

    Chrome 60 以降
  • ClientCertPattern

    CertificatePattern オプション

  • ClientCertProvisioningProfileId

    文字列（省略可）

    Chrome 93 以降
  • ClientCertRef

    文字列（省略可）

  • ClientCertType

    ClientCertificateType

  • ID

    文字列（省略可）

  • 内部

    文字列（省略可）

  • 外部

    文字列（省略可）

    外側の EAP タイプ。ONC では必須ですが、Shill から翻訳する場合は指定できない場合があります。

  • パスワード

    文字列（省略可）

  • SaveCredentials

    ブール値（省略可）

  • ServerCAPEMs

    文字列 [] 省略可

  • ServerCARefs

    文字列 [] 省略可

  • SubjectMatch

    ManagedDOMString（省略可）

    Chrome 60 以降
  • UseProactiveKeyCaching

    ブール値（省略可）

  • UseSystemCAs

    ブール値（省略可）

EthernetProperties

プロパティ

  • 認証

    文字列（省略可）

    イーサネット ネットワークで使用される認証。有効な値は None と 8021X です。

  • AutoConnect

    ブール値（省略可）

    イーサネット ネットワークを自動的に接続するかどうか。

  • EAP

    EAPProperties オプション

    ネットワークの EAP 設定8021X 認証に必要です。

EthernetStateProperties

プロパティ

FoundNetworkProperties

プロパティ

  • LongName

    文字列（省略可）

    ネットワーク事業者の長い形式の名前。

  • NetworkId

    文字列

    ネットワーク ID。

  • ShortName

    文字列（省略可）

    ネットワーク事業者の短縮形式名。

  • ステータス

    文字列

    ネットワークの可用性。

  • テクノロジー

    文字列

    ネットワークで使用されるアクセス技術。

GlobalPolicy

プロパティ

  • AllowOnlyPolicyNetworksToAutoconnect

    ブール値（省略可）

    true の場合、ポリシー ネットワークのみが自動接続できます。デフォルトは false です。

  • AllowOnlyPolicyNetworksToConnect

    ブール値（省略可）

    true の場合、ポリシー ネットワークのみが接続でき、新しいネットワークの追加や設定はできません。デフォルトは false です。

  • AllowOnlyPolicyNetworksToConnectIfAvailable

    ブール値（省略可）

    Chrome 70 以降

    true で、管理対象ネットワークが表示ネットワークのリストで使用可能な場合、ポリシー ネットワークのみが接続でき、新しいネットワークを追加または設定することはできません。デフォルトは false です。

  • BlockedHexSSIDs

    文字列 [] 省略可

    Chrome 86 以降

    ブロック中のネットワークのリスト。ブロックされたネットワークへの接続は禁止されています。明示的なネットワーク構成を指定すると、ネットワークのブロックを解除できます。デフォルトは空のリストです。

IPConfigProperties

プロパティ

  • ExcludedRoutes

    文字列 [] 省略可

    Chrome 76 以降

    CIDR 表記の IP ブロックの配列。詳細については、onc_spec.md をご覧ください。

  • ゲートウェイ

    文字列（省略可）

    IP 構成に使用されるゲートウェイ アドレス。

  • IPAddress

    文字列（省略可）

    接続の IP アドレス。Type の値に応じて、IPv4 アドレスまたは IPv6 アドレスになります。

  • IncludedRoutes

    文字列 [] 省略可

    Chrome 76 以降

    CIDR 表記の IP ブロックの配列。詳細については、onc_spec.md をご覧ください。

  • NameServers

    文字列 [] 省略可

    ネームサーバーに使用されるアドレスの配列。

  • RoutingPrefix

    数値（省略可）

    ルーティングの接頭辞。

  • SearchDomains

    文字列 [] 省略可

    Chrome 76 以降

    名前解決用の文字列の配列。詳細については onc_spec.md をご覧ください。

  • タイプ

    文字列（省略可）

    IP 構成タイプ。IPv4 または IPv6 のいずれかです。

  • WebProxyAutoDiscoveryUrl

    文字列（省略可）

    DHCP 経由で報告された WEb プロキシ自動検出の URL。

IPConfigType

列挙型

「DHCP」

「静的」

IssuerSubjectPattern

プロパティ

  • CommonName

    文字列（省略可）

    設定されている場合、証明書のサブジェクトの共通名と一致させる値。

  • 地区

    文字列（省略可）

    設定されている場合、証明書のサブジェクトの共通の場所に一致する値。

  • 組織

    文字列（省略可）

    設定されている場合、証明書サブジェクトの組織と照合する値。少なくとも 1 つの組織がこの値に一致する必要があります。

  • OrganizationalUnit

    文字列（省略可）

    設定されている場合、証明書のサブジェクトの組織部門と照合する値。少なくとも 1 つの組織部門がこの値と一致する必要があります。

ManagedBoolean

プロパティ

  • 有効

    ブール値（省略可）

    ネットワーク構成マネージャーで現在使用されている有効な値（Shill など）。

  • DeviceEditable

    ブール値（省略可）

    プロパティの DevicePolicy が存在し、プロパティの編集が許可されているかどうか（つまり、ポリシーセットの推奨プロパティ値）。デフォルトは false です。

  • DevicePolicy

    ブール値（省略可）

    デバイス ポリシーで指定されているプロパティ値。

  • 発効

    文字列（省略可）

    有効なプロパティ値の決定元となったソース。

  • SharedSetting

    ブール値（省略可）

    デバイスのすべてのユーザーに設定された値。DeviceEditiable が true の場合にのみ指定します。

  • UserEditable

    ブール値（省略可）

    プロパティの UserPolicy が存在し、プロパティの編集が許可されているかどうか（ポリシーで設定された推奨プロパティ値など）。デフォルトは false です。

  • UserPolicy

    ブール値（省略可）

    ユーザー ポリシーで指定されたプロパティ値。

  • UserSetting

    ブール値（省略可）

    ログイン ユーザーが設定したプロパティ値。UserEditable が true の場合にのみ指定します。

ManagedCellularProperties

プロパティ

ManagedDOMString

プロパティ

  • 有効

    文字列（省略可）

    ネットワーク構成マネージャーで現在使用されている有効な値（Shill など）。

  • DeviceEditable

    ブール値（省略可）

    プロパティの DevicePolicy が存在し、プロパティの編集が許可されているかどうか（つまり、ポリシーセットの推奨プロパティ値）。デフォルトは false です。

  • DevicePolicy

    文字列（省略可）

    デバイス ポリシーで指定されているプロパティ値。

  • 発効

    文字列（省略可）

    有効なプロパティ値の決定元となったソース。

  • SharedSetting

    文字列（省略可）

    デバイスのすべてのユーザーに設定された値。DeviceEditiable が true の場合にのみ指定します。

  • UserEditable

    ブール値（省略可）

    プロパティの UserPolicy が存在し、プロパティの編集が許可されているかどうか（ポリシーで設定された推奨プロパティ値など）。デフォルトは false です。

  • UserPolicy

    文字列（省略可）

    ユーザー ポリシーで指定されているプロパティ値。

  • UserSetting

    文字列（省略可）

    ログイン ユーザーが設定したプロパティ値。UserEditable が true の場合にのみ指定します。

ManagedDOMStringList

プロパティ

  • 有効

    文字列 [] 省略可

    ネットワーク構成マネージャーで現在使用されている有効な値（Shill など）。

  • DeviceEditable

    ブール値（省略可）

    プロパティの DevicePolicy が存在し、プロパティの編集が許可されているかどうか（つまり、ポリシーセットの推奨プロパティ値）。デフォルトは false です。

  • DevicePolicy

    文字列 [] 省略可

    デバイス ポリシーで指定されているプロパティ値。

  • 発効

    文字列（省略可）

    有効なプロパティ値の決定元となったソース。

  • SharedSetting

    文字列 [] 省略可

    デバイスのすべてのユーザーに設定された値。DeviceEditiable が true の場合にのみ指定します。

  • UserEditable

    ブール値（省略可）

    プロパティの UserPolicy が存在し、プロパティの編集が許可されているかどうか（ポリシーで設定された推奨プロパティ値など）。デフォルトは false です。

  • UserPolicy

    文字列 [] 省略可

    ユーザー ポリシーで指定されているプロパティ値。

  • UserSetting

    文字列 [] 省略可

    ログイン ユーザーが設定したプロパティ値。UserEditable が true の場合にのみ指定します。

ManagedEthernetProperties

プロパティ

ManagedIPConfigProperties

プロパティ

ManagedIPConfigType

プロパティ

  • 有効

    IPConfigType 省略可

    ネットワーク構成マネージャーで現在使用されている有効な値（Shill など）。

  • DeviceEditable

    ブール値（省略可）

    プロパティの DevicePolicy が存在し、プロパティの編集が許可されているかどうか（つまり、ポリシーセットの推奨プロパティ値）。デフォルトは false です。

  • DevicePolicy

    IPConfigType 省略可

    デバイス ポリシーで指定されているプロパティ値。

  • 発効

    文字列（省略可）

    有効なプロパティ値の決定元となったソース。

  • SharedSetting

    IPConfigType 省略可

    デバイスのすべてのユーザーに設定された値。DeviceEditiable が true の場合にのみ指定します。

  • UserEditable

    ブール値（省略可）

    プロパティの UserPolicy が存在し、プロパティの編集が許可されているかどうか（ポリシーで設定された推奨プロパティ値など）。デフォルトは false です。

  • UserPolicy

    IPConfigType 省略可

    ユーザー ポリシーで指定されているプロパティ値。

  • UserSetting

    IPConfigType 省略可

    ログイン ユーザーが設定したプロパティ値。UserEditable が true の場合にのみ指定します。

ManagedLong

プロパティ

  • 有効

    数値（省略可）

    ネットワーク構成マネージャーで現在使用されている有効な値（Shill など）。

  • DeviceEditable

    ブール値（省略可）

    プロパティの DevicePolicy が存在し、プロパティの編集が許可されているかどうか（つまり、ポリシーセットの推奨プロパティ値）。デフォルトは false です。

  • DevicePolicy

    数値（省略可）

    デバイス ポリシーで指定されているプロパティ値。

  • 発効

    文字列（省略可）

    有効なプロパティ値の決定元となったソース。

  • SharedSetting

    数値（省略可）

    デバイスのすべてのユーザーに設定された値。DeviceEditiable が true の場合にのみ指定します。

  • UserEditable

    ブール値（省略可）

    プロパティの UserPolicy が存在し、プロパティの編集が許可されているかどうか（ポリシーで設定された推奨プロパティ値など）。デフォルトは false です。

  • UserPolicy

    数値（省略可）

    ユーザー ポリシーで指定されているプロパティ値。

  • UserSetting

    数値（省略可）

    ログイン ユーザーが設定したプロパティ値。UserEditable が true の場合にのみ指定します。

ManagedManualProxySettings

プロパティ

ManagedProperties

プロパティ

ManagedProxyLocation

プロパティ

ManagedProxySettings

プロパティ

ManagedProxySettingsType

プロパティ

  • 有効

    ProxySettingsType optional

    ネットワーク構成マネージャーで現在使用されている有効な値（Shill など）。

  • DeviceEditable

    ブール値（省略可）

    プロパティの DevicePolicy が存在し、プロパティの編集が許可されているかどうか（つまり、ポリシーセットの推奨プロパティ値）。デフォルトは false です。

  • DevicePolicy

    ProxySettingsType optional

    デバイス ポリシーで指定されているプロパティ値。

  • 発効

    文字列（省略可）

    有効なプロパティ値の決定元となったソース。

  • SharedSetting

    ProxySettingsType optional

    デバイスのすべてのユーザーに設定された値。DeviceEditiable が true の場合にのみ指定します。

  • UserEditable

    ブール値（省略可）

    プロパティの UserPolicy が存在し、プロパティの編集が許可されているかどうか（ポリシーで設定された推奨プロパティ値など）。デフォルトは false です。

  • UserPolicy

    ProxySettingsType optional

    ユーザー ポリシーで指定されているプロパティ値。

  • UserSetting

    ProxySettingsType optional

    ログイン ユーザーが設定したプロパティ値。UserEditable が true の場合にのみ指定します。

ManagedThirdPartyVPNProperties

プロパティ

ManagedVPNProperties

プロパティ

ManagedWiFiProperties

プロパティ

ManualProxySettings

プロパティ

  • FTPProxy

    ProxyLocation オプション

    FTP プロキシの設定。

  • HTTPProxy

    ProxyLocation オプション

    HTTP プロキシの設定。

  • ソックス

    ProxyLocation オプション

    SOCKS プロキシの設定。

  • SecureHTTPProxy

    ProxyLocation オプション

    安全な HTTP プロキシの設定。

NetworkConfigProperties

プロパティ

NetworkFilter

プロパティ

  • 構成済み

    ブール値（省略可）

    true の場合、構成（保存済み）ネットワークのみを含めます。デフォルトは「false」です。

  • limit

    数値（省略可）

    返されるネットワークの最大数。指定しない場合のデフォルトは 1,000 です。上限がない場合は 0 を使用します。

  • networkType

    NetworkType

    返されるネットワークのタイプ。

  • 表示

    ブール値（省略可）

    true の場合、可視（物理的に接続されている、または範囲内）のネットワークのみを含めます。デフォルトは「false」です。

NetworkProperties

プロパティ

  • モバイル

    CellularProperties オプション

    モバイル ネットワークの場合は、モバイル ネットワークのプロパティ。

  • 接続性の向上

    ブール値（省略可）

    ネットワークが接続可能かどうか。

  • ConnectionState

    ConnectionStateType optional

    ネットワークの現在の接続状態。

  • ErrorState

    文字列（省略可）

    最後に記録されたネットワーク エラーの状態。

  • イーサネット

    EthernetProperties（省略可）

    イーサネット ネットワークの場合、イーサネット ネットワークのプロパティ。

  • GUID

    文字列

    ネットワーク GUID。

  • IPAddressConfigType

    IPConfigType 省略可

    ネットワークの IP アドレス構成タイプ。

  • IPConfigs

    IPConfigProperties[] 省略可

    ネットワークの IP 構成。

  • MacAddress

    文字列（省略可）

    ネットワークの MAC アドレス。

  • 従量制

    ブール値（省略可）

    Chrome 85 以降

    ネットワークが従量制かどうか。

  • 名前

    文字列（省略可）

    ユーザー フレンドリーなネットワーク名。

  • NameServersConfigType

    IPConfigType 省略可

    ネットワークで使用されるネームサーバーの IP 構成タイプ。

  • 優先度

    数値（省略可）

    ネットワーク優先度。

  • ProxySettings

    ProxySettings（省略可）

    ネットワークのプロキシ設定。

  • RestrictedConnectivity

    ブール値（省略可）

    接続されたネットワークの場合、インターネットへのネットワーク接続が制限されているかどうか。例:ネットワークがポータルの背後にある場合や、モバイル ネットワークが有効になっていない場合。

  • SavedIPConfig

    IPConfigProperties（省略可）

    静的 IP 構成を適用する前に DHCP サーバーから受信した IP 構成。

  • ソース

    文字列（省略可）

    ネットワークが構成されているかどうかと、どのように構成されているかを示します。指定できる値は次のとおりです。

    • Device
    • DevicePolicy
    • User
    • UserPolicy
    • None

    'なし'拡張機能コードの生成と競合するため、「Source」には文字列を使用する必要があります。（SourceType 列挙型の代わりに）です。

  • StaticIPConfig

    IPConfigProperties（省略可）

    ネットワークの静的 IP 構成。

  • TrafficCounterResetTime

    数値（省略可）

    Chrome 125 以降

    トラフィック カウンタが最後にリセットされた日時。

  • タイプ

    NetworkType

    ネットワークの種類。

  • VPN

    VPNProperties（省略可）

    VPN ネットワークの場合、ネットワーク VPN のプロパティ。

  • Wi-Fi

    WiFiProperties （省略可）

    Wi-Fi ネットワークの場合、ネットワークの Wi-Fi プロパティ。

NetworkStateProperties

プロパティ

NetworkType

列挙型

すべて

「モバイル」

「イーサネット」

「テザー」

VPN

「ワイヤレス」

「Wi-Fi」

PaymentPortal

プロパティ

  • メソッド

    文字列

    支払いポータルに使用する HTTP メソッド。

  • PostData

    文字列（省略可）

    支払いポータルに送信する送信データ。Method が POST でない場合は無視されます。

  • URL

    文字列（省略可）

    支払いポータルの URL。

ProxyLocation

プロパティ

  • ホスト

    文字列

    プロキシ IP アドレスのホスト。

  • ポート

    数値

    プロキシに使用するポート。

ProxySettings

プロパティ

  • ExcludeDomains

    文字列 [] 省略可

    手動プロキシ設定が除外されているドメインとホスト。

  • 手動

    ManualProxySettings（省略可）

    手動プロキシ設定 - Manual のプロキシ設定にのみ使用します。

  • PAC

    文字列（省略可）

    プロキシ自動構成ファイルの URL。

  • タイプ

    ProxySettingsType

    プロキシ設定のタイプ。

ProxySettingsType

列挙型

「直接」

「手動」

「PAC」

「WPAD」

SIMLockStatus

プロパティ

  • LockEnabled

    ブール値

    SIM ロックが有効かどうか。

  • LockType

    文字列

    SIM ロックのステータス - 有効な値は 'sim-pin'、'sim-puk'、'' です。

  • RetriesLeft

    数値（省略可）

    SIM のロック解除に PUK が必要になるまで、PIN ロックの入力試行回数。

ThirdPartyVPNProperties

プロパティ

  • ExtensionID

    文字列

    サードパーティの VPN プロバイダの拡張機能の ID。

  • ProviderName

    文字列（省略可）

    VPN プロバイダ名。

VPNProperties

プロパティ

  • AutoConnect

    ブール値（省略可）

    VPN ネットワークを自動的に接続するかどうか。

  • ホスト

    文字列（省略可）

    VPN ホスト。

  • タイプ

    文字列（省略可）

    VPN タイプ。「L2TP-IPSec」のため、列挙型にすることはできません。これは、setProperties に渡される NetworkConfigProperties では省略可能で、特定のプロパティのみを設定する場合に使用できます。

VPNStateProperties

プロパティ

WiFiProperties

プロパティ

  • AllowGatewayARPPolling

    ブール値（省略可）

    デフォルト ゲートウェイの ARP ポーリングを許可するかどうか。デフォルトは true です。

  • AutoConnect

    ブール値（省略可）

    Wi-Fi ネットワークが範囲内にある場合に自動的に接続するかどうかを指定します。

  • BSSID

    文字列（省略可）

    関連付けられているアクセス ポイントの BSSID。

  • EAP

    EAPProperties オプション

    ネットワークの EAP のプロパティ。WEP-8021X ネットワークと WPA-EAP ネットワークの場合は必須です。

  • 頻度

    数値（省略可）

    Wi-Fi サービスの動作周波数（MHz 単位）。接続済みのネットワークの場合、現在接続している周波数。それ以外の場合、利用可能な最適な BSS の頻度。

  • FrequencyList

    数値 [] 省略可

    Wi-Fi ネットワークで最近確認されたすべての動作周波数が含まれます。

  • HexSSID

    文字列（省略可）

    ネットワーク SSID を 16 進数でエンコードしたコピー。

  • HiddenSSID

    ブール値（省略可）

    ネットワーク SSID をブロードキャストするかどうか。

  • パスフレーズ

    文字列（省略可）

    Chrome 66 以降

    WEP/WPA/WPA2 接続のパスフレーズこのプロパティは設定のみ可能です。この値は、getProperties が返すプロパティには含まれません。

  • RoamThreshold

    数値（省略可）

    非推奨、無視。

  • SSID

    文字列（省略可）

    ネットワークの SSID。

  • セキュリティ

    文字列（省略可）

    ネットワーク セキュリティの種類。

  • SignalStrength

    数値（省略可）

    ネットワークの電波強度。

WiFiStateProperties

プロパティ

WiMAXProperties

プロパティ

  • AutoConnect

    ブール値（省略可）

    ネットワークを自動的に接続するかどうか。

  • EAP

    EAPProperties オプション

    ネットワークの EAP のプロパティ。

メソッド

createNetwork()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.networking.onc.createNetwork(
  shared: boolean,
  properties: NetworkConfigProperties,
  callback?: function,
)

プロパティから新しいネットワーク構成を作成します。一致する構成済みのネットワークがすでに存在する場合、これは失敗します。それ以外の場合は、新しいネットワークの GUID を返します。

パラメータ

  • 共有

    ブール値

    true の場合、このネットワーク設定を他のユーザーと共有します。

    このオプションは Chrome のウェブ UI でのみ利用可能です*。アプリから呼び出される場合、指定できる値は false のみです。

  • プロパティ

    NetworkConfigProperties

    新しいネットワークの設定に使用するプロパティ。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: string) => void

    • 件の結果

      文字列

戻り値

  • Promise<文字列>

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

disableNetworkType()

chrome.networking.onc.disableNetworkType(
  networkType: NetworkType,
)

指定したネットワークの種類に一致するデバイスを無効にします。enableNetworkType の注記をご覧ください。

パラメータ

  • networkType

    NetworkType

    無効にするネットワークのタイプ。

enableNetworkType()

chrome.networking.onc.enableNetworkType(
  networkType: NetworkType,
)

指定したネットワークの種類に一致するデバイスをすべて有効にします。タイプは、複数のネットワーク タイプ（「ワイヤレス」など）を表す場合があります。

パラメータ

  • networkType

    NetworkType

    有効にするネットワークのタイプ。

forgetNetwork()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.networking.onc.forgetNetwork(
  networkGuid: string,
  callback?: function,
)

GUID が networkGuid のネットワークの構成済みプロパティをすべてクリアして、ネットワーク構成を消去します。これには、ID が一致する他のネットワーク（Wi-Fi SSID とセキュリティなど）も含まれる場合があります。このような構成が存在しない場合はエラーが設定され、オペレーションは失敗します。

キオスク セッションでは、この方法で共有ネットワーク設定を削除することはできません。

パラメータ

  • networkGuid

    文字列

    削除するネットワークの GUID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getCaptivePortalStatus()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.networking.onc.getCaptivePortalStatus(
  networkGuid: string,
  callback?: function,
)

「networkGuid」に一致するネットワークのキャプティブ ポータル ステータスを返します。

パラメータ

  • networkGuid

    文字列

    キャプティブ ポータルのステータスを取得するネットワークの GUID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: CaptivePortalStatus) => void

戻り値

  • Promise&lt;CaptivePortalStatus&gt;

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getDeviceStates()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.networking.onc.getDeviceStates(
  callback?: function,
)

使用可能なネットワーク デバイスの状態を返します。

パラメータ

戻り値

  • Promise&lt;DeviceStateProperties[]&gt;

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getGlobalPolicy()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.networking.onc.getGlobalPolicy(
  callback?: function,
)

グローバル ポリシーのプロパティを取得します。これらのプロパティはセッション中に変更されることは想定されていません。

パラメータ

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: GlobalPolicy) => void

戻り値

  • Promise&lt;GlobalPolicy&gt;

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getManagedProperties()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.networking.onc.getManagedProperties(
  networkGuid: string,
  callback?: function,
)

ID networkGuid を持つネットワークのマージされたプロパティ（ユーザー設定、共有設定、ユーザー ポリシー、デバイス ポリシー、現在アクティブな設定）をソースから取得します。

パラメータ

  • networkGuid

    文字列

    プロパティを取得するネットワークの GUID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: ManagedProperties) => void

戻り値

  • Promise&lt;ManagedProperties&gt;

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getNetworks()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.networking.onc.getNetworks(
  filter: NetworkFilter,
  callback?: function,
)

getState で指定されたプロパティと同じプロパティを持つネットワーク オブジェクトのリストを返します。返されるネットワークの種類を指定したり、ネットワークの数を制限したりするためのフィルタが用意されています。ネットワークは、優先度に基づいてシステムによって順序付けされ、接続済みのネットワークまたは接続中のネットワークが最初に表示されます。

パラメータ

戻り値

  • Promise&lt;NetworkStateProperties[]&gt;

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getProperties()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.networking.onc.getProperties(
  networkGuid: string,
  callback?: function,
)

ID が networkGuid のネットワークのすべてのプロパティを取得します。ネットワークのすべてのプロパティ（読み取り専用と読み取り/書き込みの値）が含まれます。

パラメータ

  • networkGuid

    文字列

    プロパティを取得するネットワークの GUID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: NetworkProperties) => void

戻り値

  • Promise&lt;NetworkProperties&gt;

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getState()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.networking.onc.getState(
  networkGuid: string,
  callback?: function,
)

ID が networkGuid であるネットワークの、キャッシュされた読み取り専用プロパティを取得します。これは、ネットワーキング サブシステムへのクエリにラウンド トリップが必要な getProperties よりもパフォーマンスの高い関数です。すべてのネットワークで、GUID、Type、Name、Wi-Fi.Security のプロパティが返されます。可視ネットワークの場合は、ConnectionState、ErrorState、Wi-Fi.SignalStrength、Cellular.NetworkTechnology、Cellular.ActivationState、Cellular.RoamingState という追加のプロパティが提供されます。

パラメータ

  • networkGuid

    文字列

    プロパティを取得するネットワークの GUID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: NetworkStateProperties) => void

戻り値

  • Promise&lt;NetworkStateProperties&gt;

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

requestNetworkScan()

chrome.networking.onc.requestNetworkScan(
  networkType?: NetworkType,
)

ネットワーク サブシステムに新しいネットワークをスキャンし、getVisibleNetworks から返されたリストを更新するようリクエストします。これは単なるリクエストであり、ネットワーク サブシステムはこれを無視することもできます。リストが更新されると、onNetworkListChanged イベントが発生します。

パラメータ

  • networkType

    NetworkType（省略可）

    Chrome 63 以降

    指定すると、タイプに固有のスキャンをリクエストします。モバイル ネットワークの場合、サポートされている場合はモバイル ネットワーク スキャンがリクエストされます。

setProperties()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.networking.onc.setProperties(
  networkGuid: string,
  properties: NetworkConfigProperties,
  callback?: function,
)

ID が networkGuid のネットワークのプロパティを設定します。これは、構成されたネットワークに対してのみ有効です（ソース != None）。未設定の可視ネットワークは、代わりに createNetwork を使用する必要があります。キオスク セッションでは、共有ネットワーク上でこのメソッドを呼び出すと失敗します。

パラメータ

  • networkGuid

    文字列

    プロパティを設定するネットワークの GUID。

  • プロパティ

    NetworkConfigProperties

    設定するプロパティ。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

startConnect()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.networking.onc.startConnect(
  networkGuid: string,
  callback?: function,
)

networkGuid を使用してネットワークへの接続を開始します。

パラメータ

  • networkGuid

    文字列

    接続先のネットワークの GUID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

startDisconnect()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.networking.onc.startDisconnect(
  networkGuid: string,
  callback?: function,
)

networkGuid を使用して、ネットワークからの切断を開始します。

パラメータ

  • networkGuid

    文字列

    接続解除するネットワークの GUID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

イベント

onDeviceStateListChanged

chrome.networking.onc.onDeviceStateListChanged.addListener(
  callback: function,
)

デバイスのリストが変更されたか、デバイスの状態プロパティが変更されたときに呼び出されます。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    () => void

onNetworkListChanged

chrome.networking.onc.onNetworkListChanged.addListener(
  callback: function,
)

ネットワークのリストが変更されたときに呼び出されます。現在のすべてのネットワークの GUID の完全なリストを送信します。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (changes: string[]) => void

    • 変更

      string[]

onNetworksChanged

chrome.networking.onc.onNetworksChanged.addListener(
  callback: function,
)

いずれかのネットワークでプロパティが変更されると呼び出されます。プロパティが変更されたネットワークの GUID のリストを送信します。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (changes: string[]) => void

    • 変更

      string[]

onPortalDetectionCompleted

chrome.networking.onc.onPortalDetectionCompleted.addListener(
  callback: function,
)

ネットワークのポータル検出が完了すると呼び出されます。ネットワークの GUID と対応するキャプティブ ポータルのステータスを送信します。

パラメータ