API Directory: dispositivos ChromeOS

Recuperar todos os dispositivos ChromeOS de uma conta

Para retornar uma lista de todos os dispositivos ChromeOS atribuídos a uma conta, use a seguinte solicitação GET e inclua a autorização descrita em Autorizar solicitações. Para facilitar a leitura, este exemplo de código tem retornos de linha: 

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

  • O customerId é um identificador exclusivo da Conta do Google do cliente.
  • Como administrador da conta, você também pode usar a string my_customer, que representa o customerId da sua conta. Outra maneira de consultar o valor de customerId é usar a operação Recuperar um usuário. Use seu endereço de e-mail de administrador ou o valor de id do usuário único de administrador no parâmetro de caminho userKey da operação.

Para as strings de consulta, as propriedades de solicitação e de resposta, consulte a Referência da API.

Exemplo: filtrar dispositivos por usuário

Neste exemplo, a pesquisa é feita por query=user:help desk. A resposta contém um único recurso chromeosdevice, em que o annotatedUser é help desk:

Solicitação 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

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

Exemplo: filtrar dispositivos por número de série

Este exemplo pesquisa um número de série específico usando query=id:123456, em que 123456 é o número de série do dispositivo. A resposta mostrada abaixo contém uma única resposta correspondente, em que a propriedade serialNumber corresponde ao valor da pesquisa.

Solicitação 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

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

Este exemplo de resposta inclui as propriedades model, meid e macAddress. Se um dispositivo não tiver essas propriedades, elas não serão incluídas na resposta. Para saber mais, consulte a Representação de recursos de dispositivos ChromeOS.

Exportar uma lista de MEIDs

O meid é o identificador de equipamento móvel (MEID) do cartão 3G em um dispositivo ChromeOS. Um MEID geralmente é usado ao adicionar um dispositivo ao plano de serviço pós-pago de uma operadora de celular. Para exportar a lista de MEIDs, use a solicitação GET abaixo e os valores nextPageToken para recuperar a lista completa de MEIDs. Para facilitar a leitura, este exemplo de código tem retornos de linha: 

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

Recuperar um dispositivo ChromeOS

Para recuperar as propriedades de um dispositivo ChromeOS, use a seguinte solicitação GET e inclua a autorização descrita em Autorizar solicitações. Para facilitar a leitura, este exemplo de código tem retornos de linha: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • O customerId é um identificador exclusivo da Conta do Google do cliente.
  • Como administrador da conta, você também pode usar a string my_customer, que representa o customerId da sua conta. Outra maneira de consultar o valor de customerId é usar a operação Recuperar um usuário. Use seu endereço de e-mail de administrador ou o valor de id do usuário único de administrador no parâmetro de caminho userKey da operação.
  • O deviceId é um identificador exclusivo de um dispositivo e pode ser encontrado na resposta da operação Recuperar todos os dispositivos ChromeOS.

Para as strings de consulta, as propriedades de solicitação e de resposta, consulte a Referência da API.

Solicitação JSON

Exemplo de solicitação. Para facilitar a leitura, este exemplo de código tem retornos de linha: 
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos/deviceId?projection=full

Resposta JSON

Uma solicitação bem-sucedida retorna um código de status HTTP 200. Além do código de status, a resposta retorna as propriedades do 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"
}

Atualizar um dispositivo ChromeOS

Para atualizar um dispositivo ChromeOS, use a solicitação PUT abaixo e inclua a autorização descrita em Autorizar solicitações. Para facilitar a leitura, este exemplo de código tem retornos de linha: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • O customerId é um identificador exclusivo da Conta do Google do cliente.
  • Como administrador da conta, você também pode usar a string my_customer, que representa o customerId da sua conta. Outra maneira de consultar o valor de customerId é usar a operação Recuperar um usuário. Use seu endereço de e-mail de administrador ou o valor de id do usuário único de administrador no parâmetro de caminho userKey da operação.
  • O deviceId é um identificador exclusivo de um dispositivo e pode ser encontrado na resposta da operação Recuperar todos os dispositivos ChromeOS.

Para as strings de consulta, as propriedades de solicitação e de resposta, consulte a Referência da API.

Solicitação JSON

O exemplo de solicitação JSON a seguir atualiza as propriedades annotatedUser, annotatedLocation, annotatedAssetId, notes e orgUnitPath de um dispositivo ChromeOS. Para facilitar a leitura, este exemplo de código tem retornos de linha: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId?projection=full
 Exemplo do corpo da solicitação: 
{
  "deviceId": "device_id_value",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "1234567890",
  "notes": "Loaned from support",
  "orgUnitPath": "/corp/sales"
}

Para uma solicitação de atualização, inclua apenas as propriedades com valores atualizados.

Uma solicitação bem-sucedida retorna um código de status HTTP 200. Além do código de status, a resposta retorna as propriedades do dispositivo ChromeOS atualizado.

Desprovisionar ou desativar dispositivos ChromeOS

Para remover o provisionamento ou desativar dispositivos ChromeOS, use a seguinte solicitação POST e inclua a autorização descrita em Autorizar solicitações. Para facilitar a leitura, este exemplo de código tem retornos de linha: 

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

  • O customerId é um identificador exclusivo da Conta do Google do cliente.
  • Como administrador da conta, você também pode usar a string my_customer, que representa o customerId da sua conta. Outra maneira de consultar o valor de customerId é usar a operação Recuperar um usuário. Use seu endereço de e-mail de administrador ou o valor de id do usuário único de administrador no parâmetro de caminho userKey da operação.

Para as propriedades de solicitação e resposta, consulte a referência da API.

Solicitação JSON

A solicitação JSON a seguir mostra um exemplo de solicitação para desativar e desaprovisionar dispositivos ChromeOS: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
 O corpo da solicitação de um exemplo de desprovisionamento é: 
{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
  "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION",
  "deprovisionReason": "DEPROVISION_REASON_RETIRING_DEVICE"
}
 O corpo da solicitação para desativação é: 
  {
    "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
    "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE",
  }

Uma solicitação bem-sucedida retorna um código de status HTTP 200.

Mover dispositivos ChromeOS para a unidade organizacional

Para mover até 50 dispositivos ChromeOS para uma unidade organizacional, use a seguinte solicitação POST e inclua a autorização descrita em Autorizar solicitações. Para facilitar a leitura, este exemplo de código tem retornos de linha: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/moveDevicesToOu?orgUnitPath=/SomeOuName
  • O customerId é um identificador exclusivo da Conta do Google do cliente.
  • Como administrador da conta, você também pode usar a string my_customer, que representa o customerId da sua conta. Outra maneira de consultar o valor de customerId é usar a operação Recuperar um usuário. Use seu endereço de e-mail de administrador ou o valor de id do usuário único de administrador no parâmetro de caminho userKey da operação.

Para as propriedades de solicitação e resposta, consulte a Referência da API.

Solicitação JSON

A solicitação JSON a seguir mostra um exemplo de solicitação para mover três dispositivos ChromeOS para uma unidade organizacional chamada /Marketing: 

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

O corpo da solicitação para a mudança do dispositivo é:

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

Uma solicitação bem-sucedida retorna um código de status HTTP 200.