Directory API: urządzenia z ChromeOS

Pobieranie informacji o wszystkich urządzeniach z ChromeOS na koncie

Aby zwrócić listę wszystkich urządzeń z ChromeOS przypisanych do konta, użyj podanego poniżej żądania GET i dodaj autoryzację opisaną w sekcji Autoryzowanie żądań. Przykładowy kod zawiera znaki łamania wierszy, by można go było łatwiej czytać: 

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

  • Wartość customerId to unikalny identyfikator konta Google klienta.
  • Jako administrator konta możesz też użyć ciągu znaków my_customer, który reprezentuje identyfikator customerId Twojego konta. Innym sposobem na uzyskanie wartości customerIdjest użycie operacji Pobierz użytkownika. Użyj adresu e-mail administratora lub unikalnego identyfikatora użytkownika administratora id w parametrze ścieżki userKey operacji.

Informacje o ciągu zapytania oraz właściwościach żądań i odpowiedzi znajdziesz w dokumentacji API.

Przykład: filtrowanie urządzeń według użytkownika

W tym przykładzie wyszukiwany jest konkretny użytkownik za pomocą query=user:help desk. Odpowiedź zawiera jeden zasób chromeosdevice, w którym annotatedUser ma wartość 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 wyszukiwany jest konkretny numer seryjny za pomocą parametru query=id:123456, gdzie 123456 to numer seryjny urządzenia. Odpowiedź pokazana poniżej zawiera jedną pasującą odpowiedź, w której właściwość serialNumber pasuje do 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"
}

W tym przykładzie odpowiedzi uwzględniono właściwości model, meid i macAddress. Jeśli urządzenie nie ma tych właściwości, nie są one uwzględniane w odpowiedzi. Pełne informacje znajdziesz w artykule Reprezentacja zasobu Chromeosdevices.

Eksportowanie listy MEID

meid to identyfikator MEID (Mobile Equipment Identifier) karty 3G w urządzeniu z ChromeOS. MEID jest zwykle używany podczas dodawania urządzenia do planu usług operatora sieci bezprzewodowej pobierania opłat z późnym terminem płatności. Aby wyeksportować listę MEID, użyj tego żądania GET i wartości nextPageToken, aby pobrać pełną listę MEID. Przykładowy kod zawiera znaki łamania wierszy, by można go było łatwiej czytać: 

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

Pobieranie informacji o urządzeniu z ChromeOS

Aby pobrać właściwości urządzenia z ChromeOS, użyj tego żądania GET i dołącz autoryzację opisaną w sekcji Autoryzowanie żądań. Przykładowy kod zawiera znaki łamania wierszy, by można go było łatwiej czytać: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • Wartość customerId to unikalny identyfikator konta Google klienta.
  • Jako administrator konta możesz też użyć ciągu my_customer, który reprezentuje identyfikator customerId Twojego konta. Innym sposobem na uzyskanie wartości customerIdjest użycie operacji Pobierz użytkownika. Użyj adresu e-mail administratora lub unikalnego identyfikatora użytkownika id w parametrze ścieżki userKey operacji.
  • Parametr deviceId to unikalny identyfikator urządzenia, który można znaleźć w odpowiedzi operacji Pobierz wszystkie urządzenia z ChromeOS.

Informacje o ciągu zapytania oraz właściwościach żądań i odpowiedzi znajdziesz w dokumentacji API.

Żądanie JSON

Przykładowe żądanie. Przykładowy kod zawiera znaki łamania wierszy, by można go było łatwiej czytać: 
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 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"
}

Aktualizowanie urządzenia z ChromeOS

Aby zaktualizować urządzenie z ChromeOS, użyj tego żądania PUT i dołącz autoryzację opisaną w artykule Autoryzowanie żądań. Przykładowy kod zawiera znaki łamania wierszy, by można go było łatwiej czytać: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • Wartość customerId to unikalny identyfikator konta Google klienta.
  • Jako administrator konta możesz też użyć ciągu znaków my_customer, który reprezentuje identyfikator customerId Twojego konta. Innym sposobem na uzyskanie wartości customerId jest użycie operacji Pobierz użytkownika. Użyj adresu e-mail administratora lub unikalnego identyfikatora użytkownika id w parametrze ścieżki userKey operacji.
  • Parametr deviceId to unikalny identyfikator urządzenia, który można znaleźć w odpowiedzi operacji Pobierz wszystkie urządzenia z ChromeOS.

Informacje o ciągu zapytania oraz właściwościach żądań i odpowiedzi znajdziesz w dokumentacji API.

Żądanie JSON

Ten przykładowy plik JSON z żądaniem aktualizuje właściwości annotatedUser, annotatedLocation, annotatedAssetId, notes i orgUnitPath urządzenia z ChromeOS. Przykładowy kod zawiera znaki łamania wierszy, by można go było łatwiej czytać: 

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 przypadku żądania zmiany uwzględnij w nim tylko właściwości z nowymi 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 ChromeOS.

Wyrejestrowywanie i wyłączanie urządzeń z ChromeOS

Aby wycofać przyznanie uprawnień lub wyłączyć urządzenia z ChromeOS, użyj tego żądania POST i dodaj autoryzację opisaną w sekcji Autoryzowanie żądań. Przykładowy kod zawiera znaki łamania wierszy, by można go było łatwiej czytać: 

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

  • Wartość customerId to unikalny identyfikator konta Google klienta.
  • Jako administrator konta możesz też użyć ciągu znaków my_customer, który reprezentuje identyfikator customerId Twojego konta. Innym sposobem na uzyskanie wartości customerIdjest użycie operacji Pobierz użytkownika. Użyj adresu e-mail administratora lub unikalnego identyfikatora użytkownika administratora id w parametrze ścieżki userKey operacji.

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

Żądanie JSON

Poniższe żądanie w formacie JSON zawiera przykładowe żądanie wyrejestrowywania i wyłączania urządzeń z ChromeOS: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
Treść żądania w przypadku wyłączenia próbki: 
{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
  "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION",
  "deprovisionReason": "DEPROVISION_REASON_RETIRING_DEVICE"
}
Treść żądania wyłączenia: 
  {
    "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
    "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE",
  }

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

Przenoszenie urządzeń z ChromeOS do jednostki organizacyjnej

Aby przenieść do 50 urządzeń z ChromeOS do jednostki organizacyjnej, użyj podanego poniżej POSTżądania i dołącz autoryzację opisaną w sekcji Autoryzowanie żądań. Przykładowy kod zawiera znaki łamania wierszy, by można go było łatwiej czytać: 

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

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

Żądanie JSON

Poniższe żądanie JSON zawiera przykładowe żądanie przeniesienia 3 urządzeń z ChromeOS 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ądzenia:

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

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