API thư mục: Thiết bị Chrome

Truy xuất tất cả thiết bị Chrome cho một tài khoản

Để trả về danh sách tất cả thiết bị Chrome được chỉ định cho một tài khoản, hãy sử dụng yêu cầu GET sau đây và bao gồm yêu cầu uỷ quyền được mô tả trong phần Uỷ quyền yêu cầu. Để dễ đọc, mã mẫu này có các phương thức trả về dòng: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos?projection={BASIC|FULL}&query=query
&orderBy=orderBy category&sortOrder={ASCENDING|DESCENDING}
&pageToken=token for next results page, if applicable
&maxResults=max number of results per page

  • customerId là giá trị nhận dạng duy nhất trong Tài khoản Google của khách hàng.
  • Là quản trị viên tài khoản, bạn cũng có thể sử dụng chuỗi my_customer, đại diện cho customerId của tài khoản. Một cách khác để lấy giá trị customerId là sử dụng thao tác Truy xuất người dùng. Hãy sử dụng địa chỉ email của quản trị viên hoặc giá trị id của người dùng riêng biệt của quản trị viên trong tham số đường dẫn userKey của hoạt động.

Đối với chuỗi truy vấn, thuộc tính yêu cầu và phản hồi, hãy xem Tài liệu tham khảo API.

Ví dụ: Lọc thiết bị theo người dùng

Ví dụ này tìm kiếm người dùng cụ thể bằng cách sử dụng query=user:help desk. Phản hồi chứa một tài nguyên chromeosdevice duy nhất, trong đó annotatedUser là help desk:

Yêu cầu JSON

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos?projection=FULL&query=user:help desk&orderBy=status
&sortOrder=ASCENDING&maxResults=100

Nội dung phản hồi JSON

{
  "kind": "directory#chromeosdevices",
  "chromeosdevices": [
     {
       "kind": "directory#chromeosdevice",
       "etag": "1234567890"
       "deviceId": "def456",
       "serialNumber": "234567",
       "status": "ACTIVE",
       "lastSync": "2013-03-05T17:30:04.325Z",
       "supportEndDate": "2014-04-05T17:30:04.325Z",
       "annotatedUser": "help desk",
       "annotatedLocation": "Mountain View help desk Chromebook",
       "annotatedAssetId": "1234567890",
       "notes": "Loaned from support",
       "orderNumber": "1234",
       "willAutoRenew": true,
       "osVersion": "Browser Version 18.0",
       "platformVersion": "Platform Version 1415.2.0",
       "firmwareVersion": "Firmware Version 1.2.3.4",
       "bootMode": "validated",
       "lastEnrollmentTime": "2012-04-05T17:30:04.325Z",
       "orgUnitPath": "corp/engineering",
       "recentUsers": [
         {
           "type": "USER_TYPE_MANAGED",
           "email": "user@customer.com"
         }
       ],
       "activeTimeRanges": [
         {
           "date": "2012-04-05",
           "activeTime": "3600000"
         }
       ],
     }
  ],
  "nextPageToken": "abcdefghijkl123"
}

Ví dụ: Lọc thiết bị theo số sê-ri

Ví dụ này tìm kiếm một số sê-ri cụ thể bằng cách sử dụng query=id:123456, trong đó 123456 là số sê-ri của thiết bị. Phản hồi hiển thị bên dưới chứa một câu trả lời phù hợp, trong đó thuộc tính serialNumber khớp với giá trị tìm kiếm.

Yêu cầu JSON

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos?projection=FULL&query=id:123456&orderBy=status
&sortOrder=ASCENDING&maxResults=100

Nội dung phản hồi JSON

{
  "kind": "directory#chromeosdevices",
  "chromeosdevices": [
     {
       "kind": "directory#chromeosdevice",
       "deviceId": "abc123",
       "serialNumber": "123456",
       "status": "SHIPPED",
       "supportEndDate": "1404457200000",
       "model": "model_value",
       "meid": "meid_value",
       "macAddress": "mac_address_value",
       "orderNumber": "1234",
       "willAutoRenew": true
     }
  ],
  "nextPageToken": "abcdefghijkl123"
}

Ví dụ về phản hồi này bao gồm các thuộc tính model, meid và macAddress. Nếu thiết bị không có các thuộc tính này, thì chúng sẽ không được đưa vào phản hồi. Để biết đầy đủ thông tin chi tiết, hãy xem bài viết Trình bày tài nguyên Chromeosdevices.

Xuất danh sách MEID

meid là Mã nhận dạng thiết bị di động (MEID) cho thẻ di động 3G trong thiết bị Chrome. MEID thường được dùng khi thêm thiết bị vào gói dịch vụ trả sau của nhà mạng không dây. Để xuất danh sách MEID, hãy sử dụng yêu cầu GET sau đây và các giá trị nextPageToken để truy xuất danh sách đầy đủ các MEID. Để dễ đọc, mã mẫu này có các phương thức trả về dòng: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos?fields=nextPageToken,chromeosdevices(meid)

Truy xuất thiết bị Chrome

Để truy xuất các thuộc tính của thiết bị Chrome, hãy sử dụng yêu cầu GET sau và thêm lệnh uỷ quyền được mô tả trong phần Uỷ quyền yêu cầu. Để dễ đọc, mã mẫu này có các phương thức trả về dòng: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId là giá trị nhận dạng duy nhất trong Tài khoản Google của khách hàng.
  • Là quản trị viên tài khoản, bạn cũng có thể sử dụng chuỗi my_customer, đại diện cho customerId của tài khoản. Một cách khác để lấy giá trị customerId là sử dụng thao tác Truy xuất người dùng. Hãy sử dụng địa chỉ email của quản trị viên hoặc giá trị id của người dùng riêng biệt của quản trị viên trong tham số đường dẫn userKey của hoạt động.
  • deviceId là giá trị nhận dạng duy nhất của một thiết bị và tìm thấy trong phản hồi của thao tác Truy xuất tất cả thiết bị Chrome.

Đối với chuỗi truy vấn, thuộc tính yêu cầu và phản hồi, hãy xem Tài liệu tham khảo API.

Yêu cầu JSON

Yêu cầu mẫu. Để dễ đọc, mã mẫu này có phương thức trả về dòng: 
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos/deviceId?projection=full

Nội dung phản hồi JSON

Yêu cầu thành công sẽ trả về một mã trạng thái HTTP 200. Cùng với mã trạng thái, phản hồi sẽ trả về các thuộc tính thiết bị Chrome: 

{
  "kind": "directory#chromeosdevice",
  "deviceId": "device_id_value",
  "serialNumber": "device_serial_number",
  "status": "ACTIVE",
  "lastSync": "2012-04-05T17:30:04.325Z",
  "supportEndDate": "2014-04-05T17:30:04.325Z",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "12345667890",
  "notes": "Loaned from support",
  "orderNumber": "123456",
  "willAutoRenew": true,
  "osVersion": "Browser Version 18.0",
  "platformVersion": "Platform Version 1415.2.0",
  "firmwareVersion": "Firmware Version 1.2.3.4",
  "bootMode": "validated"
  "lastEnrollmentTime": "2012-04-05T17:30:04.325Z",
  "orgUnitPath": "corp/engineering"
}

Cập nhật thiết bị Chrome

Để cập nhật một thiết bị Chrome, hãy sử dụng yêu cầu PUT sau đây và thêm quyền được mô tả trong phần Uỷ quyền yêu cầu. Để dễ đọc, mã mẫu này có các phương thức trả về dòng: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId là giá trị nhận dạng duy nhất trong Tài khoản Google của khách hàng.
  • Là quản trị viên tài khoản, bạn cũng có thể sử dụng chuỗi my_customer, đại diện cho customerId của tài khoản. Một cách khác để lấy giá trị customerId là sử dụng thao tác Truy xuất người dùng. Hãy sử dụng địa chỉ email của quản trị viên hoặc giá trị id của người dùng riêng biệt của quản trị viên trong tham số đường dẫn userKey của hoạt động.
  • deviceId là giá trị nhận dạng duy nhất của một thiết bị và tìm thấy trong phản hồi của thao tác Truy xuất tất cả thiết bị Chrome.

Đối với chuỗi truy vấn, thuộc tính yêu cầu và phản hồi, hãy xem Tài liệu tham khảo API.

Yêu cầu JSON

Ví dụ về yêu cầu JSON dưới đây cập nhật các thuộc tính annotatedUser, annotatedLocation, annotatedAssetId, notes và orgUnitPath của thiết bị Chrome. Để dễ đọc, mã mẫu này có phương thức trả về dòng: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId?projection=full
Ví dụ về nội dung yêu cầu: 
{
  "deviceId": "device_id_value",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "1234567890",
  "notes": "Loaned from support",
  "orgUnitPath": "/corp/sales"
}

Đối với yêu cầu cập nhật, chỉ cung cấp những thuộc tính có giá trị được cập nhật trong yêu cầu của bạn.

Yêu cầu thành công sẽ trả về một mã trạng thái HTTP 200. Cùng với mã trạng thái, phản hồi sẽ trả về các thuộc tính của thiết bị Chrome đã cập nhật.

Hủy cấp phép hoặc tắt thiết bị Chrome

Để huỷ cấp phép hoặc vô hiệu hoá thiết bị Chrome, hãy sử dụng yêu cầu POST sau và bao gồm trạng thái uỷ quyền được mô tả trong Cho phép yêu cầu. Để dễ đọc, mã mẫu này có các phương thức trả về dòng: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer or customerId/
devices/chromeos:batchChangeStatus

  • customerId là giá trị nhận dạng duy nhất trong Tài khoản Google của khách hàng.
  • Là quản trị viên tài khoản, bạn cũng có thể sử dụng chuỗi my_customer, đại diện cho customerId của tài khoản. Một cách khác để lấy giá trị customerId là sử dụng thao tác Truy xuất người dùng. Hãy sử dụng địa chỉ email của quản trị viên hoặc giá trị id của người dùng riêng biệt của quản trị viên trong tham số đường dẫn userKey của hoạt động.

Đối với các thuộc tính yêu cầu và phản hồi, vui lòng xem Tài liệu tham khảo API.

Yêu cầu JSON

Yêu cầu JSON sau đây cho thấy một yêu cầu mẫu để huỷ cấp phép và vô hiệu hoá các thiết bị Chrome: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
Nội dung yêu cầu huỷ cấp phép mẫu là: 
{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
  "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION",
  "deprovisionReason": "DEPROVISION_REASON_RETIRING_DEVICE"
}
Nội dung yêu cầu vô hiệu hoá là: 
  {
    "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
    "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE",
  }

Yêu cầu thành công sẽ trả về một mã trạng thái HTTP 200.

Di chuyển thiết bị Chrome sang đơn vị tổ chức

Để di chuyển tối đa 50 thiết bị Chrome sang một đơn vị tổ chức, hãy sử dụng yêu cầu POST sau đây và bao gồm yêu cầu uỷ quyền được mô tả trong phần Uỷ quyền yêu cầu. Để dễ đọc, mã mẫu này có các phương thức trả về dòng: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/moveDevicesToOu?orgUnitPath=/SomeOuName
  • customerId là giá trị nhận dạng duy nhất trong Tài khoản Google của khách hàng.
  • Là quản trị viên tài khoản, bạn cũng có thể sử dụng chuỗi my_customer, đại diện cho customerId của tài khoản. Một cách khác để lấy giá trị customerId là sử dụng thao tác Truy xuất người dùng. Hãy sử dụng địa chỉ email của quản trị viên hoặc giá trị id của người dùng riêng biệt của quản trị viên trong tham số đường dẫn userKey của hoạt động.

Đối với các thuộc tính yêu cầu và phản hồi, vui lòng xem Tài liệu tham khảo API.

Yêu cầu JSON

Yêu cầu JSON sau đây hiển thị một yêu cầu mẫu về việc di chuyển 3 thiết bị Chrome sang một Đơn vị tổ chức có tên là /Marketing: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/chromeos/moveDevicesToOu?orgUnitPath=/Marketing

Nội dung yêu cầu cho việc di chuyển thiết bị là:

{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"]
}

Yêu cầu thành công sẽ trả về một mã trạng thái HTTP 200.