API de Directory: Dispositivos Chrome

Cómo recuperar todos los dispositivos Chrome de una cuenta Cómo exportar una lista de MEID Cómo recuperar un dispositivo Chrome Cómo actualizar un dispositivo Chrome Cómo tomar medidas en un dispositivo Chrome Cómo mover dispositivos Chrome a una unidad organizativa

Nota: Todas las operaciones de la API admiten administradores delegados y revendedores autorizados de Google. Sin embargo, en esta versión de la API, las operaciones de Chrome y los dispositivos móviles no admiten el acceso administrativo remoto para los revendedores autorizados de Google.

Nota: A diferencia del resto de AdminSDK, las solicitudes por lotes para dispositivos ChromeOS con N elementos se cuentan como 1 para la cuota.

Cómo recuperar todos los dispositivos Chrome de una cuenta

Para devolver una lista de todos los dispositivos Chrome asignados a una cuenta, usa la siguiente solicitud GET y, luego, incluye la autorización que se describe en Autorizar solicitudes. Para facilitar la lectura, esta muestra de código tiene saltos de línea:

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 es un identificador único de la Cuenta de Google del cliente.
• Como administrador de la cuenta, también puedes usar la cadena my_customer, que representa el customerId de tu cuenta. Otra forma de obtener el valor de customerId es usar la operación Recuperar un usuario. Usa la dirección de correo electrónico de tu administrador o el valor de id de usuario único de tu administrador en el parámetro de ruta userKey de la operación.

Para conocer las cadenas de consulta, las solicitudes y las propiedades de respuesta, consulta la referencia de la API.

Ejemplo: Filtra 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": "[e-mail]"
         }
       ],
       "activeTimeRanges": [
         {
           "date": "2012-04-05",
           "activeTime": "3600000"
         }
       ],
     }
  ],
  "nextPageToken": "abcdefghijkl123"
}

Ejemplo: Filtra dispositivos por número de serie

En este ejemplo, se busca un número de serie específico con 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 todos los detalles, consulta la representación de recursos de Chromeosdevices.

Cómo exportar una lista de MEID

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

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

Cómo 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 Autorizar solicitudes. Para facilitar la lectura, esta muestra de código tiene saltos de línea:

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}

• customerId es un identificador único de la Cuenta de Google del cliente.
• Como administrador de la cuenta, también puedes usar la cadena my_customer, que representa el customerId de tu cuenta. Otra forma de obtener el valor de customerId es usar la operación Recuperar un usuario. Usa la dirección de correo electrónico de tu administrador o el valor de id de usuario único de tu administrador en el parámetro de ruta userKey de la operación.
• deviceId es un identificador único de un dispositivo y se encuentra en la respuesta de la operación Retrieve all Chrome devices.

Para conocer las cadenas de consulta, las solicitudes 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 saltos de línea:

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos/deviceId?projection=full

Respuesta JSON

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

Cómo actualizar un dispositivo Chrome

Para actualizar un dispositivo Chrome, usa la siguiente solicitud PUT y, luego, incluye la autorización que se describe en Cómo autorizar solicitudes. Para facilitar la lectura, esta muestra de código tiene saltos de línea:

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}

• customerId es un identificador único de la Cuenta de Google del cliente.
• Como administrador de la cuenta, también puedes usar la cadena my_customer, que representa el customerId de tu cuenta. Otra forma de obtener el valor de customerId es usar la operación Recuperar un usuario. Usa la dirección de correo electrónico de tu administrador o el valor de id de usuario único de tu administrador en el parámetro de ruta userKey de la operación.
• deviceId es un identificador único de un dispositivo y se encuentra en la respuesta de la operación Retrieve all Chrome devices.

Para conocer las cadenas de consulta, las solicitudes y las propiedades de respuesta, consulta la referencia de la API.

Nota: La API también admite la semántica de parche.

Solicitud JSON

En la siguiente solicitud JSON de ejemplo, se actualizan las propiedades annotatedUser, annotatedLocation, annotatedAssetId, notes y orgUnitPath de un dispositivo Chrome. Para facilitar la lectura, esta muestra de código tiene saltos de línea:

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId?projection=full

Ejemplo de 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"
}

En el caso de una solicitud de actualización, solo incluye las propiedades con valores actualizados.

Nota: La API solo puede actualizar las propiedades annotatedUser, annotatedLocation, annotatedAssetId, notes y orgUnitPath.

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

Cómo desaprovisionar o inhabilitar dispositivos Chrome

Advertencia:

• Si se desaprovisiona un dispositivo, la política de dispositivo se dejará de sincronizar, y se quitarán las impresoras a nivel del dispositivo. Una vez que se desaprovisiona un dispositivo, debes borrarlo antes de volver a inscribirlo.
• Se deben inhabilitar los dispositivos perdidos o robados.
• Si vuelves a habilitar un dispositivo inhabilitado, se consumirá una licencia del dispositivo. Se produce un error si no tienes suficientes licencias disponibles cuando vuelves a habilitar un dispositivo.

Para obtener más información sobre cómo inhabilitar y desvincular dispositivos, visita el Centro de ayuda.

Para anular la aprovisionación o inhabilitar dispositivos Chrome, usa la siguiente solicitud POST y, luego, incluye la autorización que se describe en Autorizar solicitudes. Para facilitar la lectura, esta muestra de código tiene saltos de línea:

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

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

Para conocer 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 desaprovisionar y inhabilitar dispositivos Chrome:

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

El cuerpo de la solicitud para una baja de aprovisionamiento 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 inhabilitar es el siguiente:

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

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

Cómo mover dispositivos Chrome a una unidad organizativa

Para mover hasta 50 dispositivos Chrome a una unidad organizativa, usa la siguiente solicitud POST y, luego, incluye la autorización que se describe en Autorizar solicitudes. Para facilitar la lectura, esta muestra de código tiene saltos de línea:

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

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

Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API.

Solicitud JSON

En la siguiente solicitud JSON, se muestra una solicitud de muestra 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 del dispositivo es el siguiente:

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

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