API de Directory: Dispositivos Chrome

Recuperar todos los dispositivos Chrome de una cuenta

Para ver una lista de todos los dispositivos Chrome asignados a una cuenta, usa la siguiente solicitud GET e incluye la autorización que se describe en Cómo autorizar solicitudes. Para facilitar la lectura, esta muestra de código tiene los siguientes resultados de líneas: 

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

  • El customerId es un identificador único de la Cuenta de Google del cliente.
  • Como administrador de cuentas, también puedes usar la string my_customer, que representa el customerId de tu cuenta. Otra forma de obtener el valor customerId es usar la operación Recuperar un usuario. Usa la dirección de correo electrónico de tu administrador o el valor id de tu usuario único de administrador en el parámetro de ruta de acceso userKey de la operación.

Para obtener información sobre las strings de consulta, la solicitud y las propiedades de respuesta, consulta la Referencia de la API.

Ejemplo: Cómo filtrar dispositivos por usuario

En este ejemplo, se busca un usuario específico con query=user:help desk. La respuesta contiene un solo recurso chromeosdevice, en el que annotatedUser es help desk:

Solicitud 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

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

Ejemplo: Cómo filtrar dispositivos por número de serie

En este ejemplo, se busca un número de serie específico mediante query=id:123456, donde 123456 es el número de serie del dispositivo. La respuesta que se muestra a continuación contiene una sola respuesta coincidente, en la que la propiedad serialNumber coincide con el valor de búsqueda.

Solicitud 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

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

En este ejemplo de respuesta, se incluyen las propiedades model, meid y macAddress. Si un dispositivo no tiene estas propiedades, no se incluyen en la respuesta. Para obtener información completa, consulta la representación de recursos de dispositivos ChromeOS.

Cómo exportar una lista de MEID

meid es el identificador de equipo móvil (MEID) para la tarjeta móvil 3G en un dispositivo Chrome. Por lo general, se usa un MEID cuando se agrega un dispositivo al plan de servicios pospago de un proveedor de servicios inalámbricos. Para exportar la lista de MEID, usa la siguiente solicitud GET y los valores nextPageToken a fin de recuperar la lista completa de MEID. Para facilitar la lectura, esta muestra de código tiene los siguientes resultados de líneas: 

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

Recuperar un dispositivo Chrome

Para recuperar las propiedades de un dispositivo Chrome, usa la siguiente solicitud GET e incluye la autorización que se describe en Cómo autorizar solicitudes. Para facilitar la lectura, esta muestra de código tiene los siguientes resultados de líneas: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • El customerId es un identificador único de la Cuenta de Google del cliente.
  • Como administrador de cuentas, también puedes usar la string my_customer, que representa el customerId de tu cuenta. Otra forma de obtener el valor customerId es usar la operación Recuperar un usuario. Usa la dirección de correo electrónico de tu administrador o el valor id de tu usuario único de administrador en el parámetro de ruta de acceso userKey de la operación.
  • El deviceId es un identificador único para un dispositivo que se encuentra en la respuesta de la operación Recuperar todos los dispositivos Chrome.

Para obtener información sobre las strings de consulta, la solicitud y las propiedades de respuesta, consulta la Referencia de la API.

Solicitud JSON

Una solicitud de ejemplo. Para facilitar la lectura, esta muestra de código tiene los siguientes resultados de línea: 
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos/deviceId?projection=full

Respuesta JSON

Una solicitud correcta muestra un código de estado HTTP 200. Junto con el código de estado, la respuesta muestra las propiedades 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"
}

Actualizar un dispositivo Chrome

Para actualizar un dispositivo Chrome, usa la siguiente solicitud PUT e incluye la autorización que se describe en Cómo autorizar solicitudes. Para facilitar la lectura, esta muestra de código tiene los siguientes resultados de líneas: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • El customerId es un identificador único de la Cuenta de Google del cliente.
  • Como administrador de cuentas, también puedes usar la string my_customer, que representa el customerId de tu cuenta. Otra forma de obtener el valor customerId es usar la operación Recuperar un usuario. Usa la dirección de correo electrónico de tu administrador o el valor id de tu usuario único de administrador en el parámetro de ruta de acceso userKey de la operación.
  • El deviceId es un identificador único para un dispositivo que se encuentra en la respuesta de la operación Recuperar todos los dispositivos Chrome.

Para obtener información sobre las strings de consulta, la solicitud y las propiedades de respuesta, consulta la Referencia de la API.

Solicitud JSON

El siguiente ejemplo de solicitud JSON actualiza las propiedades annotatedUser, annotatedLocation, annotatedAssetId, notes y orgUnitPath de un dispositivo Chrome. Para facilitar la lectura, esta muestra de código tiene los siguientes resultados de línea: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId?projection=full
El ejemplo del cuerpo de la solicitud: 
{
  "deviceId": "device_id_value",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "1234567890",
  "notes": "Loaned from support",
  "orgUnitPath": "/corp/sales"
}

Para una solicitud de actualización, incluye en ella solo las propiedades con valores actualizados.

Una solicitud correcta muestra un código de estado HTTP 200. Junto con el código de estado, la respuesta muestra las propiedades del dispositivo Chrome actualizado.

Desaprovisionamiento o inhabilitación de dispositivos Chrome

Para desaprovisionar o inhabilitar dispositivos Chrome, usa la siguiente solicitud POST e incluye la autorización que se describe en Autoriza solicitudes. Para facilitar la lectura, esta muestra de código tiene los siguientes resultados de líneas: 

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

  • El customerId es un identificador único de la Cuenta de Google del cliente.
  • Como administrador de cuentas, también puedes usar la string my_customer, que representa el customerId de tu cuenta. Otra forma de obtener el valor customerId es usar la operación Recuperar un usuario. Usa la dirección de correo electrónico de tu administrador o el valor id de tu usuario único de administrador en el parámetro de ruta de acceso userKey de la operación.

Para ver las propiedades de solicitud y respuesta, consulta la Referencia de la API.

Solicitud JSON

La siguiente solicitud JSON muestra un ejemplo de solicitud para desaprovisionar e inhabilitar dispositivos Chrome: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
El cuerpo de la solicitud para una desaprovisionamiento de muestra es el siguiente: 
{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
  "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION",
  "deprovisionReason": "DEPROVISION_REASON_RETIRING_DEVICE"
}
El cuerpo de la solicitud para la inhabilitación es el siguiente: 
  {
    "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
    "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE",
  }

Una solicitud correcta muestra un código de estado HTTP 200.

Mover los dispositivos Chrome a la unidad organizativa

Para mover hasta 50 dispositivos Chrome a una unidad organizativa, usa la siguiente solicitud POST e incluye la autorización que se describe en Autoriza solicitudes. Para facilitar la lectura, esta muestra de código tiene los siguientes resultados de líneas: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/moveDevicesToOu?orgUnitPath=/SomeOuName
  • El customerId es un identificador único de la Cuenta de Google del cliente.
  • Como administrador de cuentas, también puedes usar la string my_customer, que representa el customerId de tu cuenta. Otra forma de obtener el valor customerId es usar la operación Recuperar un usuario. Usa la dirección de correo electrónico de tu administrador o el valor id de tu usuario único de administrador en el parámetro de ruta userKey de la operación.

Para ver las propiedades de solicitud y respuesta, consulta la Referencia de la API.

Solicitud JSON

En la siguiente solicitud JSON, se muestra una solicitud de ejemplo para mover 3 dispositivos Chrome a una unidad organizativa llamada /Marketing: 

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

El cuerpo de la solicitud para el traslado de dispositivo es el siguiente:

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

Una solicitud correcta muestra un código de estado HTTP 200.