Directory API: Chrome-Geräte

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

So rufen Sie eine Liste aller Chrome-Geräte auf, die einem Konto zugewiesen sind: GET-Anfrage und einschließlich der in folgendem Artikel beschriebenen Autorisierung: Anfragen autorisieren. Zur besseren Lesbarkeit Dieses Codebeispiel enthält 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, steht für die customerId Ihres Kontos. Eine andere Möglichkeit, die customerId zu erhalten ist die Verwendung der Methode Nutzer abrufen . Verwenden Sie Ihre Administrator-E-Mail-Adresse oder den eindeutigen Administratornutzer id im Pfadparameter userKey des Vorgangs.

Informationen zu Abfragestrings, Anfrage- und Antwortattributen 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 eine einzelne chromeosdevice-Ressource enthält, wobei der annotatedUser ist 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 nach einer bestimmten Seriennummer gesucht: query=id:123456, wobei 123456 der Wert die Seriennummer des Geräts. Die unten gezeigte Antwort enthält eine einzelne übereinstimmende Antwort, wobei der Die Property serialNumber entspricht dem Suchwert.

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 model, meid und macAddress-Properties. Verfügt ein Gerät nicht über diese Eigenschaften, sind sie nicht die in der Antwort enthalten sind. Detaillierte Informationen finden Sie in der Chromeosdevices-Ressourcendarstellung

MEID-Liste exportieren

Die meid ist die MEID (Mobile Equipment Identifier) für die 3G-Karte in einem Chrome-Gerät. Eine MEID wird in der Regel verwendet, wenn ein Gerät zum nachträglicher Serviceplan. Verwenden Sie zum Exportieren der MEID-Liste die folgende GET-Anfrage und nextPageToken, um die vollständige Liste der MEIDs abzurufen. Zur besseren Lesbarkeit Codebeispiel enthält Zeilenrückgaben: 

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 die in den Anfragen autorisieren. Zur besseren Lesbarkeit Dieses Codebeispiel enthält 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, steht für die customerId Ihres Kontos. Eine andere Möglichkeit, die customerId zu erhalten ist die Verwendung der Methode Nutzer abrufen . Verwenden Sie Ihre Administrator-E-Mail-Adresse oder den eindeutigen Administratornutzer id im Pfadparameter userKey des Vorgangs.
  • Die deviceId ist eine eindeutige Kennung für ein Gerät und wird in der Antwort von den Vorgang Alle Chrome-Geräte abrufen ausführen.

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

JSON-Anfrage

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

JSON-Antwort

Eine erfolgreiche Anfrage gibt eine HTTP 200-Statuscode. Zusammen mit Wenn der Statuscode den Statuscode enthält, 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 den Autorisierung gemäß den Anfragen autorisieren. Zur besseren Lesbarkeit Dieses Codebeispiel enthält 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, steht für die customerId Ihres Kontos. Eine andere Möglichkeit, die customerId zu erhalten ist die Verwendung der Methode Nutzer abrufen . Verwenden Sie Ihre Administrator-E-Mail-Adresse oder den eindeutigen Administratornutzer id im Pfadparameter userKey des Vorgangs.
  • Die deviceId ist eine eindeutige Kennung für ein Gerät und wird in der Antwort von den Vorgang Alle Chrome-Geräte abrufen ausführen.

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

JSON-Anfrage

Mit dem folgenden Beispiel für eine JSON-Anfrage wird die annotatedUser eines Chrome-Geräts aktualisiert. annotatedLocation, annotatedAssetId, notes und orgUnitPath-Properties. Zur besseren Lesbarkeit enthält dieses Codebeispiel folgende Zeilen: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId?projection=full
Das 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 eine HTTP 200-Statuscode. Zusammen mit Statuscode enthält die Antwort die Eigenschaften für das aktualisierte Chrome-Gerät.

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

Wenn Sie die Bereitstellung von Chrome-Geräten aufheben oder Chrome-Geräte deaktivieren möchten, verwenden Sie die folgende POST-Anfrage und enthalten die in den Anfragen autorisieren. Zur besseren Lesbarkeit Dieses Codebeispiel enthält 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, steht für die customerId Ihres Kontos. Eine andere Möglichkeit, die customerId zu erhalten ist die Verwendung der Methode Nutzer abrufen . Verwenden Sie Ihre Administrator-E-Mail-Adresse oder den eindeutigen Administratornutzer id im Pfadparameter userKey des Vorgangs.

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 zum Deaktivieren Chrome-Geräte: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
Der Anfragetext für das Aufheben der Bereitstellung eines Beispiels 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 eine HTTP 200-Statuscode.

Chrome-Geräte in Organisationseinheit verschieben

So verschieben Sie bis zu 50 Chrome-Geräte in eine Organisationseinheit: POST-Anfrage und einschließlich der in folgendem Artikel beschriebenen Autorisierung: Anfragen autorisieren. Zur besseren Lesbarkeit Dieses Codebeispiel enthält 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, steht für die customerId Ihres Kontos. Eine andere Möglichkeit, die customerId zu erhalten ist die Verwendung der Methode Retrieve a user (Nutzervorgang) Verwenden Sie Ihre Administrator-E-Mail-Adresse oder Ihren eindeutigen Administratornutzer. id-Wert im Pfadparameter userKey des Vorgangs.

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 ein 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 eine HTTP 200-Statuscode.