API Directory: dispositivi ChromeOS

Recuperare tutti i dispositivi ChromeOS per un account

Per restituire un elenco di tutti i dispositivi ChromeOS assegnati a un account, utilizza la seguente richiesta GET e includi l'autorizzazione descritta nell'articolo Autorizzare le richieste. Per favorire la leggibilità, in questo esempio di codice sono stati inseriti dei ritorni a capo. 

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 è un identificatore univoco dell'Account Google del cliente.
  • In qualità di amministratore dell'account, puoi anche utilizzare la stringa my_customer che rappresenta il customerId del tuo account. Un altro modo per ottenere il valore customerId è utilizzare l'operazione Recupero di un utente. Utilizza l'indirizzo email dell'amministratore o il valore id utente unico dell'amministratore nel parametro del percorso userKey dell'operazione.

Per le proprietà della stringa di query, della richiesta e della risposta, consulta il riferimento API.

Esempio: filtrare i dispositivi in base all'utente

Questo esempio cerca un utente specifico utilizzando query=user:help desk. La risposta contiene una singola risorsa chromeosdevice, in cui annotatedUser è help desk:

Richiesta 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

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

Esempio: filtrare i dispositivi in base al numero di serie

Questo esempio cerca un numero di serie specifico utilizzando query=id:123456, dove 123456 è il numero di serie del dispositivo. La risposta mostrata di seguito contiene una singola risposta corrispondente, in cui la proprietà serialNumber corrisponde al valore di ricerca.

Richiesta 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

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

Questo esempio di risposta include le proprietà model, meid e macAddress. Se un dispositivo non dispone di queste proprietà, queste non vengono incluse nella risposta. Per maggiori dettagli, consulta la rappresentazione della risorsa Chromeosdevices.

Esportare un elenco di MEID

meid è l'identificatore dell'apparecchiatura mobile (MEID) della scheda mobile 3G in un dispositivo ChromeOS. Un MEID viene in genere utilizzato quando si aggiunge un dispositivo al piano di servizio post-pagato di un operatore wireless. Per esportare l'elenco di MEID, utilizza la seguente richiesta GET e i valori nextPageToken per recuperare l'elenco completo dei MEID. Per favorire la leggibilità, in questo esempio di codice sono stati inseriti dei ritorni a capo. 

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

Recuperare un dispositivo ChromeOS

Per recuperare le proprietà di un dispositivo ChromeOS, utilizza la seguente richiesta GET e includi l'autorizzazione descritta nell'articolo Autorizzare le richieste. Per favorire la leggibilità, in questo esempio di codice sono stati inseriti dei ritorni a capo. 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId è un identificatore univoco dell'Account Google del cliente.
  • In qualità di amministratore dell'account, puoi anche utilizzare la stringa my_customer che rappresenta il customerId del tuo account. Un altro modo per ottenere il valore customerId è utilizzare l'operazione Recupero di un utente. Utilizza l'indirizzo email dell'amministratore o il valore id utente unico dell'amministratore nel parametro del percorso userKey dell'operazione.
  • deviceId è un identificatore univoco di un dispositivo e si trova nella risposta dell'operazione Recupero di tutti i dispositivi ChromeOS.

Per le proprietà della stringa di query, della richiesta e della risposta, consulta il riferimento API.

Richiesta JSON

Esempio di richiesta. Per favorire la leggibilità, in questo esempio di codice sono stati inseriti dei ritorni a capo. 
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos/deviceId?projection=full

Risposta JSON

Una richiesta riuscita restituisce un codice di stato HTTP 200. Oltre al codice di stato, la risposta restituisce le proprietà del dispositivo 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"
}

Aggiornare un dispositivo ChromeOS

Per aggiornare un dispositivo ChromeOS, utilizza la seguente richiesta PUT e includi l'autorizzazione descritta nell'articolo Autorizzare le richieste. Per favorire la leggibilità, in questo esempio di codice sono stati inseriti dei ritorni a capo. 

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId è un identificatore univoco dell'Account Google del cliente.
  • In qualità di amministratore dell'account, puoi anche utilizzare la stringa my_customer, che rappresenta il customerId del tuo account. Un altro modo per ottenere il valore customerId è utilizzare l'operazione Recupero di un utente. Utilizza l'indirizzo email dell'amministratore o il valore id utente unico dell'amministratore nel parametro del percorso userKey dell'operazione.
  • deviceId è un identificatore univoco di un dispositivo e si trova nella risposta dell'operazione Recupero di tutti i dispositivi ChromeOS.

Per le proprietà della stringa di query, della richiesta e della risposta, consulta il riferimento API.

Richiesta JSON

Il seguente esempio di richiesta JSON aggiorna le proprietà annotatedUser, annotatedLocation, annotatedAssetId, notes e orgUnitPath di un dispositivo ChromeOS. Per favorire la leggibilità, in questo esempio di codice sono stati inseriti dei ritorni a capo. 

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId?projection=full
 Esempio di corpo della richiesta: 
{
  "deviceId": "device_id_value",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "1234567890",
  "notes": "Loaned from support",
  "orgUnitPath": "/corp/sales"
}

Per una richiesta di aggiornamento, includi nella richiesta solo le proprietà con i valori aggiornati.

Una richiesta riuscita restituisce un codice di stato HTTP 200. Oltre al codice di stato, la risposta restituisce le proprietà del dispositivo ChromeOS aggiornato.

Eseguire il deprovisioning o la disattivazione dei dispositivi ChromeOS

Per eseguire il deprovisioning o la disattivazione dei dispositivi ChromeOS, utilizza la seguente richiesta POST e includi l'autorizzazione descritta in Autorizzare le richieste. Per favorire la leggibilità, in questo esempio di codice sono stati inseriti dei ritorni a capo. 

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

  • customerId è un identificatore univoco dell'Account Google del cliente.
  • In qualità di amministratore dell'account, puoi anche utilizzare la stringa my_customer, che rappresenta il customerId del tuo account. Un altro modo per ottenere il valore customerId è utilizzare l'operazione Recupero di un utente. Utilizza l'indirizzo email dell'amministratore o il valore id utente unico dell'amministratore nel parametro del percorso userKey dell'operazione.

Per le proprietà di richiesta e risposta, consulta il riferimento API.

Richiesta JSON

La seguente richiesta JSON mostra una richiesta di esempio per eseguire il deprovisioning e disattivare i dispositivi ChromeOS: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
 Il corpo della richiesta per un deprovisioning di esempio è: 
{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
  "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION",
  "deprovisionReason": "DEPROVISION_REASON_RETIRING_DEVICE"
}
 Il corpo della richiesta per la disattivazione è: 
  {
    "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
    "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE",
  }

Una richiesta riuscita restituisce un codice di stato HTTP 200.

Spostare i dispositivi ChromeOS nell'unità organizzativa

Per spostare fino a 50 dispositivi ChromeOS in un'unità organizzativa, utilizza la seguente richiestaPOST e includi l'autorizzazione descritta nell'articoloAutorizzare le richieste. Per favorire la leggibilità, in questo esempio di codice sono stati inseriti dei ritorni a capo. 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/moveDevicesToOu?orgUnitPath=/SomeOuName
  • customerId è un identificatore univoco dell'Account Google del cliente.
  • In qualità di amministratore dell'account, puoi anche utilizzare la stringa my_customer, che rappresenta il customerId del tuo account. Un altro modo per ottenere il valore customerId è utilizzare l'operazione Recupero di un utente. Utilizza l'indirizzo email dell'amministratore o il valore id utente unico dell'amministratore nel parametro del percorso userKey dell'operazione.

Per le proprietà di richiesta e risposta, consulta il riferimento API.

Richiesta JSON

La seguente richiesta JSON mostra una richiesta di esempio per spostare 3 dispositivi ChromeOS in un'unità organizzativa denominata /Marketing: 

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

Il corpo della richiesta per lo spostamento del dispositivo è:

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

Una richiesta riuscita restituisce un codice di stato HTTP 200.