Directory API: อุปกรณ์ Chrome

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

หากต้องการส่งคืนรายการอุปกรณ์ Chrome ทั้งหมดที่กำหนดให้กับบัญชี ให้ใช้รายการต่อไปนี้ 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 เดียว โดยที่ annotatedUserhelp 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 หากอุปกรณ์ไม่มีคุณสมบัติเหล่านี้ ก็จะไม่สามารถ ที่รวมอยู่ในคำตอบ ดูรายละเอียดทั้งหมดได้ที่ การแสดงทรัพยากรของอุปกรณ์ ChromeOS

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

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

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

ดึงข้อมูลอุปกรณ์ Chrome

หากต้องการเรียกพร็อพเพอร์ตี้ของอุปกรณ์ Chrome ให้ใช้คำขอ 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 เป็นตัวระบุที่ไม่ซ้ำกันของอุปกรณ์ และพบในการตอบกลับ การดำเนินการดึงข้อมูลอุปกรณ์ Chrome ทั้งหมด

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

คำขอ JSON

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

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

คำขอที่สำเร็จแสดงผล รหัสสถานะ HTTP 200 พร้อมกับ รหัสสถานะ การตอบสนองจะแสดงคุณสมบัติของอุปกรณ์ 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"
}

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

หากต้องการอัปเดตอุปกรณ์ Chrome ให้ใช้คำขอ 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 เป็นตัวระบุที่ไม่ซ้ำกันของอุปกรณ์ และพบในการตอบกลับ การดำเนินการดึงข้อมูลอุปกรณ์ Chrome ทั้งหมด

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

คำขอ JSON

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

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 พร้อมกับ รหัสสถานะ การตอบสนองจะแสดงคุณสมบัติสำหรับอุปกรณ์ Chrome ที่อัปเดต

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

หากต้องการยกเลิกการจัดสรรหรือปิดใช้อุปกรณ์ Chrome ให้ใช้คำขอ 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 ต่อไปนี้แสดงตัวอย่างคำขอยกเลิกการจัดสรรและปิดใช้ อุปกรณ์ Chrome: 

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

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

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

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

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

คำขอ JSON

คำขอ JSON ต่อไปนี้แสดงตัวอย่างคำขอย้ายอุปกรณ์ Chrome 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