Directory API: Chrome-Geräte

Alle Chrome-Geräte für ein Konto abrufen

Wenn du eine Liste aller Chrome-Geräte abrufen möchtest, die einem Konto zugewiesen sind, verwende die folgende GET-Anfrage und füge die unter Anfragen autorisieren beschriebene Autorisierung ein. Zur besseren Lesbarkeit enthält dieses Codebeispiel Zeilenumbrüche: 

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

  • Die customerId ist eine eindeutige Kennung für das Google-Konto des Kunden.
  • Als Kontoadministrator können Sie auch den String my_customer verwenden, der für customerId Ihres Kontos steht. Eine andere Möglichkeit zum Abrufen des customerId-Werts ist die Verwendung des Vorgangs Nutzer abrufen. Verwenden Sie im Pfadparameter userKey des Vorgangs die E-Mail-Adresse Ihres Administrators oder den id-Wert Ihres eindeutigen Administrators.

Informationen zu Abfragestrings, Anfrage- und Antwortattributen finden Sie in der API-Referenz.

Beispiel: Geräte nach Nutzer filtern

In diesem Beispiel wird mithilfe von query=user:help desk nach einem bestimmten Nutzer gesucht. Die Antwort enthält eine einzelne chromeosdevice-Ressource, wobei annotatedUser den Wert help desk hat:

JSON-Anfrage

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-Antwort

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

Beispiel: Geräte nach Seriennummer filtern

In diesem Beispiel wird mithilfe von query=id:123456 nach einer bestimmten Seriennummer gesucht, wobei 123456 die Seriennummer des Geräts ist. Die Antwort unten enthält eine einzelne übereinstimmende Antwort, bei der das Attribut serialNumber mit dem Suchwert übereinstimmt.

JSON-Anfrage

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-Antwort

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

Dieses Antwortbeispiel enthält die Attribute model, meid und macAddress. Wenn ein Gerät diese Eigenschaften nicht hat, sind sie nicht in der Antwort enthalten. Weitere Informationen finden Sie unter Chromeosdevices-Ressourcendarstellung.

MEID-Liste exportieren

Die meid ist die MEID (Mobile Equipment Identifier) für die 3G-Mobilfunkkarte in einem Chrome-Gerät. Eine MEID wird in der Regel verwendet, wenn ein Gerät dem Postpay-Serviceplan eines Mobilfunkanbieters hinzugefügt wird. Verwenden Sie zum Exportieren der MEID-Liste die folgende GET-Anfrage und die nextPageToken-Werte, um die vollständige Liste der MEIDs abzurufen. Zur besseren Lesbarkeit enthält dieses Codebeispiel Zeilenrückmeldungen: 

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

Chrome-Gerät abrufen

Wenn du die Eigenschaften eines Chrome-Geräts abrufen möchtest, verwende die folgende GET-Anfrage und schließe die unter Anfragen autorisieren beschriebene Autorisierung ein. Zur besseren Lesbarkeit enthält dieses Codebeispiel Zeilenumbrüche: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • Die customerId ist eine eindeutige Kennung für das Google-Konto des Kunden.
  • Als Kontoadministrator können Sie auch den String my_customer verwenden, der für customerId Ihres Kontos steht. Eine andere Möglichkeit zum Abrufen des customerId-Werts ist die Verwendung des Vorgangs Nutzer abrufen. Verwenden Sie im Pfadparameter userKey des Vorgangs die E-Mail-Adresse Ihres Administrators oder den id-Wert Ihres eindeutigen Administrators.
  • Die deviceId ist eine eindeutige Kennzeichnung für ein Gerät und wird in der Antwort des Vorgangs Alle Chrome-Geräte abrufen ermittelt.

Informationen zu Abfragestrings, Anfrage- und Antwortattributen finden Sie in der API-Referenz.

JSON-Anfrage

Eine Beispielanfrage. Zur besseren Lesbarkeit enthält dieses Codebeispiel Zeilenumbrüche:
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos/deviceId?projection=full

JSON-Antwort

Eine erfolgreiche Anfrage gibt den HTTP 200-Statuscode zurück. Zusammen mit dem Statuscode werden in der Antwort die Chrome-Geräteeigenschaften zurückgegeben: 

{
  "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-Gerät aktualisieren

Wenn du ein Chrome-Gerät aktualisieren möchtest, verwende die folgende PUT-Anfrage und füge die unter Anfragen autorisieren beschriebene Autorisierung ein. Zur besseren Lesbarkeit enthält dieses Codebeispiel Zeilenumbrüche: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • Die customerId ist eine eindeutige Kennung für das Google-Konto des Kunden.
  • Als Kontoadministrator können Sie auch den String my_customer verwenden, der für customerId Ihres Kontos steht. Eine andere Möglichkeit zum Abrufen des customerId-Werts ist die Verwendung des Vorgangs Nutzer abrufen. Verwenden Sie im Pfadparameter userKey des Vorgangs die E-Mail-Adresse Ihres Administrators oder den id-Wert Ihres eindeutigen Administrators.
  • Die deviceId ist eine eindeutige Kennzeichnung für ein Gerät und wird in der Antwort des Vorgangs Alle Chrome-Geräte abrufen ermittelt.

Informationen zu Abfragestrings, Anfrage- und Antwortattributen finden Sie in der API-Referenz.

JSON-Anfrage

Mit der folgenden JSON-Beispielanfrage werden die Attribute annotatedUser, annotatedLocation, annotatedAssetId, notes und orgUnitPath eines Chrome-Geräts aktualisiert. Zur besseren Lesbarkeit enthält dieses Codebeispiel Zeilenumbrüche: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId?projection=full
Beispiel für den Anfragetext: 
{
  "deviceId": "device_id_value",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "1234567890",
  "notes": "Loaned from support",
  "orgUnitPath": "/corp/sales"
}

Geben Sie bei einer Aktualisierungsanfrage nur die Attribute mit aktualisierten Werten an.

Eine erfolgreiche Anfrage gibt den HTTP 200-Statuscode zurück. Zusammen mit dem Statuscode werden in der Antwort die Eigenschaften des aktualisierten Chrome-Geräts zurückgegeben.

Bereitstellung von Chrome-Geräten aufheben oder Chrome-Geräte deaktivieren

Wenn Sie die Bereitstellung von Chrome-Geräten aufheben oder sie deaktivieren möchten, verwenden Sie die folgende POST-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein. Zur besseren Lesbarkeit enthält dieses Codebeispiel Zeilenumbrüche: 

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

  • Die customerId ist eine eindeutige Kennung für das Google-Konto des Kunden.
  • Als Kontoadministrator können Sie auch den String my_customer verwenden, der für customerId Ihres Kontos steht. Eine andere Möglichkeit zum Abrufen des customerId-Werts ist die Verwendung des Vorgangs Nutzer abrufen. Verwenden Sie im Pfadparameter userKey des Vorgangs die E-Mail-Adresse Ihres Administrators oder den id-Wert Ihres eindeutigen Administrators.

Informationen zu den Anfrage- und Antwortattributen finden Sie in der API-Referenz.

JSON-Anfrage

Die folgende JSON-Anfrage zeigt eine Beispielanfrage zum Aufheben der Bereitstellung und Deaktivierung von Chrome-Geräten: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
Der Anfragetext für die Aufhebung der Bereitstellung lautet: 
{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
  "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION",
  "deprovisionReason": "DEPROVISION_REASON_RETIRING_DEVICE"
}
Der Anfragetext für die Deaktivierung lautet: 
  {
    "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
    "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE",
  }

Eine erfolgreiche Anfrage gibt den HTTP 200-Statuscode zurück.

Chrome-Geräte in Organisationseinheit verschieben

Wenn Sie bis zu 50 Chrome-Geräte in eine Organisationseinheit verschieben möchten, verwenden Sie die folgende POST-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein. Zur besseren Lesbarkeit enthält dieses Codebeispiel Zeilenumbrüche: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/moveDevicesToOu?orgUnitPath=/SomeOuName
  • Die customerId ist eine eindeutige Kennung für das Google-Konto des Kunden.
  • Als Kontoadministrator können Sie auch den String my_customer verwenden, der für customerId Ihres Kontos steht. Eine andere Möglichkeit zum Abrufen des customerId-Werts ist die Verwendung des Vorgangs Nutzer abrufen. Verwenden Sie im Pfadparameter userKey des Vorgangs die E-Mail-Adresse Ihres Administrators oder den id-Wert Ihres eindeutigen Administrators.

Informationen zu den Anfrage- und Antwortattributen finden Sie in der API-Referenz.

JSON-Anfrage

Die folgende JSON-Anfrage zeigt eine Beispielanfrage zum Verschieben von drei Chrome-Geräten in eine Organisationseinheit mit dem Namen /Marketing: 

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

Der Anfragetext für die Geräteverschiebung lautet:

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

Eine erfolgreiche Anfrage gibt den HTTP 200-Statuscode zurück.