コードサンプル

以下のリクエストは、Policy API を使用したポリシー管理を示しています。始める前に、Chrome Policy API の概要で、この API の機能の概要をご確認ください。

以下に示すリクエストはすべて、次の変数を使用します。

  • $TOKEN - OAuth 2 トークン
  • $CUSTOMER - 顧客の ID またはリテラル my_customer

プリンタ ポリシーのスキーマを一覧表示する

プリンタのポリシーにのみ関係するスキーマを一覧表示するには、スキーマ サービスのリストリクエストに filter パラメータを適用します。結果のページ分けは、pageSize パラメータと pageToken パラメータを使用して制御できます。

リクエスト

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policySchemas?filter=chrome.printers&pageSize=2"

レスポンス

{
  "policySchemas": [
    {
      "name": "customers/C0202nabg/policySchemas/chrome.printers.AllowForUsers",
      "policyDescription": "Allows a printer for users in a given organization.",
      "additionalTargetKeyNames": [
        {
          "key": "printer_id",
          "keyDescription": "Id of printer as visible in Admin SDK printers API."
        }
      ],
      "definition": {
        "messageType": [
          {
            "name": "AllowForUsers",
            "field": [
              {
                "name": "allowForUsers",
                "number": 1,
                "label": "LABEL_OPTIONAL",
                "type": "TYPE_BOOL"
              }
            ]
          }
        ]
      },
      "fieldDescriptions": [
        {
          "field": "allowForUsers",
          "description": "Controls whether a printer is allowed for users in a given organization."
        }
      ],
      "schemaName": "chrome.printers.AllowForUsers"
    },
    {
      "name": "customers/C0202nabg/policySchemas/chrome.printers.AllowForDevices",
      "policyDescription": "Allows a printer for devices in a given organization.",
      "additionalTargetKeyNames": [
        {
          "key": "printer_id",
          "keyDescription": "Id of printer as visible in Admin SDK printers API."
        }
      ],
      "definition": {
        "messageType": [
          {
            "name": "AllowForDevices",
            "field": [
              {
                "name": "allowForDevices",
                "number": 1,
                "label": "LABEL_OPTIONAL",
                "type": "TYPE_BOOL"
              }
            ]
          }
        ]
      },
      "fieldDescriptions": [
        {
          "field": "allowForDevices",
          "description": "Controls whether a printer is allowed for devices in a given organization."
        }
      ],
      "schemaName": "chrome.printers.AllowForDevices"
    }
  ],
  "nextPageToken": "AEbDN_obE8A98T8YhIeU9VCIZhEBylLBwZRQpGu_DUug-mU4bnzcDx30UnO2xMuuImvfVpmeuXRF6VhJ4OmZpZ4H6EaRvu2qMOPxVN_u"
}

スキーマを検索

スキーマ サービスのリスト リクエストで filter= パラメータを使用して、複雑な検索クエリを作成できます。たとえば、名前に「printer」という単語、説明に「devices」という単語が含まれるスキーマを検索する場合は、フィルタ name=printers AND description=devices に次の値を適用します。

ポリシー スキーマを一覧表示する方法を学習する。

リクエスト

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policySchemas?filter=name=printers%20AND%20description=devices"

レスポンス

{
  "policySchemas": [
    {
      "name": "customers/C0202nabg/policySchemas/chrome.printers.AllowForDevices",
      "policyDescription": "Allows a printer for devices in a given organization.",
      "additionalTargetKeyNames": [
        {
          "key": "printer_id",
          "keyDescription": "Id of printer as visible in Admin SDK printers API."
        }
      ],
      "definition": {
        "messageType": [
          {
            "name": "AllowForDevices",
            "field": [
              {
                "name": "allowForDevices",
                "number": 1,
                "label": "LABEL_OPTIONAL",
                "type": "TYPE_BOOL"
              }
            ]
          }
        ]
      },
      "fieldDescriptions": [
        {
          "field": "allowForDevices",
          "description": "Controls whether a printer is allowed for devices in a given organization."
        }
      ],
      "schemaName": "chrome.printers.AllowForDevices"
    }
  ]
}

特定のスキーマを取得する

上記の結果には、サポートされているポリシー スキーマのリストが表示されます。各スキーマには、スキーマを識別する name フィールドがあります。今後は、スキーマ名がわかったら、リクエスト URL でスキーマ名を参照して特定のスキーマを直接読み取ることができます。

chrome.printers.AllowForUsers スキーマの例を見てみましょう。

リクエスト

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policySchemas/chrome.printers.AllowForUsers"

レスポンス

{
  "name": "customers/C0202nabg/policySchemas/chrome.printers.AllowForUsers",
  "policyDescription": "Allows a printer for users in a given organization.",
  "additionalTargetKeyNames": [
    {
      "key": "printer_id",
      "keyDescription": "Id of printer as visible in Admin SDK printers API."
    }
  ],
  "definition": {
    "messageType": [
      {
        "name": "AllowForUsers",
        "field": [
          {
            "name": "allowForUsers",
            "number": 1,
            "label": "LABEL_OPTIONAL",
            "type": "TYPE_BOOL"
          }
        ]
      }
    ]
  },
  "fieldDescriptions": [
    {
      "field": "allowForUsers",
      "description": "Controls whether a printer is allowed for users in a given organization."
    }
  ],
  "schemaName": "chrome.printers.AllowForUsers"
}

上記のポリシー スキーマ レスポンスは、chrome.printers.AllowForUsers ポリシーのスキーマを示しています。フィールド additionalTargetKeyNames に注目してください。このフィールドでは、このポリシーを処理するときに追加の Key-Value を指定することがポリシーで必須になっていることを説明します。特に、このポリシーの場合、常にプリンタの ID を指定する必要があります。

ポリシー値を読み取る

特定のプリンタに対するポリシー chrome.printers.AllowForUsers を読み取ります。 リクエストのプリンタ ID の指定に additionalTargetKeys フィールドを使用している点に注意してください。

ポリシーは組織部門またはグループから読み取ることができます。

レスポンスの sourceKey フィールドに、ポリシーの値を取得する組織部門またはグループを指定します。組織部門には、次の可能性があります。

  • ソースの組織部門がリクエストで指定された組織部門と同じ場合、ポリシーはこの組織部門にローカルに適用されています。
  • ソースの組織部門がリクエストで指定された組織部門と異なる場合、ポリシーはソースの組織部門から継承されます。
  • sourceKey が存在しないかレスポンスが空の場合は、顧客に対してポリシーが設定されておらず、デフォルトのシステム値が設定されていることを意味します。

グループの場合、sourceKey はリクエストで指定されたグループと常に同じになります。

次の例は組織部門です。Group リクエストは、targetResource を除いて同じです。ID の前に「orgunits/」ではなく「groups/」が付いています。

リクエスト

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
        policyTargetKey: {
          targetResource: "orgunits/04fatzly4jbjho9",
          additionalTargetKeys: {"printer_id":"0gjdgxs208tpef"}
        },
        policySchemaFilter: "chrome.printers.AllowForDevices"
    }' \
  "https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policies:resolve"

レスポンス

{
  "resolvedPolicies": [
    {
      "targetKey": {
        "targetResource": "orgunits/03ph8a2z1xdnme9"
        "additionalTargetKeys": {"printer_id":"0gjdgxs208tpef"}
      },
      "value": {
        "policySchema": "chrome.users.AllowForDevices",
        "value": {
          "allowForDevices": true
        }
      },
      "sourceKey": {
        "targetResource": "orgunits/03ph8a2z3qhz81k"
      }
    }
  ]
}

リクエストから additionalTargetKeys を省略すると、ターゲット リソース内のすべてのエンティティを取得できます。たとえば、上記のリクエストで additionalTargetKeys が省略されている場合は、指定されたターゲット リソース内のすべてのプリンタが返されます。

複数のポリシーを読み取る

スキーマの名前空間をアスタリスクで指定（例:chrome.printers.* など）を使用すると、特定の組織部門またはグループのこの名前空間に含まれるすべてのポリシーの値を読み取ることができます。ポリシー スキーマの詳細を確認する。

次の例は組織部門です。Group リクエストは、targetResource を除いて同じです。ID の前に「orgunits/」ではなく「groups/」が付いています。

リクエスト

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
        policyTargetKey: {
          targetResource: "orgunits/04fatzly4jbjho9",
        },
        policySchemaFilter: "chrome.printers.*"
    }' \
  "https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policies:resolve"

レスポンス

{
  "resolvedPolicies": [
    {
      "targetKey": {
        "targetResource": "orgunits/04fatzly4jbjho9",
        "additionalTargetKeys": {
          "printer_id": "0gjdgxs0xd59y1"
        }
      },
      "value": {
        "policySchema": "chrome.printers.AllowForUsers",
        "value": {
          "allowForUsers": false
        }
      }
    },
    {
      "targetKey": {
        "targetResource": "orgunits/04fatzly4jbjho9",
        "additionalTargetKeys": {
          "printer_id": "0gjdgxs0xd59y1"
        }
      },
      "value": {
        "policySchema": "chrome.printers.AllowForDevices",
        "value": {
          "allowForDevices": false
        }
      }
    },
    //...
  ],
  "nextPageToken": "AEbDN_pFvDeGSbQDkvMxr4UA0Ew7UEUw8aJyw95VPs2en6YxMmFcWQ9OQQEIeSkjnWFCQNyz5GGoOKQGEd50e2z6WqvM2w7sQz6TMxVOBD_4NmEHRWtIJCYymeYXWHIrNH29Ezl1wkeyYBAOKnE="
}

ポリシーの値を変更

ポリシー スキーマのレスポンスを見ると、ポリシー chrome.printers.AllowForUsers には allowForUsers という名前のフィールドが 1 つあります。このフィールドはブール値型です。ポリシーの値は、{allowForUsers: false} と {allowForUsers: true} のいずれかです。この例ではフィールドが 1 つしかありませんが、他のポリシーには複数のフィールドが含まれる場合があります。

変更リクエストでは、updateMask を指定する必要があります。更新マスクには、変更するすべてのフィールドが一覧表示されます。ポリシーが組織部門にローカルに適用されている場合、更新マスクでリストされていないフィールドは変更されません。ポリシーが組織部門にローカルに適用されておらず、更新マスクでリストされていないすべてのフィールドが親組織部門から適宜値をコピーしている場合、ポリシー全体がローカルに適用されます。

以下は組織部門の例です。グループ リクエストは同じですが、targetResource では ID の前に「orgunits/」ではなく「groups/」が付いています。ここでは、組織部門 ID 04fatzly4jbjho9 のユーザーに対してプリンタ 0gjdgxs208tpef の使用を禁止します。

リクエスト

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
        requests: [{
                policyTargetKey: {
                        targetResource: "orgunits/04fatzly4jbjho9",
                        additionalTargetKeys: {"printer_id":"0gjdgxs208tpef"}
                        },
                policyValue: {
                        policySchema: "chrome.printers.AllowForUsers",
                        value: {allowForUsers: false}
                        },
                updateMask: {paths: "allowForUsers"}
                }]
      }' \
  "https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policies/orgunits:batchModify"

レスポンス

成功のレスポンスは空です。

{}

リストや配列などの複数の値を持つフィールドには、「LABEL_REPEATED」というラベルが付きます。複数の値 フィールドにデータを入力するには、JSON 配列形式 [value1, value2, value3, ...] を使用します。

たとえば、アプリと拡張機能のパッケージのソース URL を「test1.com」、「test2.com」、「test3.com」に設定するには、次のリクエストを送信する必要があります。

リクエスト

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d "{
        requests: [
          {
            policy_target_key: {
              target_resource: 'orgunits/03ph8a2z28rz85a'
            },
            updateMask: {
              paths: ['extensionInstallSources']
            },
            policy_value: {
              policy_schema: 'chrome.users.appsconfig.AppExtensionInstallSources', 
              value: {
                extensionInstallSources: ['test1.com', 'test2.com', 'test3.com']
              }
            }
          }
        ]
      }" \
  "https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policies/orgunits:batchModify"

レスポンス

成功のレスポンスは空です。

{}

NullableDuration フィールドを含むすべてのポリシーには、2 つのバージョンがあります。オリジナル版では NullableDuration の入力として文字列のみを受け入れるため、現在は非推奨となっています。期間型を数値入力に置き換える V2 バージョンを使用してください。たとえば、ユーザー セッションの最大の長さを 10 分に設定するには、次のリクエストを送信する必要があります。

リクエスト

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d "{
        requests: [
          {
            policy_target_key: {
              target_resource: 'orgunits/03ph8a2z28rz85a'
            },
            updateMask: {
              paths: ['sessionDurationLimit']
            },
            policy_value: {
              policy_schema: 'chrome.users.SessionLengthV2',
              value: {
                sessionDurationLimit: {
                  duration: 10
                }
              }
            }
          }
        ]
      }" \
  "https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policies/orgunits:batchModify"

レスポンス

成功のレスポンスは空です。

{}

複数のポリシーを一度に変更する

batchModify メソッドを使用すると、複数のポリシーの変更を同時に送信できます。ただし、すべてのポリシーをバッチ処理できるわけではありません。詳細については、バッチ アップデート ポリシーをご覧ください。

この例では、同じプリンタに対する 2 つの異なるポリシー（chrome.printers.AllowForDevices と chrome.printers.AllowForUsers）を、同じリクエストで変更します。

次の例は組織部門です。Group リクエストは、targetResource を除いて同じです。ID の前に「orgunits/」ではなく「groups/」が付いています。

リクエスト

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
        requests: [{
                policyTargetKey: {
                        targetResource: "orgunits/04fatzly4jbjho9",
                        additionalTargetKeys: {"printer_id":"0gjdgxs208tpef"}
                        },
                policyValue: {
                        policySchema: "chrome.printers.AllowForDevices",
                        value: {allowForDevices: true}
                        },
                updateMask: {paths: "allowForDevices"}
                },
                {
                policyTargetKey: {
                        targetResource: "orgunits/04fatzly4jbjho9",
                        additionalTargetKeys: {"printer_id":"0gjdgxs208tpef"}
                        },
                policyValue: {
                        policySchema: "chrome.printers.AllowForUsers",
                        value: {allowForUsers: true}
                        },
                updateMask: {paths: "allowForUsers"}
                }]
      }' \
  "https://chromepolicy.googleapis.com/v1/customers/C0202nabg/policies/orgunits:batchModify"

レスポンス

成功のレスポンスは空です。

{}

組織部門のポリシー値を継承する

batchInherit メソッドを使用すると、組織部門のポリシーのステータスを「ローカルに適用済み」から「継承」に変更できます。ローカルの値は消去され、該当する場合、ポリシーは親組織部門から値を継承します。

batchInherit メソッドを使用すると、複数のポリシー継承リクエストを同時に送信することもできます。ただし、すべてのポリシーをバッチ処理できるわけではありません。詳細については、バッチ アップデート ポリシーをご覧ください。

リクエスト

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
        requests: [{
                policyTargetKey: {
                        targetResource: "orgunits/04fatzly12wd3ox",
                        additionalTargetKeys: {"printer_id":"0gjdgxs208tpef"}
                        },
                policySchema: "chrome.printers.AllowForUsers"
                }]
      }' \
  "https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policies/orgunits:batchInherit"

レスポンス

成功のレスポンスは空です。

{}

グループのポリシー値を削除する

batchDelete メソッドを使用すると、グループからポリシーを削除できます。ローカル値は消去されます。

batchDelete メソッドを使用すると、複数のポリシーの削除リクエストを同時に送信することもできます。ただし、すべてのポリシーをバッチ処理できるわけではありません。詳細については、バッチ アップデート ポリシーをご覧ください。

リクエスト

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
        requests: [{
                policyTargetKey: {
                        targetResource: "groups/04fatzly12wd3ox",
                        additionalTargetKeys: {"printer_id":"0gjdgxs208tpef"}
                        },
                policySchema: "chrome.printers.AllowForUsers"
                }]
      }' \
  "https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policies/groups:batchDelete"

レスポンス

成功のレスポンスは空です。

{}

グループの優先順位を一覧表示する

listGroupPriorityOrdering メソッドを使用すると、アプリの Google グループの優先順位をリストできます。

返されるグループ ID の順序は、その設定がアプリに適用される優先順位を示します。後の ID のポリシーは、ID がリストの先頭にあるポリシーによってオーバーライドされます。

なお、グループの優先順位は組織部門の優先順位よりも高くなります。

このリクエストでは、「exampleapp」Chrome ユーザー アプリの優先順位を返します。

リクエスト

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
        policyTargetKey: {
                additionalTargetKeys: {"app_id":"chrome:exampleapp"}
                },
        policyNamespace: 'chrome.users.apps'
      }' \
  "https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policies/groups:listGroupPriorityOrdering"

レスポンス

{
  "policyTargetKey": {
    "additionalTargetKeys": {
      "app_id": "chrome:exampleapp"
    }
  },
  "policyNamespace": "chrome.users.apps",
  "groupIds": [
    "03ep43zb2k1nodu",
    "01t3h5sf2k52kol",
    "03q5sasy2ihwnlz"
  ]
}

グループの優先順位を更新する

updateGroupPriorityOrdering メソッドを使用すると、アプリの Google グループの優先順位を更新できます。

リクエスト内のグループ ID の順序は、それらの設定がアプリに適用される優先順位を示します。後の ID のポリシーは、ID がリスト内で先行するポリシーによってオーバーライドされます。リクエストには、現在アプリに適用されているすべてのグループ ID を含める必要があります。

なお、グループの優先順位は組織部門の優先順位よりも高くなります。

このリクエストでは、Chrome ユーザー アプリの「exampleapp」の優先度を設定しています。

リクエスト

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
        policyTargetKey: {
                additionalTargetKeys: {"app_id":"chrome:exampleapp"}
                },
        policyNamespace: 'chrome.users.apps',
        groupIds: ['03ep43zb2k1nodu', '01t3h5sf2k52kol', '03q5sasy2ihwnlz']
      }' \
  "https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policies/groups:updateGroupPriorityOrdering"

レスポンス

成功のレスポンスは空です。

{}

確認が必要なポリシーの処理

一部のポリシー スキーマでは、確認を必要とする特定のフィールドの特定の値に「通知」が指定されています。

chrome.users.PluginVmAllowd ポリシーの例:

{
  "name": "customers/C0202nabg/policySchemas/chrome.users.PluginVmAllowed",
  "policyDescription": "Parallels Desktop.",
  # ...
  "fieldDescriptions": [
    {
      "field": "pluginVmAllowed",
      "description": "N/A",
      "knownValueDescriptions": [
        {
          "value": "true",
          "description": "Allow users to use Parallels Desktop."
        },
        {
          "value": "false",
          "description": "Do not allow users to use Parallels Desktop."
        }
      ]
    },
    {
      "field": "ackNoticeForPluginVmAllowedSetToTrue",
      "description": "This field must be set to true to acknowledge the notice message associated with the field 'plugin_vm_allowed' set to value 'true'. Please see the notices listed with this policy for more information."
    }
  ],
  "notices": [
    {
      "field": "pluginVmAllowed",
      "noticeValue": "true",
      "noticeMessage": "By enabling Parallels Desktop, you agree to the Parallels End-User License Agreement specified at https://www.parallels.com/about/legal/eula/. Warning: Device identifiers may be shared with Parallels. Please see privacy policy for more details at https://www.parallels.com/about/legal/privacy/. The minimum recommended configuration includes an i5 processor, 16 GB RAM, and 128 GB storage: https://support.google.com/chrome/a/answer/10044480.",
      "acknowledgementRequired": true
    }
  ],
  "supportUri": "...",
  "schemaName": "chrome.users.PluginVmAllowed"
}

上記の例では、フィールド pluginVmAllowed の値を true に設定すると、acknowledgementRequired を含む通知に関連付けられます。このフィールド値を true に正しく設定するには、確認応答フィールド ackNoticeForPluginVmAllowedSetToTrue を指定したリクエストを true に送信する必要があります。そうしないと、リクエストでエラーが発生します。

この例では、次の一括変更リクエストを送信する必要があります。

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d "{
  'requests': [
    {
      'policyTargetKey': {
        'targetResource': 'orgunits/03ph8a2z10ybbh2'
      },
      'policyValue': {
        'policySchema': 'chrome.users.PluginVmAllowed',
        'value': {
          'pluginVmAllowed': true,
          'ackNoticeForPluginVmAllowedSetToTrue': true
        }
      },
      'updateMask': {
        'paths': [
          'pluginVmAllowed',
          'ackNoticeForPluginVmAllowedSetToTrue'
        ]
      }
    }
  ]
}" \
"https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policies/orgunits:batchModify"

ファイル ポリシーの設定

一部のポリシーのフィールドには UploadedFile と記述されています。BatchModify リクエストで使用する URL を取得するには、それらのポリシーの値として設定したファイルを API サーバーにアップロードする必要があります。

この例では、JPEG ファイルをアップロードして chrome.users.Wallpaper を設定します。

ファイルをアップロードする

リクエスト

curl -X POST \
  -H "Content-Type: image/jpeg" \
  -H "Authorization: Bearer $TOKEN" \
  -T "/path/to/the/file" \
  "https://chromepolicy.googleapis.com/upload/v1/customers/$CUSTOMER/policies/files:uploadPolicyFile?policy_field=chrome.users.Wallpaper.wallpaperImage"

レスポンス

成功すると、ファイルにアクセスするための URL が返されます。

{
  "downloadUri": "https://storage.googleapis.com/chromeos-mgmt/0gjdgxs370bkl6/ChromeOsWallpaper/32ac50ab-b5ae-4bba-afa8-b6b443912897"
}

ファイル ポリシーを設定する

リクエスト

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
        requests: [{
                policyTargetKey: {
                        targetResource: "orgunits/04fatzly4jbjho9",
                        },
                policyValue: {
                        policySchema: "chrome.users.Wallpaper",
                        value: {
                          wallpaperImage: {downloadUri: "https://storage.googleapis.com/chromeos-mgmt/0gjdgxs370bkl6/ChromeOsWallpaper/32ac50ab-b5ae-4bba-afa8-b6b443912897"}
                          }
                        },
                updateMask: {paths: "wallpaperImage"}
                }]
      }' \
  "https://chromepolicy.googleapis.com/v1/customers/$CUSTOMER/policies/orgunits:batchModify"

レスポンス

成功のレスポンスは空です。

{}