API Directory: dispositivi Chrome

Recupera tutti i dispositivi Chrome per un account

Per restituire un elenco di tutti i dispositivi Chrome assegnati a un account, utilizza la seguente richiesta GET e includi l'autorizzazione descritta in Autorizzare richieste. Per una migliore leggibilità, questo esempio di codice presenta le righe restituite: 

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

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

Per le stringhe di query, le proprietà della richiesta e della risposta, consulta la documentazione di riferimento API.

Esempio: filtrare i dispositivi per utente

In questo esempio viene cercato un utente specifico utilizzando query=user:help desk. La risposta contiene una singola risorsa chromeosdevice, dove 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 per 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à, non vengono incluse nella risposta. Per maggiori dettagli, consulta la rappresentazione delle risorse ChromeOS.

Esportare un elenco MEID

Il meid è l'identificatore MEID (Mobile Equipment Identifier) per la carta per dispositivi mobili 3G in un dispositivo Chrome. Il codice MEID viene generalmente utilizzato quando si aggiunge un dispositivo al piano di servizio con pagamento posticipato di un operatore wireless. Per esportare l'elenco MEID, utilizza la seguente richiesta GET e i valori nextPageToken per recuperare l'elenco completo dei MEID. Per una migliore leggibilità, questo esempio di codice presenta le righe restituite: 

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

Recupero di un dispositivo Chrome

Per recuperare le proprietà di un dispositivo Chrome, utilizza la seguente richiesta GET e includi l'autorizzazione descritta in Autorizzare richieste. Per una migliore leggibilità, questo esempio di codice presenta le righe restituite: 

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

Per le stringhe di query, le proprietà della richiesta e della risposta, consulta la documentazione di riferimento API.

Richiesta JSON

Una richiesta di esempio. Per una migliore leggibilità, questo esempio di codice presenta le righe restituite: 
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos/deviceId?projection=full

Risposta JSON

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

Aggiornare un dispositivo Chrome

Per aggiornare un dispositivo Chrome, usa la seguente richiesta PUT e includi l'autorizzazione descritta in Autorizzare richieste. Per una migliore leggibilità, questo esempio di codice presenta le righe restituite: 

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

Per le stringhe di query, le proprietà della richiesta e della risposta, consulta la documentazione di riferimento API.

Richiesta JSON

La richiesta JSON di esempio seguente aggiorna le proprietà annotatedUser, annotatedLocation, annotatedAssetId, notes e orgUnitPath di un dispositivo Chrome. Per una migliore leggibilità, questo esempio di codice presenta le seguenti righe: 

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 valori aggiornati.

Una richiesta andata a buon fine restituisce un codice di stato HTTP 200. Insieme al codice di stato, la risposta restituisce le proprietà per il dispositivo Chrome aggiornato.

Deprovisioning o disattivazione dei dispositivi Chrome

Per eseguire il deprovisioning o disattivare i dispositivi Chrome, utilizza la seguente richiesta POST e includi l'autorizzazione descritta in Autorizzare richieste. Per una migliore leggibilità, questo esempio di codice presenta le righe restituite: 

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

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

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

Richiesta JSON

La seguente richiesta JSON mostra una richiesta di esempio per eseguire il deprovisioning dei dispositivi Chrome e disattivarli: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
Il corpo della richiesta di deprovisioning di un campione è: 
{
  "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 andata a buon fine restituisce un codice di stato HTTP 200.

Sposta dispositivi Chrome nell'unità organizzativa

Per spostare fino a 50 dispositivi Chrome in un'unità organizzativa, utilizza la seguente richiesta POST e includi l'autorizzazione descritta in Autorizzare richieste. Per una migliore leggibilità, questo esempio di codice presenta le righe restituite: 

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

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

Richiesta JSON

La seguente richiesta JSON mostra una richiesta di esempio per spostare tre dispositivi Chrome 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 andata a buon fine restituisce un codice di stato HTTP 200.