Interfejs Directory API: urządzenia z Chrome

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Pobieranie wszystkich urządzeń z Chrome dla konta

Aby zwrócić listę wszystkich urządzeń z Chrome przypisanych do konta, użyj tego żądania GET i dołącz autoryzację opisaną w artykule Autoryzowanie żądań. Dla przykładu ten przykładowy kod zawiera zwroty wierszy:

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 to unikalny identyfikator konta Google klienta.
  • Jako administrator konta możesz też użyć ciągu znaków my_customer reprezentującego Twoje konto (customerId). Innym sposobem na uzyskanie wartości customerId jest użycie operacji Pobierz użytkownika. Użyj adresu e-mail administratora lub niepowtarzalnej wartości administratora id w parametrze ścieżki operacji userKey.

Ciągi zapytania, właściwości żądań i odpowiedzi znajdziesz w dokumentacji API.

Przykład: filtrowanie urządzeń według użytkowników

W tym przykładzie wyszukano konkretnego użytkownika za pomocą operatora query=user:help desk. Odpowiedź zawiera jeden zasób chromeosdevice, gdzie annotatedUser to help desk:

Żądanie 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

Odpowiedź 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"
}

Przykład: filtrowanie urządzeń według numeru seryjnego

W tym przykładzie wyszukano numer seryjny urządzenia przy użyciu atrybutu query=id:123456, gdzie 123456 to numer seryjny urządzenia. Poniższa odpowiedź zawiera pojedynczą odpowiedź, w której właściwość serialNumber odpowiada wartości wyszukiwania.

Żądanie 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

Odpowiedź 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"
}

Ten przykład odpowiedzi zawiera właściwości model, meid i macAddress. Jeśli urządzenie nie ma tych właściwości, nie są one uwzględnione w odpowiedzi. Więcej informacji znajdziesz w opisie zasobu ChromeOS na urządzeniu.

Eksportowanie listy MEID

meid to identyfikator urządzenia mobilnego (MEID) karty 3G w urządzeniu z Chrome. Identyfikator MEID jest zwykle używany podczas dodawania urządzenia do abonamentu. Aby wyeksportować listę identyfikatorów MEID, użyj tej żądania GET i wartości nextPageToken, aby pobrać pełną listę identyfikatorów MEID. Dla przykładu ten przykładowy kod zawiera zwroty wierszy:

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

Pobieranie urządzenia z Chrome

Aby pobrać właściwości urządzenia z Chrome, użyj tego żądania GET i dołącz autoryzację opisaną w artykule Autoryzowanie żądań. Dla przykładu ten przykładowy kod zawiera zwroty wierszy:

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId to unikalny identyfikator konta Google klienta.
  • Jako administrator konta możesz też użyć ciągu znaków my_customer reprezentującego Twoje konto (customerId). Innym sposobem na uzyskanie wartości customerId jest użycie operacji Pobierz użytkownika. Użyj adresu e-mail administratora lub niepowtarzalnej wartości administratora id w parametrze ścieżki operacji userKey.
  • deviceId to unikalny identyfikator urządzenia, który znajduje się w odpowiedzi operacji Pobierz wszystkie urządzenia z Chrome.

Ciągi zapytania, właściwości żądań i odpowiedzi znajdziesz w dokumentacji API.

Żądanie JSON

Przykładowe żądanie. Dla przykładu ten przykładowy kod zawiera zwroty wierszy:
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos/deviceId?projection=full

Odpowiedź JSON

Pomyślne żądanie zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź zawiera też właściwości urządzenia z 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"
}

Aktualizowanie urządzenia z Chrome

Aby zaktualizować urządzenie z Chrome, użyj tego żądania PUT i uwzględnij autoryzację opisane w artykule Autoryzowanie żądań. Dla przykładu ten przykładowy kod zawiera zwroty wierszy:

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId to unikalny identyfikator konta Google klienta.
  • Jako administrator konta możesz też użyć ciągu znaków my_customer reprezentującego Twoje konto (customerId). Innym sposobem na uzyskanie wartości customerId jest użycie operacji Pobierz użytkownika. Użyj adresu e-mail administratora lub niepowtarzalnej wartości administratora id w parametrze ścieżki operacji userKey.
  • deviceId to unikalny identyfikator urządzenia, który znajduje się w odpowiedzi operacji Pobierz wszystkie urządzenia z Chrome.

Ciągi zapytania, właściwości żądań i odpowiedzi znajdziesz w dokumentacji API.

Żądanie JSON

Przykładowy żądanie JSON aktualizuje właściwości urządzenia annotatedUser, annotatedLocation, annotatedAssetId, notes i orgUnitPath na urządzeniu z Chrome. Dla przykładu ten przykładowy kod zawiera zwroty wierszy:

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId?projection=full
Przykład treści żądania:
{
  "deviceId": "device_id_value",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "1234567890",
  "notes": "Loaned from support",
  "orgUnitPath": "/corp/sales"
}

W żądaniu aktualizacji uwzględnij tylko te właściwości ze zaktualizowanymi wartościami.

Pomyślne żądanie zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź zawiera też właściwości zaktualizowanego urządzenia z Chrome.

Wyrejestrowywanie i wyłączanie urządzenia z Chrome

Aby wyrejestrować lub wyłączyć urządzenie z Chrome, użyj tego żądania POST i dołącz autoryzację opisaną w artykule Autoryzowanie żądań. Dla przykładu ten przykładowy kod zawiera zwroty wierszy:

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

  • customerId to unikalny identyfikator konta Google klienta.
  • Jako administrator konta możesz też użyć ciągu znaków my_customer reprezentującego Twoje konto (customerId). Innym sposobem na uzyskanie wartości customerId jest użycie operacji Pobierz użytkownika. Użyj adresu e-mail administratora lub niepowtarzalnej wartości administratora id w parametrze ścieżki operacji userKey.
  • deviceId to unikalny identyfikator urządzenia, który znajduje się w odpowiedzi operacji Pobierz wszystkie urządzenia z Chrome.

Właściwości żądania i odpowiedzi znajdziesz w dokumentacji API.

Żądanie JSON

Poniższe żądanie JSON przedstawia przykładowe żądanie wyrejestrowania i wyłączenia urządzenia z Chrome:

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId/action
Treść żądania dotyczące wyrejestrowania to:
{
  "action": "deprovision",
  "deprovisionReason": "retiring_device"
}
Treść żądania do wyłączenia to:
{
  "action": "disable"
}

Pomyślne żądanie zwraca kod stanu HTTP 200.

Przenoszenie urządzeń z Chrome do jednostki organizacyjnej

Aby przenieść do jednostki organizacyjnej maksymalnie 50 urządzeń z Chrome, użyj poniższego żądania POST i dodaj autoryzację opisaną w artykule Autoryzowanie żądań. Dla przykładu ten przykładowy kod zawiera zwroty wierszy:

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/moveDevicesToOu?orgUnitPath=/SomeOuName
  • customerId to unikalny identyfikator konta Google klienta.
  • Jako administrator konta możesz też użyć ciągu znaków my_customer reprezentującego Twoje konto (customerId). Innym sposobem na uzyskanie wartości customerId jest użycie operacji Pobierz użytkownika. Użyj adresu e-mail administratora lub niepowtarzalnej wartości administratora id w parametrze ścieżki operacji userKey.

Właściwości żądania i odpowiedzi znajdziesz w dokumentacji API.

Żądanie JSON

Poniższe żądanie JSON przedstawia przykładowe żądanie przeniesienia 3 urządzeń z Chrome do jednostki organizacyjnej o nazwie /Marketing:

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

Treść żądania przeniesienia urządzeń to:

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

Pomyślne żądanie zwraca kod stanu HTTP 200.