アカウントのすべての Chrome デバイスを取得する
アカウントに割り当てられているすべての Chrome デバイスのリストを取得するには、次の GET
リクエストを使用し、その際にはリクエストを承認するで説明されている承認を含めます。このコードサンプルでは、読みやすくするために改行を入れています。
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
は、顧客の Google アカウントの一意の識別子です。- アカウント管理者は、アカウントの
customerId
を表す文字列my_customer
を使用することもできます。customerId
値は、ユーザーを取得するの操作を使用して取得することもできます。操作のuserKey
パスパラメータでは、管理者のメールアドレスまたは管理者の一意のユーザーid
値を使用します。
クエリ文字列、リクエスト、レスポンスのプロパティについては、API リファレンスをご覧ください。
例: ユーザーでデバイスをフィルタする
この例では、query=user:help desk
を使用して特定のユーザーを検索します。レスポンスには、annotatedUser
が help desk
である chromeosdevice
リソースが 1 つだけ含まれています。
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
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" }
例: シリアル番号でデバイスをフィルタする
この例では、query=id:123456
を使用して特定のシリアル番号を検索します(123456
はデバイスのシリアル番号です)。下記のレスポンスには、一致するもの(serialNumber
プロパティが検索値と一致するもの)が 1 つ含まれています。
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
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" }
このレスポンスの例には、model
、meid
、macAddress
の各プロパティが含まれています。これらのプロパティを持たないデバイスは、レスポンスに含まれません。詳しくは、chromeosdevice のリソース表現をご覧ください。
MEID リストを書き出す
meid
は、Chrome デバイスの 3G モバイルカードのモバイル機器識別子(MEID)です。MEID は通常、デバイスを携帯通信会社の後払いサービスプランに追加するときに使用されます。MEID リストを書き出すには、次の GET
リクエストと nextPageToken
値を使用して MEID の全リストを取得します。このコードサンプルでは、読みやすくするために改行を入れています。
GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/ devices/chromeos?fields=nextPageToken,chromeosdevices(meid)
Chrome デバイスを取得する
Chrome デバイスのプロパティを取得するには、次の GET
リクエストを使用し、その際にはリクエストを承認するで説明されている承認を含めます。このコードサンプルでは、読みやすくするために改行を入れています。
GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/ devices/chromeos/deviceId?projection={FULL|BASIC}
customerId
は、顧客の Google アカウントの一意の識別子です。- アカウント管理者は、アカウントの
customerId
を表す文字列my_customer
を使用することもできます。customerId
値は、ユーザーを取得するの操作を使用して取得することもできます。操作のuserKey
パスパラメータでは、管理者のメールアドレスまたは管理者の一意のユーザーid
値を使用します。 deviceId
はデバイスの一意の識別子であり、すべての Chrome デバイスを取得するの操作のレスポンスにあります。
クエリ文字列、リクエスト、レスポンスのプロパティについては、API リファレンスをご覧ください。
JSON リクエスト
リクエストの例。このコードサンプルでは、読みやすくするために改行を入れています。GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/ chromeos/deviceId?projection=full
JSON レスポンス
リクエストが成功すると、レスポンスとして HTTP 200 のステータス コードが返されます。レスポンスでは、ステータス コードとともに 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" }
Chrome デバイスを更新する
Chrome デバイスを更新するには、次の PUT
リクエストを使用し、その際にはリクエストを承認するで説明されている承認を含めます。このコードサンプルでは、読みやすくするために改行を入れています。
PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/ devices/chromeos/deviceId?projection={FULL|BASIC}
customerId
は、顧客の Google アカウントの一意の識別子です。- アカウント管理者は、アカウントの
customerId
を表す文字列my_customer
を使用することもできます。customerId
値は、ユーザーを取得するの操作を使用して取得することもできます。操作のuserKey
パスパラメータでは、管理者のメールアドレスまたは管理者の一意のユーザーid
値を使用します。 deviceId
はデバイスの一意の識別子であり、すべての Chrome デバイスを取得するの操作のレスポンスにあります。
クエリ文字列、リクエスト、レスポンスのプロパティについては、API リファレンスをご覧ください。
JSON リクエスト
次の JSON リクエストの例では、Chrome デバイスの annotatedUser
、annotatedLocation
、annotatedAssetId
、notes
、orgUnitPath
の各プロパティを更新します。このコードサンプルでは、読みやすくするために改行を入れています。
PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/ devices/chromeos/deviceId?projection=fullリクエスト本文の例:
{
"deviceId": "device_id_value",
"annotatedUser": "help desk",
"annotatedLocation": "Mountain View help desk Chromebook",
"annotatedAssetId": "1234567890",
"notes": "Loaned from support",
"orgUnitPath": "/corp/sales"
}
更新リクエストの場���は、値��更新��れ������ロパティ��みを含めます。
リクエストが成功すると、レスポンスとして HTTP 200 のステータス コードが返されます。レスポンスでは、ステータス コードとともに、更新された Chrome デバイスのプロパティが返されます。
Chrome デバイスをデプロビジョニングまたは無効化する
Chrome デバイスのデプロビジョニングまたは無効化を行うには、次の POST
リクエストを使用し、その際にはリクエストを承認するで説明されている承認を含めます。このコードサンプルでは、読みやすくするために改行を入れています。
POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer or customerId/ devices/chromeos/deviceId/action
customerId
は、顧客の Google アカウントの一意の識別子です。- アカウント管理者は、アカウントの
customerId
を表す文字列my_customer
を使用することもできます。customerId
値は、ユーザーを取得するの操作を使用して取得することもできます。操作のuserKey
パスパラメータでは、管理者のメールアドレスまたは管理者の一意のユーザーid
値を使用します。 deviceId
はデバイスの一意の識別子であり、すべての Chrome デバイスを取得するの操作のレスポンスにあります。
リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。
JSON リクエスト
次の JSON リクエストは、Chrome デバイスのデプロビジョニングまたは無効化を行うためのサンプル リクエストです。
POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/ devices/chromeos/deviceId/actionサンプルのデプロビジョニングのリクエスト本文は次のとおりです。
{ "action": "deprovision", "deprovisionReason": "retiring device" }無効化のリクエスト本文は次のとおりです。
{ "action": "disable" }
リクエストが成功すると、レスポンスとして HTTP 200 のステータス コードが返されます。
Chrome デバイスを組織部門に移動する
50 台以下の Chrome デバイスを組織部門に移動するには、次の POST
リクエストを使用し、その際にはリクエストを承認するで説明されている承認を含めます。このコードサンプルでは、読みやすくするために改行を入れています。
POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/ devices/chromeos/moveDevicesToOu?orgUnitPath=/SomeOuName
customerId
は、顧客の Google アカウントの一意の識別子です。- アカウント管理者は、アカウントの
customerId
を表す文字列my_customer
を使用することもできます。customerId
値は、ユーザーを取得するの操作を使用して取得することもできます。操作のuserKey
パスパラメータでは、管理者のメールアドレスまたは管理者の一意のユーザーid
値を使用します。
リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。
JSON リクエスト
次の JSON リクエストは、/Marketing
という名前の組織部門に 3 台の Chrome デバイスを移動するサンプル リクエストです。
POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/ devices/chromeos/chromeos/moveDevicesToOu?orgUnitPath=/Marketing
デバイスの移動に関するリクエスト本文は次のとおりです。
{ "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"] }
リクエストが成功すると、レスポンスとして HTTP 200 のステータス コードが返されます。