Method: mobiledevices.list
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
アカウントのユーザー所有のすべてのモバイル デバイスのパージネーション リストを取得します。会社所有のデバイスを含むリストを取得するには、代わりに Cloud Identity の Devices API を使用します。このメソッドは 60 分後にタイムアウトします。詳細については、エラーコードのトラブルシューティングをご覧ください。
HTTP リクエスト
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/mobile
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
customerId |
string
お客様の Google Workspace アカウントの一意の ID。アカウント管理者は、アカウントの customerId を表す my_customer エイリアスを使用することもできます。customerId は、ユーザー リソースの一部としても返されます。
|
クエリ パラメータ
パラメータ |
maxResults |
integer
返される結果の最大数。最大値は 100 です。
|
orderBy |
enum (OrderBy )
結果の並べ替えに使用するデバイスのプロパティです。
|
pageToken |
string
リストの次のページを指定するトークン
|
projection |
enum (Projection )
選択した一連のフィールドに返される情報を制限します。
|
query |
string
https://developers.google.com/workspace/admin/directory/v1/search-operators に記載されている形式の検索文字列
|
sortOrder |
enum (SortOrder )
結果を昇順または降順のどちらで返すかを指定します。orderBy パラメータと一緒に使用する必要があります。
|
リクエストの本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
{
"kind": string,
"etag": string,
"mobiledevices": [
{
object (MobileDevice )
}
],
"nextPageToken": string
} |
フィールド |
kind |
string
リソースの種類。
|
etag |
string
リソースの ETag。
|
mobiledevices[] |
object (MobileDevice )
モバイル デバイス オブジェクトのリスト。
|
nextPageToken |
string
この結果の次のページにアクセスするために使用されるトークン。
|
認可スコープ
以下のいずれかの OAuth スコープが必要です。
https://www.googleapis.com/auth/admin.directory.device.mobile
https://www.googleapis.com/auth/admin.directory.device.mobile.action
https://www.googleapis.com/auth/admin.directory.device.mobile.readonly
詳しくは、認可ガイドをご覧ください。
OrderBy
列挙型 |
DEVICE_ID |
Google Sync モバイル デバイスのシリアル番号。Android デバイスの場合、これはソフトウェアによって生成された一意の識別子です。 |
EMAIL |
デバイスのオーナーのメールアドレス。 |
LAST_SYNC |
デバイスのポリシー設定の最終同期日時。 |
MODEL |
モバイル デバイスのモデル。 |
NAME |
デバイスの所有者のユーザー名。 |
OS |
デバイスのオペレーティング システム。 |
STATUS |
デバイスのステータス。 |
TYPE |
端末のタイプ。 |
予測
列挙型 |
BASIC |
基本的なメタデータ フィールドのみが含まれます(deviceId、model、status、type、status など)。 |
FULL |
すべてのメタデータ フィールドが含まれます |
SortOrder
列挙型 |
ASCENDING |
昇順。 |
DESCENDING |
降順。 |
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[],[],null,["# Method: mobiledevices.list\n\nRetrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/mobile`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customerId` | `string` The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). |\n\n### Query parameters\n\n| Parameters ||\n|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `maxResults` | `integer` Maximum number of results to return. Max allowed value is 100. |\n| `orderBy` | `enum (`[OrderBy](/workspace/admin/directory/reference/rest/v1/mobiledevices/list#OrderBy)`)` Device property to use for sorting results. |\n| `pageToken` | `string` Token to specify next page in the list |\n| `projection` | `enum (`[Projection](/workspace/admin/directory/reference/rest/v1/mobiledevices/list#Projection)`)` Restrict information returned to a set of selected fields. |\n| `query` | `string` Search string in the format given at \u003chttps://developers.google.com/workspace/admin/directory/v1/search-operators\u003e |\n| `sortOrder` | `enum (`[SortOrder](/workspace/admin/directory/reference/rest/v1/mobiledevices/list#SortOrder)`)` Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"mobiledevices\": [ { object (/workspace/admin/directory/reference/rest/v1/mobiledevices#MobileDevice) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Kind of resource this is. |\n| `etag` | `string` ETag of the resource. |\n| `mobiledevices[]` | `object (`[MobileDevice](/workspace/admin/directory/reference/rest/v1/mobiledevices#MobileDevice)`)` A list of Mobile Device objects. |\n| `nextPageToken` | `string` Token used to access next page of this result. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.directory.device.mobile`\n- `\n https://www.googleapis.com/auth/admin.directory.device.mobile.action`\n- `\n https://www.googleapis.com/auth/admin.directory.device.mobile.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nOrderBy\n-------\n\n| Enums ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------|\n| `DEVICE_ID` | The serial number for a Google Sync mobile device. For Android devices, this is a software generated unique identifier. |\n| `EMAIL` | The device owner's email address. |\n| `LAST_SYNC` | Last policy settings sync date time of the device. |\n| `MODEL` | The mobile device's model. |\n| `NAME` | The device owner's user name. |\n| `OS` | The device's operating system. |\n| `STATUS` | The device status. |\n| `TYPE` | Type of the device. |\n\nProjection\n----------\n\n| Enums ||\n|---------|-------------------------------------------------------------------------------------------|\n| `BASIC` | Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status) |\n| `FULL` | Includes all metadata fields |\n\nSortOrder\n---------\n\n| Enums ||\n|--------------|-------------------|\n| `ASCENDING` | Ascending order. |\n| `DESCENDING` | Descending order. |"]]