Chrome Policy API

Chrome Policy API を使用すると、デバイスとユーザーの Chrome ポリシーを参照、変更できます。

  • Google 管理コンソールの互換性: API に加えた変更は Google 管理コンソールの UI にも反映され、その逆も同様です。

  • 監査ロギング: この API に加えた変更は、標準の管理監査ログに記録されます。

  • データ駆動アプローチ: Chrome ポリシーはデータとして表現され、API インターフェースによって直接参照されることはありません。これによって、追加開発を行うことなく、将来の Chrome ポリシーを使用する際にも API クライアントを自動化できます。将来にわたって、API でサポートするポリシーの数は増えていきます。

概要

以下の URL は https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER に対する相対パスです。リクエストとレスポンスの例については、コードサンプルをご覧ください。

説明 相対 URL HTTP メソッド リクエスト パラメータ
スキーマ一覧の取得 ./policySchemas GET 省略可: filter, pageSize, pageToken
スキーマの取得 ./policySchemas/$SCHEMA_NAME GET  
組織部門のポリシーの取得または列挙 ./policies:resolve POST 必須: policySchemaFilter, policyTargetKey

省略可: pageSize, pageToken

組織部門のポリシーの変更 ./policies/orgunits:batchModify POST 必須: requests: {policyTargetKey, policyValue, updateMask}
組織部門のポリシーの継承 ./policies/orgunits:batchInherit POST 必須: requests: {policyTargetKey, policySchema}
ポリシーのファイルのアップロード ./policies/files:uploadPolicyFile POST 必須: requests: {policyField}

認証

Chrome Policy API には、次のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/chrome.management.policy
  • https://www.googleapis.com/auth/chrome.management.policy.readonly

readonly スコープには、変更操作を実行できません。詳細については、認証の概要をご覧ください。

管理者権限

Chrome Policy API では、管理者ロールの委任が適用されます。管理者が管理するポリシーに応じて、必要な管理者権限が異なります。必要な管理者権限の一覧については、スキーマの名前空間をご覧ください。管理者のロールと権限を管理するには、Google 管理コンソールを開いて [管理者ロール] をクリックします。

バッチ リクエスト

batchModify を使用してリクエストを一括処理すると、複数のポリシーを同時に変更できます。 リクエストの一括処理は、次のすべての条件を満たす場合にのみ可能です。

  1. 同じターゲット リソース（組織部門）を参照している

  2. 同じ名前空間を共有している（スキーマがリーフでのみ異なる）。

    例: chrome.devices.A と chrome.devices.B は一括処理できますが、chrome.devices.A と chrome.devices.managedGuest.B は一括処理できません。

  3. スキーマがキー付きである場合、同じキーが存在する必要がありますが、値は異なってもかまいません。

    例: 同じ組織部門の異なるプリンタの設定を変更できます。

ポリシー値を参照する

特定のターゲット リソース（組織部門）のポリシー値は、customers.policies.resolve メソッドを使用して参照できます。参照するポリシーを指定するには、policySchemaFilter パラメータを使用します。

例:

  • 特定のポリシーを参照するには、スキーマ名を指定します（policySchemaFilter=chrome.users.ShowLogoutButton）。

  • 1 つのレスポンスで複数のポリシーを参照するには、スキーマ名前空間と、リーフ名をワイルドカードの代わりに指定します（policySchemaFilter=chrome.users.*）。

確認を必要とするポリシー

一部のポリシーでは、特定ポリシー フィールドの特定値に対して acknowledgement_required が true に設定されている notices が関連付けられています。これらのポリシーで値を設定するには、特別な確認フィールドを true に設定する必要があります。 詳細については、サンプルをご覧ください。

API 割り当て

メソッド 推奨の割り当て
スキーマ API プロジェクトごとに最大 50 クエリ/秒
ポリシー API - 解決 顧客ごとに 1 クエリ/秒
ユーザーごとにプロジェクトあたり 1 クエリ/秒
ユーザーごとにプロジェクトあたり最大 30 クエリ/分
ポリシー API - 変更
ポリシー API - 継承 		顧客ごとに 1 クエリ/秒
ユーザーごとにプロジェクトあたり 1 クエリ/秒
ユーザーごとにプロジェクトあたり最大 30 クエリ/分
ファイル API - アップロード ユーザーごとにプロジェクトあたり 1 クエリ/秒

次のステップ