API de Directory: Dispositivos Chrome

Recuperar todos los dispositivos Chrome de una cuenta

Para obtener una lista de todos los dispositivos Chrome asignados a una cuenta, utiliza lo siguiente: GET e incluye la autorización que se describe en Autoriza solicitudes. Para mayor legibilidad, esta muestra de código tiene los siguientes resultados: 

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 la cuenta, también puedes usar la cadena my_customer, que representa el customerId de tu cuenta. Otra forma de obtener el customerId valor es usar la capa Retrieve a user una sola operación. Usa tu dirección de correo electrónico de administrador o tu usuario único de administrador id en el parámetro de la ruta de acceso userKey de la operación.

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

Ejemplo: Filtrar dispositivos por usuario

En este ejemplo, se busca un usuario específico mediante query=user:help desk. El contiene un solo recurso chromeosdevice, en el que el 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: 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 la 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 model, meid y macAddress. Si un dispositivo no tiene estas propiedades, no se incluido en la respuesta. Para obtener más información, consulta la Representación de recursos de dispositivos ChromeOS.

Cómo exportar una lista de MEID

El meid es el identificador de equipo móvil (MEID) para la tarjeta móvil 3G de un dispositivo Chrome. Por lo general, se usa un MEID cuando se agrega un dispositivo al proveedor de servicios inalámbricos con el plan de servicio de pago posterior. Para exportar la lista de MEID, usa la siguiente solicitud GET y Los valores de nextPageToken para recuperar la lista completa de MEID Para mayor legibilidad, este la muestra de código tiene un resultado 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 y incluir la autorización descrita en Autoriza solicitudes. Para mayor legibilidad, esta muestra de código tiene los siguientes resultados: 

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 la cuenta, también puedes usar la cadena my_customer, que representa el customerId de tu cuenta. Otra forma de obtener el customerId valor es usar la capa Retrieve a user una sola operación. Usa tu dirección de correo electrónico de administrador o tu usuario único de administrador id en el parámetro de la ruta de acceso userKey de la operación.
  • El deviceId es un identificador único para un dispositivo y se encuentra en la respuesta de La operación Recuperar todos los dispositivos Chrome

Para conocer las propiedades de cadena de consulta, solicitud y 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: 
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 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"
}

Actualiza un dispositivo Chrome

Para actualizar un dispositivo Chrome, usa la siguiente solicitud PUT e incluye el autorización descrita en Autoriza solicitudes. Para mayor legibilidad, esta muestra de código tiene los siguientes resultados: 

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 la cuenta, también puedes usar la cadena my_customer, que representa el customerId de tu cuenta. Otra forma de obtener el customerId valor es usar la capa Retrieve a user una sola operación. Usa tu dirección de correo electrónico de administrador o tu usuario único de administrador id en el parámetro de la ruta de acceso userKey de la operación.
  • El deviceId es un identificador único para un dispositivo y se encuentra en la respuesta de La operación Recuperar todos los dispositivos Chrome

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

Solicitud JSON

En el siguiente ejemplo de solicitud JSON, se actualiza el annotatedUser de un dispositivo Chrome: annotatedLocation, annotatedAssetId, notes y Propiedades orgUnitPath. Para facilitar la lectura, esta muestra de código tiene los siguientes resultados: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId?projection=full
 El ejemplo del cuerpo de la solicitud es el siguiente: 
{
  "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, incluye solo las propiedades con valores actualizados.

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.

Desaprovisionar o inhabilitar dispositivos Chrome

Para desaprovisionar o inhabilitar dispositivos Chrome, usa la siguiente solicitud POST e incluya la autorización descrita en Autoriza solicitudes. Para mayor legibilidad, esta muestra de código tiene los siguientes resultados: 

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 la cuenta, también puedes usar la cadena my_customer, que representa el customerId de tu cuenta. Otra forma de obtener el customerId valor es usar la capa Retrieve a user una sola operación. Usa tu dirección de correo electrónico de administrador o tu usuario único de administrador id en el parámetro de la ruta de acceso userKey de la operación.

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

Solicitud JSON

La siguiente solicitud JSON muestra un ejemplo de solicitud para inhabilitar y desaprovisionar Dispositivos Chrome: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
 El cuerpo de la solicitud para un 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 devuelve un Código de estado HTTP 200.

Mover dispositivos Chrome a la unidad organizativa

Para mover hasta 50 dispositivos Chrome a una unidad organizativa, utiliza lo siguiente: POST e incluye la autorización que se describe en Autoriza solicitudes. Para mayor legibilidad, esta muestra de código tiene los siguientes resultados: 

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

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

Solicitud JSON

La siguiente solicitud JSON muestra una solicitud de ejemplo para mover 3 dispositivos Chrome a un Unidad organizativa denominada /Marketing: 

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

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

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

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