Esta página foi traduzida pela API Cloud Translation.

API Directory: dispositivos Chrome

Recuperar todos os dispositivos Chrome de uma conta
1. Exportar uma lista de MEIDs
Recuperar um dispositivo Chrome
Atualizar um dispositivo Chrome
Realizar ações em um dispositivo Chrome
Mover dispositivos Chrome para uma unidade organizacional

Recuperar todos os dispositivos Chrome de uma conta

Para retornar uma lista de todos os dispositivos Chrome atribuídos a uma conta, use o código a seguir: GET e incluem 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 acessar o customerId valor é usar o campo Recuperar um usuário operação Use seu endereço de e-mail de administrador ou o usuário exclusivo do administrador id no parâmetro de caminho userKey da operação.

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

Exemplo: filtrar dispositivos por usuário

Este exemplo pesquisa um usuário específico usando 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 pelo número de série

Este exemplo procura um número de série específico usando query=id:123456, em que 123456 é o o número de série do dispositivo. A resposta mostrada abaixo contém uma única resposta correspondente, em que o serialNumber corresponde ao valor de 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"
}

Esse exemplo de resposta inclui model, meid e macAddress. Se um dispositivo não tiver essas propriedades, elas não serão incluído na resposta. Para mais detalhes, consulte a Representação do recurso ChromeOS.

Exportar uma lista MEID

O meid é o identificador de equipamento móvel (MEID, na sigla em inglês) do cartão móvel 3G em uma dispositivo Chrome. Um MEID é normalmente usado ao adicionar um dispositivo ao serviço de plano de serviço pós-pago. Para exportar a lista MEID, use a seguinte solicitação GET e os valores nextPageToken para recuperar a lista completa de MEIDs. Para facilitar a leitura, o 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 Chrome

Para recuperar as propriedades de um dispositivo Chrome, use a seguinte solicitação GET e incluir 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 acessar o customerId valor é usar o campo Recuperar um usuário operação Use seu endereço de e-mail de administrador ou o usuário exclusivo do administrador id no parâmetro de caminho userKey da operação.
O deviceId é um identificador exclusivo para um dispositivo, encontrado na resposta de a operação Recuperar todos os dispositivos Chrome.

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

Solicitação JSON

Um 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. Junto com o código de status, a resposta retornará as propriedades do 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"
}

Atualizar um dispositivo Chrome

Para atualizar um dispositivo Chrome, use a seguinte solicitação PUT e inclua o 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 acessar o customerId valor é usar o campo Recuperar um usuário operação Use seu endereço de e-mail de administrador ou o usuário exclusivo do administrador id no parâmetro de caminho userKey da operação.
O deviceId é um identificador exclusivo para um dispositivo, encontrado na resposta de a operação Recuperar todos os dispositivos Chrome.

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

Solicitação JSON

O exemplo de solicitação JSON a seguir atualiza o annotatedUser de um dispositivo Chrome. annotatedLocation, annotatedAssetId, notes e orgUnitPath. 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.

Observação:a API só pode atualizar annotatedUser, annotatedLocation, annotatedAssetId, notes e orgUnitPath.

Uma solicitação bem-sucedida retorna um Código de status HTTP 200. Junto com o código de status, a resposta retornará as propriedades do dispositivo Chrome atualizado.

Como desprovisionar ou desativar dispositivos Chrome

Para desprovisionar ou desativar dispositivos Chrome, use a seguinte solicitação POST e incluir 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 acessar o customerId valor é usar o campo Recuperar um usuário operação Use seu endereço de e-mail de administrador ou o usuário exclusivo do administrador id no parâmetro de caminho userKey da operação.

Para obter 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 desprovisionar e desativar Dispositivos Chrome:

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 Chrome para a unidade organizacional

Se você quiser mover até 50 dispositivos Chrome para uma unidade organizacional, use o seguinte: POST e incluem 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 acessar o customerId é usar o campo Recuperar um user. Use seu endereço de e-mail de administrador ou o usuário único do administrador Valor id no parâmetro de caminho userKey da operação.

Para obter 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 Chrome 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 movimentação do dispositivo é:

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

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