Renvoyer les informations sur l'utilisateur

Google Drive propose deux options pour recueillir des informations sur les utilisateurs Drive :

  • La ressource about vous permet de récupérer des informations sur l'utilisateur, ses paramètres Drive et les capacités de son système.

  • La ressource apps vous permet de récupérer la liste des applications installées par l'utilisateur, avec des informations sur les types MIME, les extensions de fichier et d'autres détails compatibles avec chaque application.

Ce guide explique comment récupérer les informations utilisateur dans Drive.

Obtenir des informations sur un utilisateur

Pour renvoyer des informations sur un utilisateur Drive en tant qu'instance de about, utilisez la méthode get. Les valeurs renvoyées sont mesurées en octets.

Vous devez définir le paramètre système fields sur la méthode get pour spécifier les champs à renvoyer dans la réponse. Dans la plupart des méthodes Drive, cette action n'est requise que pour renvoyer des champs non définis par défaut, mais elle est obligatoire pour la ressource about. Si vous omettez le paramètre, la méthode renvoie une erreur. Pour en savoir plus, consultez Renvoyer des champs spécifiques.

L'exemple de code suivant montre comment fournir plusieurs fields en tant que paramètre de requête dans la requête. La réponse renvoie les valeurs des champs pour la requête.

Requête

GET https://www.googleapis.com/drive/v3/about/?fields=kind,user,storageQuota

Réponse

{
  "kind": "drive#about",
  "user": {
    "kind": "drive#user",
    "displayName": "DISPLAY_NAME",
    "photoLink": "PHOTO_LINK";,
    "me": true,
    "permissionId": "PERMISSION_ID",
    "emailAddress": "EMAIL_ADDRESS"
  },
  "storageQuota": {
    "usage": "10845031958",
    "usageInDrive": "2222008387",
    "usageInDriveTrash": "91566"
  }
}

La réponse inclut les valeurs suivantes :

  • DISPLAY_NAME : nom de l'utilisateur en texte brut.
  • PHOTO_LINK : URL de la photo de profil de l'utilisateur.
  • PERMISSION_ID : ID de l'utilisateur dans les ressources Permission.
  • EMAIL_ADDRESS : adresse e-mail de l'utilisateur

Lister les applications utilisateur

Les applications Google Drive sont listées dans le Google Workspace Marketplace et sont utilisées pour rendre Drive plus pratique, comme l'application Google Docs ou un module complémentaire utilisé dans Docs pour signer des documents. Pour en savoir plus, consultez Utiliser les applications Google Drive.

Pour renvoyer la liste de toutes les applications installées par l'utilisateur sous la forme d'une instance de apps, utilisez la méthode list sans aucun paramètre.

Si vous souhaitez spécifier les champs à renvoyer dans la réponse, vous pouvez définir le paramètre système fields. Si vous ne spécifiez pas le paramètre fields, le serveur renvoie un ensemble de champs par défaut. Pour en savoir plus, consultez Renvoyer des champs spécifiques.

L'exemple de code suivant montre comment renvoyer une liste de toutes les applications installées par l'utilisateur dans la requête. La réponse renvoie les valeurs des champs pour la requête.

Requête

GET https://www.googleapis.com/drive/v3/apps

Réponse

{
  "kind": "drive#appList",
  "selfLink": "https://www.googleapis.com/drive/v3/apps",
  "items": [
    {
      "kind": "drive#app",
      "id": "ID",
      "name": "Google Sheets",
      "supportsCreate": true,
      "supportsImport": true,
      "supportsMultiOpen": false,
      "supportsOfflineCreate": true,
      "productUrl": "https://chrome.google.com/webstore/detail/felcaaldnbdncclmgdcncolpebgiejap",
      "productId": "PRODUCT_ID"
    }
  ],
  "defaultAppIds": [
    "ID"
  ]
}

La réponse inclut les valeurs suivantes :

  • ID : ID de l'application.
  • PRODUCT_ID : ID de la fiche produit pour cette application.

Lister les applications utilisateur avec des paramètres de requête

Pour trouver une application spécifique, utilisez un ou plusieurs des paramètres de requête facultatifs :

  • appFilterExtensions : filtrez les résultats de recherche à l'aide d'une liste d'extensions de fichier séparées par une virgule. Les applications incluses dans le champ d'application de la requête d'application et pouvant ouvrir les extensions de fichier listées sont incluses dans la réponse. Si des appFilterMimeTypes sont également fournis, une union des deux listes d'applications résultantes est renvoyée. Par exemple, docx pour Microsoft Word et pptx pour Microsoft PowerPoint. Pour obtenir d'autres exemples d'extensions de fichier, consultez Exporter les types MIME pour les documents Google Workspace.

    L'exemple de code suivant montre comment fournir plusieurs extensions de fichier en tant que paramètre de requête : GET https://www.googleapis.com/drive/v3/apps?appFilterExtensions=docx,pptx.

  • appFilterMimeTypes : filtrez les résultats de recherche à l'aide d'une liste de types MIME séparés par une virgule. Les applications incluses dans le champ d'application de la requête d'application et pouvant ouvrir les types MIME listés sont incluses dans la réponse. Si des appFilterExtensions sont également fournis, une union des deux listes d'applications résultantes est renvoyée. Par exemple, application/vnd.google-apps.form pour Google Forms et application/vnd.google-apps.site pour Google Sites. Pour obtenir d'autres exemples de types MIME, consultez Types MIME compatibles avec Google Workspace et Google Drive.

    L'exemple de code suivant montre comment fournir plusieurs types MIME en tant que paramètre de requête : GET https://www.googleapis.com/drive/v3/apps?appFilterMimeTypes=application/vnd.google-apps.form,application/vnd.google-apps.site.

  • languageCode : filtrez les résultats de recherche à l'aide d'un code de langue ou de code de région, tel que défini par BCP 47, avec quelques extensions du format LDML d'Unicode. Par exemple, les codes de langue en-us pour l'anglais (États-Unis) et fr-ca pour le français (Canada).

    L'exemple de code suivant montre comment fournir plusieurs codes de langue en tant que paramètre de requête : GET https://www.googleapis.com/drive/v3/apps?languageCode=en-us,fr-ca.

Obtenir une application utilisateur par ID

Pour télécharger les informations détaillées sur l'application en tant qu'instance de apps, utilisez la méthode get avec l'ID de l'application.

L'exemple de code suivant montre comment fournir un appId en tant que paramètre de requête. La réponse renvoie les valeurs des champs pour la requête.

Requête

GET https://www.googleapis.com/drive/v3/apps/APP_ID

Réponse

{
  "kind": "drive#app",
  "id": "ID",
  "name": "Google Sheets",
  "supportsCreate": true,
  "supportsImport": true,
  "supportsMultiOpen": false,
  "supportsOfflineCreate": true,
  "productUrl": "https://chrome.google.com/webstore/detail/felcaaldnbdncclmgdcncolpebgiejap",
  "productId": "PRODUCT_ID"
}

La réponse inclut les valeurs suivantes :

  • ID : ID de l'application.
  • PRODUCT_ID : ID de la fiche produit pour cette application.

Voici quelques étapes que vous pouvez également suivre :