Directory API: อุปกรณ์ ChromeOS

เรียกข้อมูลอุปกรณ์ ChromeOS ทั้งหมดของบัญชี

หากต้องการแสดงรายการอุปกรณ์ ChromeOS ทั้งหมดที่กำหนดให้กับบัญชี ให้ใช้คำขอ GET ต่อไปนี้และรวมการให้สิทธิ์ที่อธิบายไว้ในคำขอสิทธิ์ ตัวอย่างโค้ดนี้มีการขึ้นบรรทัดใหม่เพื่อให้ง่ายต่อการอ่านทำความเข้าใจ 

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 เป็นตัวระบุที่ไม่ซ้ำสำหรับบัญชี Google ของลูกค้า
  • ในฐานะผู้ดูแลระบบบัญชี คุณสามารถใช้สตริง my_customer ที่แสดง customerId ของบัญชีได้ด้วย อีกวิธีหนึ่งในการรับค่า customerId ก็คือใช้การดำเนินการเรียกข้อมูลผู้ใช้ ใช้อีเมลของผู้ดูแลระบบหรือค่า id ผู้ใช้ที่ไม่ซ้ำของผู้ดูแลระบบในพารามิเตอร์เส้นทาง userKey ของการดำเนินการ

ดูพร็อพเพอร์ตี้สตริงการค้นหา คำขอ และการตอบกลับได้ในเอกสารอ้างอิง API

ตัวอย่าง: กรองอุปกรณ์ตามผู้ใช้

ตัวอย่างนี้จะค้นหาผู้ใช้ที่เฉพาะเจาะจงโดยใช้ query=user:help desk การตอบกลับมีทรัพยากร chromeosdevice รายการเดียว โดยที่ annotatedUser คือ help desk

คำขอ 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

การตอบสนองของ 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"
}

ตัวอย่าง: กรองอุปกรณ์ตามหมายเลขซีเรียล

ตัวอย่างนี้จะค้นหาหมายเลขซีเรียลที่เฉพาะเจาะจงโดยใช้ query=id:123456 โดยที่ 123456 คือหมายเลขซีเรียลของอุปกรณ์ การตอบกลับที่แสดงด้านล่างมีการตอบกลับที่ตรงกันรายการเดียว โดยพร็อพเพอร์ตี้ serialNumber ตรงกับค่าการค้นหา

คำขอ 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

การตอบสนองของ 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"
}

ตัวอย่างคำตอบนี้ประกอบด้วยพร็อพเพอร์ตี้ model, meid และ macAddress หากอุปกรณ์ไม่มีพร็อพเพอร์ตี้เหล่านี้ ระบบจะไม่รวมไว้ในคำตอบ ดูรายละเอียดทั้งหมดได้ที่การแสดงทรัพยากร Chromeosdevices

ส่งออกรายการ MEID

meid คือ Mobile Equipment Identifier (MEID) สำหรับการ์ดมือถือ 3G ในอุปกรณ์ ChromeOS โดยทั่วไปแล้ว MEID จะต้องใช้สำหรับการเพิ่มอุปกรณ์ในแพ็กเกจบริการแบบชำระภายหลังของผู้ให้บริการเครือข่ายมือถือ หากต้องการส่งออกรายการ MEID ให้ใช้คำขอ GET ต่อไปนี้และค่า nextPageToken เพื่อดึงข้อมูลรายการ MEID ทั้งหมด ตัวอย่างโค้ดนี้มีการขึ้นบรรทัดใหม่เพื่อให้ง่ายต่อการอ่านทำความเข้าใจ 

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

เรียกข้อมูลอุปกรณ์ ChromeOS

หากต้องการเรียกข้อมูลพร็อพเพอร์ตี้ของอุปกรณ์ ChromeOS ให้ใช้คำขอ GET ต่อไปนี้และรวมการให้สิทธิ์ที่อธิบายไว้ในคำขอสิทธิ์ ตัวอย่างโค้ดนี้มีการขึ้นบรรทัดใหม่เพื่อให้ง่ายต่อการอ่านทำความเข้าใจ 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId เป็นตัวระบุที่ไม่ซ้ำสำหรับบัญชี Google ของลูกค้า
  • ในฐานะผู้ดูแลระบบบัญชี คุณยังใช้สตริง my_customer ที่แสดง customerId ของบัญชีได้ด้วย อีกวิธีหนึ่งในการรับค่า customerId ก็คือใช้การดำเนินการเรียกข้อมูลผู้ใช้ ใช้อีเมลของผู้ดูแลระบบหรือค่า id ผู้ใช้ที่ไม่ซ้ำของผู้ดูแลระบบในพารามิเตอร์เส้นทาง userKey ของการดำเนินการ
  • deviceId คือตัวระบุที่ไม่ซ้ำกันของอุปกรณ์ ซึ่งจะอยู่ในคำตอบของการดำเนินการเรียกข้อมูลอุปกรณ์ ChromeOS ทั้งหมด

ดูพร็อพเพอร์ตี้สตริงการค้นหา คำขอ และการตอบกลับได้ในเอกสารอ้างอิง API

คำขอ JSON

ตัวอย่างคำขอ ตัวอย่างโค้ดนี้มีการขึ้นบรรทัดใหม่เพื่อให้ง่ายต่อการอ่านทำความเข้าใจ 
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos/deviceId?projection=full

การตอบสนองของ JSON

คำขอที่สำเร็จจะแสดงรหัสสถานะ HTTP 200 นอกเหนือจากรหัสสถานะแล้ว การตอบสนองจะแสดงพร็อพเพอร์ตี้ของอุปกรณ์ ChromeOS ด้วยดังนี้ 

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

อัปเดตอุปกรณ์ ChromeOS

หากต้องการอัปเดตอุปกรณ์ ChromeOS ให้ใช้คำขอ PUT ต่อไปนี้และรวมการให้สิทธิ์ที่อธิบายไว้ในคำขอสิทธิ์ ตัวอย่างโค้ดนี้มีการขึ้นบรรทัดใหม่เพื่อให้ง่ายต่อการอ่านทำความเข้าใจ 

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId เป็นตัวระบุที่ไม่ซ้ำสำหรับบัญชี Google ของลูกค้า
  • ในฐานะผู้ดูแลระบบบัญชี คุณยังใช้สตริง my_customer ที่แสดง customerId ของบัญชีได้ด้วย อีกวิธีหนึ่งในการรับค่า customerId ก็คือใช้การดำเนินการเรียกข้อมูลผู้ใช้ ใช้อีเมลของผู้ดูแลระบบหรือค่า id ผู้ใช้ที่ไม่ซ้ำของผู้ดูแลระบบในพารามิเตอร์เส้นทาง userKey ของการดำเนินการ
  • deviceId คือตัวระบุที่ไม่ซ้ำกันของอุปกรณ์ ซึ่งจะอยู่ในคำตอบของการดำเนินการเรียกข้อมูลอุปกรณ์ ChromeOS ทั้งหมด

ดูพร็อพเพอร์ตี้สตริงการค้นหา คำขอ และการตอบกลับได้ในเอกสารอ้างอิง API

ด้วย

คำขอ JSON

คําขอ JSON ตัวอย่างต่อไปนี้จะอัปเดตพร็อพเพอร์ตี้ annotatedUser, annotatedLocation, annotatedAssetId, notes และ orgUnitPath ของอุปกรณ์ ChromeOS ตัวอย่างโค้ดนี้มีการขึ้นบรรทัดใหม่เพื่อให้ง่ายต่อการอ่านทำความเข้าใจ 

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId?projection=full
 ตัวอย่างเนื้อหาของคำขอ 
{
  "deviceId": "device_id_value",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "1234567890",
  "notes": "Loaned from support",
  "orgUnitPath": "/corp/sales"
}

สำหรับคำขออัปเดต ให้ใส่เฉพาะพร็อพเพอร์ตี้ที่มีค่าที่อัปเดตแล้วในคำขอ

คำขอที่สำเร็จจะแสดงรหัสสถานะ HTTP 200 นอกเหนือจากรหัสสถานะแล้ว การตอบสนองจะแสดงพร็อพเพอร์ตี้สำหรับอุปกรณ์ ChromeOS ที่อัปเดตแล้วด้วย

การยกเลิกการจัดสรรหรือปิดใช้อุปกรณ์ ChromeOS

หากต้องการยกเลิกการจัดสรรหรือปิดใช้อุปกรณ์ ChromeOS ให้ใช้คำขอ POST ต่อไปนี้ และรวมการให้สิทธิ์ที่อธิบายไว้ในคำขอสิทธิ์ ตัวอย่างโค้ดนี้มีการขึ้นบรรทัดใหม่เพื่อให้ง่ายต่อการอ่านทำความเข้าใจ 

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

  • customerId เป็นตัวระบุที่ไม่ซ้ำสำหรับบัญชี Google ของลูกค้า
  • ในฐานะผู้ดูแลระบบบัญชี คุณสามารถใช้สตริง my_customer ที่แสดง customerId ของบัญชีได้ด้วย อีกวิธีหนึ่งในการรับค่า customerId ก็คือใช้การดำเนินการเรียกข้อมูลผู้ใช้ ใช้อีเมลของผู้ดูแลระบบหรือค่า id ผู้ใช้ที่ไม่ซ้ำของผู้ดูแลระบบในพารามิเตอร์เส้นทาง userKey ของการดำเนินการ

ดูพร็อพเพอร์ตี้คำขอและการตอบกลับได้ที่เอกสารอ้างอิง API

คำขอ JSON

คำขอ JSON ต่อไปนี้แสดงตัวอย่างคำขอยกเลิกการจัดสรรและปิดใช้อุปกรณ์ ChromeOS 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
 เนื้อหาของคำขอสำหรับการยกเลิกการจัดสรรตัวอย่างมีดังนี้ 
{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
  "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION",
  "deprovisionReason": "DEPROVISION_REASON_RETIRING_DEVICE"
}
 เนื้อหาของคำขอสำหรับการปิดใช้คือ 
  {
    "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
    "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE",
  }

คำขอที่สำเร็จจะแสดงรหัสสถานะ HTTP 200

ย้ายอุปกรณ์ ChromeOS ไปยังหน่วยขององค์กร

หากต้องการย้ายอุปกรณ์ ChromeOS สูงสุด 50 เครื่องไปยังหน่วยขององค์กร ให้ใช้คำขอ POST ต่อไปนี้และรวมการให้สิทธิ์ที่อธิบายไว้ในคำขอสิทธิ์ ตัวอย่างโค้ดนี้มีการขึ้นบรรทัดใหม่เพื่อให้ง่ายต่อการอ่านทำความเข้าใจ 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/moveDevicesToOu?orgUnitPath=/SomeOuName
  • customerId เป็นตัวระบุที่ไม่ซ้ำสำหรับบัญชี Google ของลูกค้า
  • ในฐานะผู้ดูแลระบบบัญชี คุณยังใช้สตริง my_customer ที่แสดง customerId ของบัญชีได้ด้วย อีกวิธีหนึ่งในการรับค่า customerId ก็คือใช้การดำเนินการเรียกข้อมูลผู้ใช้ ใช้อีเมลของผู้ดูแลระบบหรือค่าผู้ใช้ id ที่ไม่ซ้ำของผู้ดูแลระบบในพารามิเตอร์เส้นทาง userKey ของการดำเนินการ

ดูพร็อพเพอร์ตี้คำขอและการตอบกลับได้ที่เอกสารอ้างอิง API

คำขอ JSON

คำขอ JSON ต่อไปนี้แสดงตัวอย่างคำขอย้ายอุปกรณ์ ChromeOS 3 เครื่องไปยังหน่วยขององค์กรชื่อ /Marketing 

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

เนื้อหาคําขอสําหรับการย้ายอุปกรณ์มีดังนี้

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

คำขอที่สำเร็จจะแสดงรหัสสถานะ HTTP 200