Directory API: Chrome-Geräte

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

Wenn Sie eine Liste aller Chrome-Geräte zurückgeben möchten, die einem Konto zugewiesen sind, verwenden Sie die folgende GET-Anfrage und fügen Sie 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. Das ist die customerId Ihres Kontos. Sie können den Wert customerId auch mit der Aktion Nutzer abrufen abrufen. Verwenden Sie für die Aktion im Pfadparameter userKey Ihre Administrator-E-Mail-Adresse oder Ihren eindeutigen Administrator-Nutzerid-Wert.

Informationen zu Suchstrings, Anfragen und Antworteigenschaften finden Sie in der API-Referenz.

Beispiel: Geräte nach Nutzer filtern

In diesem Beispiel wird mit query=user:help desk nach einem bestimmten Nutzer gesucht. Die Antwort enthält eine einzelne chromeosdevice-Ressource mit dem annotatedUser help desk:

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 mit query=id:123456 nach einer bestimmten Seriennummer gesucht. Dabei steht 123456 für die Seriennummer des Geräts. Die folgende Antwort 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 Properties model, meid und macAddress. Wenn ein Gerät diese Eigenschaften nicht hat, werden sie nicht in die Antwort aufgenommen. Ausführliche Informationen finden Sie in der Ressourcendarstellung „chromeosdevices“.

MEID-Liste exportieren

Die meid ist die MEID-Nummer (Mobile Equipment Identifier) für die 3G-Mobilfunkkarte auf einem Chrome-Gerät. Eine MEID wird in der Regel verwendet, wenn ein Gerät dem Postpaid-Tarif eines Mobilfunkanbieters hinzugefügt wird. Wenn Sie die MEID-Liste exportieren möchten, verwenden Sie die folgende GET-Anfrage und die nextPageToken-Werte, um die vollständige Liste der MEIDs abzurufen. Zur besseren Lesbarkeit enthält dieses Codebeispiel Zeilenumbrüche: 

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

Chrome-Gerät abrufen

Wenn Sie die Eigenschaften eines Chrome-Geräts abrufen möchten, verwenden Sie die folgende GET-Anfrage und fügen Sie die in 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. Das ist die customerId Ihres Kontos. Sie können den Wert customerId auch mit der Aktion Nutzer abrufen abrufen. Verwenden Sie für die Aktion im Pfadparameter userKey Ihre Administrator-E-Mail-Adresse oder Ihren eindeutigen Administrator-Nutzerid-Wert.
  • deviceId ist eine eindeutige Kennung für ein Gerät und wird in der Antwort auf den Vorgang Alle Chrome-Geräte abrufen zurückgegeben.

Informationen zu Suchstrings, Anfragen und Antworteigenschaften finden Sie in der API-Referenz.

JSON-Anfrage

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

Bei einer erfolgreichen Anfrage wird der HTTP-Statuscode 200 zurückgegeben. Zusammen mit dem Statuscode werden in der Antwort die Eigenschaften des Chrome-Geräts 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 Sie ein Chrome-Gerät aktualisieren möchten, verwenden Sie die folgende PUT-Anfrage und fügen Sie die in 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. Das ist die customerId Ihres Kontos. Sie können den Wert customerId auch mit der Aktion Nutzer abrufen abrufen. Verwenden Sie für die Aktion im Pfadparameter userKey Ihre Administrator-E-Mail-Adresse oder Ihren eindeutigen Administrator-Nutzerid-Wert.
  • deviceId ist eine eindeutige Kennung für ein Gerät und wird in der Antwort auf den Vorgang Alle Chrome-Geräte abrufen zurückgegeben.

Informationen zu Suchstrings, Anfrage- und Antworteigenschaften finden Sie in der API-Referenz.

JSON-Anfrage

In der folgenden Beispiel-JSON-Anfrage werden die Eigenschaften 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 einen Anfragetext: 
{
  "deviceId": "device_id_value",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "1234567890",
  "notes": "Loaned from support",
  "orgUnitPath": "/corp/sales"
}

Fügen Sie in einer Aktualisierungsanfrage nur die Properties mit aktualisierten Werten ein.

Bei einer erfolgreichen Anfrage wird der HTTP-Statuscode 200 zurückgegeben. Zusammen mit dem Statuscode werden in der Antwort die Eigenschaften für das aktualisierte Chrome-Gerät zurückgegeben.

Chrome-Geräte für neue Zwecke verwenden oder aussortieren

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 in 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. Das ist die customerId Ihres Kontos. Sie können den Wert customerId auch mit der Aktion Nutzer abrufen abrufen. Verwenden Sie für die Aktion im Pfadparameter userKey Ihre Administrator-E-Mail-Adresse oder Ihren eindeutigen Administrator-Nutzerid-Wert.

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

JSON-Anfrage

Die folgende JSON-Anfrage ist ein Beispiel für eine Anfrage zum Aufheben der Bereitstellung und Deaktivieren von Chrome-Geräten: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
 Der Anfragetext für eine Beispielentfernung der Geräteverwaltung 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",
  }

Bei einer erfolgreichen Anfrage wird der HTTP-Statuscode 200 zurückgegeben.

Chrome-Geräte in eine 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 in 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. Das ist die customerId Ihres Kontos. Sie können den Wert customerId auch mit der Aktion Retrieve a user (Nutzer abrufen) abrufen. Verwenden Sie für die Aktion im Pfadparameter userKey Ihre Administrator-E-Mail-Adresse oder Ihren eindeutigen Administrator-Nutzerid-Wert.

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

JSON-Anfrage

Die folgende JSON-Anfrage ist ein Beispiel für die Verschiebung 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"]
}

Bei einer erfolgreichen Anfrage wird der HTTP-Statuscode 200 zurückgegeben.