Mã mẫu cho API Quản lý trình duyệt Chrome

Hãy truy cập vào API Quản lý Chrome cho trình duyệt Chrome để xem thông tin tổng quan về các tính năng của API.

Tất cả các yêu cầu xuất hiện trên trang này đều sử dụng các biến sau:

  • $TOKEN – Mã thông báo OAuth 2.0
  • $CUSTOMER – Mã nhận dạng của khách hàng hoặc giá trị cố định my_customer

Liệt kê các trình duyệt Chrome đã đăng ký

Để liệt kê các trình duyệt Chrome đã đăng ký, hãy sử dụng điểm cuối /chromeBrowsers. Bạn có thể kiểm soát việc phân trang bằng cách sử dụng các tham số pageSize (tối đa và mặc định là 100) và pageToken. Sử dụng orderBy để chỉ định thứ tự của kết quả. Chỉ định filter để thu hẹp kết quả. Bạn có thể chỉ định một mặt nạ đọc bằng tham số truy vấn fields.

Tính năng so khớp ký tự đại diện (*) (tiền tố prefix*, hậu tố *suffix, chuỗi con *substring* hoặc sự hiện diện *) chỉ được hỗ trợ với = và : trên các trường machine_name, annotated_asset_id và browser_version.

Tính năng tìm kiếm văn bản trên toàn cầu (không chỉ định tên trường) sẽ tìm kiếm trên tất cả các trường văn bản được lập chỉ mục. Khi nhiều cụm từ được phân tách bằng AND hoặc khoảng trắng (ví dụ: filter=machine AND 73 hoặc filter=machine 73), mọi cụm từ phải khớp với ít nhất một trường văn bản được lập chỉ mục trên thiết bị trình duyệt (ngay cả trên các trường khác nhau). Việc đặt nhiều từ trong một chuỗi có dấu ngoặc kép (ví dụ: filter="machine name") sẽ tìm kiếm chính xác cụm từ liền kề đó trong một trường duy nhất.

Ví dụ về cụm từ tìm kiếm bộ lọc

# 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

Yêu cầu

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

Phản hồi

{
  "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>"
}

Truy xuất Trình duyệt Chrome được quản lý

Để truy xuất một trình duyệt Chrome đã đăng ký, hãy sử dụng điểm cuối /chromeBrowsers/{browser_permanent_id}. Bạn có thể chỉ định một mặt nạ đọc bằng tham số fields.

Yêu cầu

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

Phản hồi

{
  "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
}

Cập nhật thông tin chú thích cho trình duyệt Chrome

Để cập nhật các trường được chú thích của một trình duyệt Chrome đã đăng ký, hãy sử dụng điểm cuối /chromeBrowsers/{browser_permanent_id} bằng phương thức HTTP PATCH và cung cấp một tham số truy vấn updateMask chỉ định các trường cần cập nhật.

Yêu cầu

  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"
  }'

Phản hồi

{
  "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"
}

Di chuyển trình duyệt Chrome sang một đơn vị tổ chức mới

Để di chuyển các trình duyệt Chrome được quản lý từ một Đơn vị tổ chức sang một Đơn vị tổ chức khác, hãy sử dụng điểm cuối /chromeBrowsers:move. Bạn có thể di chuyển tối đa 600 trình duyệt cho mỗi yêu cầu. Nếu có lỗi khi di chuyển bất kỳ trình duyệt nào, thì không có trình duyệt nào được di chuyển.

Yêu cầu

  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>"
    ]
  }'

Phản hồi

{}

Xoá dữ liệu được thu thập từ trình duyệt Chrome

Để xoá dữ liệu được thu thập từ một trình duyệt Chrome được quản lý, hãy sử dụng điểm cuối /chromeBrowsers/{browser_permanent_id} với HTTP DELETE.

Yêu cầu

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

Phản hồi

{}