Примеры кода для Chrome Management Chrome Browsers API

Обзор функций API приведен в статье Chrome Management Chrome Browsers API.

Во всех запросах, приведенных на этой странице, используются следующие переменные:

  • $TOKEN – токен OAuth 2.0.
  • $CUSTOMER – идентификатор клиента или литерал my_customer.

Список зарегистрированных браузеров Chrome

Чтобы получить список зарегистрированных браузеров Chrome, используйте конечную точку /chromeBrowsers. Вы можете управлять разбивкой на страницы с помощью параметров pageSize (максимальное значение и значение по умолчанию – 100) и pageToken. Используйте orderBy, чтобы указать порядок результатов. Укажите filter, чтобы сузить результаты. Маску чтения можно указать с помощью параметра запроса fields.

Сопоставление с подстановочным знаком (*) (префикс prefix*, суффикс *suffix, подстрока *substring* или наличие *) поддерживается с операторами = и : только в полях machine_name, annotated_asset_id и browser_version.

Глобальный текстовый поиск (без указания названия поля) выполняется по всем индексированным текстовым полям. Если несколько терминов разделены символом AND или пробелом (например, filter=machine AND 73 или filter=machine 73), каждый термин должен соответствовать хотя бы одному индексированному текстовому полю на устройстве браузера (даже в разных полях). Если вы заключите несколько слов в кавычки (например, filter="machine name"), то поиск будет выполняться по точному совпадению с этой фразой в пределах одного поля.

Примеры фильтрации запросов

# Filter by machine name prefix (using ':' or '=')
filter=machine_name:LIX*

# Filter by annotated asset ID suffix
filter=annotated_asset_id="*1001"

# Filter by browser version substring
filter=browser_version:"*6367*"

# Global search across all indexed text fields (matches browsers containing both "machine" and "73" across any fields)
filter=machine AND 73

# Global search with implicit AND (equivalent to `machine AND 73`)
filter=machine 73

# Filter by machine name prefix and registration time range
filter=machine_name:LIX* AND last_registration_time>=2024-01-01T00:00:00Z

# Filter by Organizational Unit path
filter=org_unit_path=/Marketing

Запрос

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/chromeBrowsers?pageSize=2&orderBy=lastActivityTime+desc&filter=os_platform=WINDOWS"

Ответ

{
  "chromeBrowsers": [
    {
      "name": "customers/<customerId>/chromeBrowsers/<browserPermanentId1>",
      "browserPermanentId": "<browserPermanentId1>",
      "machineName": "CLIENT2024-01",
      "osPlatformType": "WINDOWS",
      "osVersion": "10.0.19045",
      "browserVersion": "124.0.6367.60",
      "annotatedUser": "user1@example.com",
      "annotatedLocation": "US-NYC",
      "annotatedAssetId": "ASSET-1001",
      "annotatedNotes": "Engineering workstation",
      "lastActivityTime": "2024-04-23T22:05:44.214362Z",
      "lastPolicySyncTime": "2024-04-23T22:00:00.000Z",
      "lastStatusReportTime": "2024-04-23T22:05:44.214362Z",
      "enrollmentDate": "2024-01-15T10:30:00.000Z",
      "orgUnitPath": "/Engineering",
      "policyCount": 15,
      "extensionCount": 8
    },
    {
      "name": "customers/<customerId>/chromeBrowsers/<browserPermanentId2>",
      "browserPermanentId": "<browserPermanentId2>",
      "machineName": "CLIENT2024-02",
      "osPlatformType": "WINDOWS",
      "osVersion": "11.0.22631",
      "browserVersion": "124.0.6367.60",
      "annotatedUser": "user2@example.com",
      "annotatedLocation": "US-MTV",
      "lastActivityTime": "2024-04-23T21:45:10.102000Z",
      "lastPolicySyncTime": "2024-04-23T21:40:00.000Z",
      "lastStatusReportTime": "2024-04-23T21:45:10.102000Z",
      "enrollmentDate": "2024-02-10T14:15:00.000Z",
      "orgUnitPath": "/Engineering",
      "policyCount": 12,
      "extensionCount": 5
    }
  ],
  "nextPageToken": "<nextPageToken>"
}

Как получить свойства управляемого браузера Chrome

Чтобы получить один зарегистрированный браузер Chrome, используйте конечную точку /chromeBrowsers/{browser_permanent_id}. Маску чтения можно указать с помощью параметра fields.

Запрос

  curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/chromeBrowsers/<browserPermanentId1>"

Ответ

{
  "name": "customers/<customerId>/chromeBrowsers/<browserPermanentId1>",
  "browserPermanentId": "<browserPermanentId1>",
  "machineName": "CLIENT2024-01",
  "osPlatformType": "WINDOWS",
  "osVersion": "10.0.19045",
  "browserVersion": "124.0.6367.60",
  "annotatedUser": "user1@example.com",
  "annotatedLocation": "US-NYC",
  "annotatedAssetId": "ASSET-1001",
  "annotatedNotes": "Engineering workstation",
  "lastActivityTime": "2024-04-23T22:05:44.214362Z",
  "lastPolicySyncTime": "2024-04-23T22:00:00.000Z",
  "lastStatusReportTime": "2024-04-23T22:05:44.214362Z",
  "enrollmentDate": "2024-01-15T10:30:00.000Z",
  "orgUnitPath": "/Engineering",
  "policyCount": 15,
  "extensionCount": 8
}

Как обновить информацию в аннотации для браузера Chrome

Чтобы обновить заполненные администратором поля зарегистрированного браузера Chrome, используйте конечную точку /chromeBrowsers/{browser_permanent_id} с методом HTTP PATCH и укажите параметр запроса updateMask, определяющий поля, которые нужно обновить.

Запрос

  curl -X PATCH \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/chromeBrowsers/<browserPermanentId1>?updateMask=annotatedUser,annotatedNotes" \
  -d '{
    "annotatedUser": "newuser@example.com",
    "annotatedNotes": "Updated primary workstation"
  }'

Ответ

{
  "name": "customers/<customerId>/chromeBrowsers/<browserPermanentId1>",
  "browserPermanentId": "<browserPermanentId1>",
  "machineName": "CLIENT2024-01",
  "osPlatformType": "WINDOWS",
  "osVersion": "10.0.19045",
  "browserVersion": "124.0.6367.60",
  "annotatedUser": "newuser@example.com",
  "annotatedLocation": "US-NYC",
  "annotatedAssetId": "ASSET-1001",
  "annotatedNotes": "Updated primary workstation",
  "lastActivityTime": "2024-04-23T22:05:44.214362Z",
  "orgUnitPath": "/Engineering"
}

Как переместить браузеры Chrome в новое организационное подразделение

Чтобы переместить управляемые браузеры Chrome из одного организационного подразделения в другое, используйте конечную точку /chromeBrowsers:move. В рамках запроса можно переместить не более 600 устройств. Если при перемещении одного из браузеров возникнет ошибка, то ни один из указанных браузеров не будет перемещен.

Запрос

  curl -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/chromeBrowsers:move" \
  -d '{
    "destinationOrgUnitId": "03ph8a2z3v",
    "resourceIds": [
      "customers/$CUSTOMER/chromeBrowsers/<browserPermanentId1>",
      "customers/$CUSTOMER/chromeBrowsers/<browserPermanentId2>"
    ]
  }'

Ответ

{}

Как удалить данные, собранные из браузера Chrome

Чтобы удалить данные, собранные из управляемого браузера Chrome, используйте конечную точку /chromeBrowsers/{browser_permanent_id} с HTTP DELETE.

Запрос

  curl -X DELETE \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/chromeBrowsers/<browserPermanentId1>"

Ответ

{}