Method: mobiledevices.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Récupère une liste paginée de tous les appareils mobiles appartenant à un utilisateur pour un compte. Pour récupérer une liste incluant les appareils appartenant à l'entreprise, utilisez plutôt l'API Devices de Cloud Identity. Cette méthode expire au bout de 60 minutes. Pour en savoir plus, consultez la section Résoudre les codes d'erreur.
Requête HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/mobile
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres |
customerId |
string
Identifiant unique du compte Google Workspace du client. En tant qu'administrateur de compte, vous pouvez également utiliser l'alias my_customer pour représenter le customerId de votre compte. customerId est également renvoyé dans la ressource "Users".
|
Paramètres de requête
Paramètres |
maxResults |
integer
Nombre maximal de résultats sur une page. La valeur maximale autorisée est de 100.
|
orderBy |
enum (OrderBy )
Propriété de l'appareil à utiliser pour trier les résultats.
|
pageToken |
string
Jeton permettant de spécifier la page suivante de la liste
|
projection |
enum (Projection )
Limitez les informations renvoyées à un ensemble de champs sélectionnés.
|
query |
string
Chaîne de recherche au format indiqué sur la page https://developers.google.com/workspace/admin/directory/v1/search-operators
|
sortOrder |
enum (SortOrder )
Indique si les résultats doivent être renvoyés par ordre croissant ou décroissant. Doit être utilisé avec le paramètre orderBy .
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient des données présentant la structure suivante :
Représentation JSON |
{
"kind": string,
"etag": string,
"mobiledevices": [
{
object (MobileDevice )
}
],
"nextPageToken": string
} |
Champs |
kind |
string
Type de ressource
|
etag |
string
ETag de la ressource.
|
mobiledevices[] |
object (MobileDevice )
Liste d'objets Mobile Device.
|
nextPageToken |
string
Jeton utilisé pour accéder à la page suivante de ce résultat.
|
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
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
Pour en savoir plus, consultez le guide d'autorisation.
OrderBy
Enums |
DEVICE_ID |
Numéro de série d'un appareil mobile Google Sync. Pour les appareils Android, il s'agit d'un identifiant unique généré par logiciel. |
EMAIL |
Adresse e-mail du propriétaire de l'appareil. |
LAST_SYNC |
Date et heure de la dernière synchronisation des paramètres de règles de l'appareil. |
MODEL |
Modèle de l'appareil mobile. |
NAME |
Nom d'utilisateur du propriétaire de l'appareil. |
OS |
Système d'exploitation de l'appareil. |
STATUS |
État de l'appareil. |
TYPE |
Type d'appareil. |
Projection
Enums |
BASIC |
N'inclut que les champs de métadonnées de base (par exemple, deviceId, model, status, type et status) |
FULL |
Inclut tous les champs de métadonnées |
SortOrder
Enums |
ASCENDING |
par ordre croissant. |
DESCENDING |
Ordre décroissant. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 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. |"]]