Cette page a été traduite par l'API Cloud Translation.

Intégrer à l'interface utilisateur Drive "Ouvrir avec le menu contextuel"

Lorsqu'un utilisateur sélectionne un fichier et clique sur l'élément de menu "Ouvrir avec" de l'interface utilisateur Drive, Drive le redirige vers l'URL d'ouverture de cette application définie dans Configurer une intégration de l'UI Drive.

Si vous avez coché la case "Importation" lorsque vous avez configuré une intégration de l'UI Drive, l'utilisateur peut sélectionner une combinaison de fichiers Google Workspace et spécifiques à l'application à ouvrir. Lorsque vous configurez une intégration de l'UI Drive, les fichiers spécifiques à l'application sont définis dans les champs "Types MIME par défaut" et "Extensions de fichier par défaut", tandis que les fichiers Google Workspace sont définis dans les champs "Types MIME secondaires" et "Extensions de fichier secondaires".

Pour chaque fichier que l'utilisateur souhaite ouvrir, Drive compare les types MIME aux types MIME par défaut et secondaires que vous avez définis:

Pour les types MIME définis dans le champ "Types MIME par défaut", l'ID de fichier est transmis à votre application. Pour savoir comment gérer les fichiers spécifiques à l'application, consultez Gérer une URL d'ouverture pour les documents spécifiques à l'application.
Pour les types MIME définis dans le champ "Types MIME secondaires", l'interface utilisateur de Drive affiche une boîte de dialogue demandant à l'utilisateur dans quel type de fichier convertir le fichier Google Workspace. Par exemple, si vous sélectionnez un fichier Google Docs dans l'interface utilisateur de Drive et que le champ "Types MIME secondaires" suggère que votre application est compatible avec text/plain ou application/pdf, l'interface utilisateur de Drive demande à l'utilisateur s'il souhaite convertir le fichier au format texte brut ou PDF.

Pour savoir comment gérer les fichiers Google Workspace, consultez Gérer une URL ouverte pour les documents Google Workspace. Pour obtenir la liste des documents Google Workspace et des formats de conversion de type MIME, consultez Exporter des types MIME pour les documents Google Workspace.

Gérer une URL ouverte pour les documents spécifiques à une application

Comme indiqué dans la section Configurer une intégration de l'UI Drive, votre application reçoit des variables de modèle avec des informations permettant à votre application d'ouvrir le fichier. Votre application reçoit un ensemble par défaut de variables de modèle dans un paramètre state. Les informations state par défaut pour une URL d'ouverture spécifique à une application sont les suivantes:

{
  "ids": ["ID"],
  "resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
  "action":"open",
  "userId":"USER_ID"
}

Ce résultat inclut les valeurs suivantes :

ID: ID du dossier parent.
RESOURCE_KEYS: dictionnaire JSON des ID de fichier mappés à leurs clés de ressources respectives.
open: action effectuée. La valeur est open lorsque vous utilisez une URL ouverte.
USER_ID: ID de profil qui identifie de manière unique l'utilisateur.

Votre application doit répondre à cette requête en procédant comme suit:

Vérifiez que le champ action a la valeur open et que le champ ids est présent.
Utilisez la valeur userId pour créer une session pour l'utilisateur. Pour en savoir plus sur les utilisateurs connectés, consultez Utilisateurs et nouveaux événements.
Utilisez la méthode files.get pour vérifier les autorisations, extraire les métadonnées de fichier et télécharger le contenu du fichier à l'aide des valeurs ID.
Si resourceKeys a été défini sur la requête, définissez l'en-tête de requête X-Goog-Drive-Resource-Keys. Pour en savoir plus sur les clés de ressources, consultez la section Accéder aux fichiers partagés par lien à l'aide de clés de ressources.

Le paramètre state est encodé au format URL. Votre application doit donc gérer les caractères d'échappement et l'analyser au format JSON.

Gérer une URL ouverte pour les documents Google Workspace

Comme indiqué dans Configurer une intégration de l'interface utilisateur Drive, votre application reçoit un ensemble de variables de modèle par défaut dans un paramètre state. Les informations state par défaut pour une URL à ouvrir dans Google Workspace sont les suivantes:

{
  "exportIds": ["ID"],
  "resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
  "action":"open",
  "userId":"USER_ID"
}

Ce résultat inclut les valeurs suivantes :

EXPORT_ID: liste d'ID de fichiers exportés, séparés par une virgule (utilisée uniquement lors de l'ouverture de documents Google intégrés).
RESOURCE_KEYS: dictionnaire JSON d'ID de fichiers mappés avec leurs clés de ressource respectives.
open: action en cours d'exécution. La valeur est open lorsque vous utilisez une URL ouverte.
USER_ID: ID de profil qui identifie l'utilisateur.

Votre application doit répondre à cette demande en procédant comme suit:

Vérifiez qu'il s'agit d'une requête d'ouverture de fichier en détectant à la fois la valeur open dans le champ state et la présence du champ exportIds.
Utilisez la méthode files.get pour vérifier les autorisations, extraire les métadonnées de fichier et déterminer le type MIME à l'aide des valeurs EXPORT_ID.
Convertissez le contenu du fichier à l'aide de la méthode files.export. L'exemple de code suivant montre comment exporter un document Google Workspace vers le type MIME demandé.

Si resourceKey a été défini sur la requête, définissez l'en-tête de requête X-Goog-Drive-Resource-Keys. Pour en savoir plus sur les clés de ressources, consultez la section Accéder aux fichiers partagés par lien à l'aide de clés de ressources.

Java

drive/snippets/drive_v3/src/main/java/ExportPdf.java

Afficher sur GitHub

import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.drive.Drive;
import com.google.api.services.drive.DriveScopes;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Arrays;

/* Class to demonstrate use-case of drive's export pdf. */
public class ExportPdf {

  /**
   * Download a Document file in PDF format.
   *
   * @param realFileId file ID of any workspace document format file.
   * @return byte array stream if successful, {@code null} otherwise.
   * @throws IOException if service account credentials file not found.
   */
  public static ByteArrayOutputStream exportPdf(String realFileId) throws IOException {
    // Load pre-authorized user credentials from the environment.
    // TODO(developer) - See https://developers.google.com/identity for
    // guides on implementing OAuth2 for your application.
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(Arrays.asList(DriveScopes.DRIVE_FILE));
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Build a new authorized API client service.
    Drive service = new Drive.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Drive samples")
        .build();

    OutputStream outputStream = new ByteArrayOutputStream();
    try {
      service.files().export(realFileId, "application/pdf")
          .executeMediaAndDownloadTo(outputStream);

      return (ByteArrayOutputStream) outputStream;
    } catch (GoogleJsonResponseException e) {
      // TODO(developer) - handle error appropriately
      System.err.println("Unable to export file: " + e.getDetails());
      throw e;
    }
  }
}

Python

drive/snippets/drive-v3/file_snippet/export_pdf.py

Afficher sur GitHub

import io

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from googleapiclient.http import MediaIoBaseDownload


def export_pdf(real_file_id):
  """Download a Document file in PDF format.
  Args:
      real_file_id : file ID of any workspace document format file
  Returns : IO object with location

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()

  try:
    # create drive api client
    service = build("drive", "v3", credentials=creds)

    file_id = real_file_id

    # pylint: disable=maybe-no-member
    request = service.files().export_media(
        fileId=file_id, mimeType="application/pdf"
    )
    file = io.BytesIO()
    downloader = MediaIoBaseDownload(file, request)
    done = False
    while done is False:
      status, done = downloader.next_chunk()
      print(f"Download {int(status.progress() * 100)}.")

  except HttpError as error:
    print(f"An error occurred: {error}")
    file = None

  return file.getvalue()


if __name__ == "__main__":
  export_pdf(real_file_id="1zbp8wAyuImX91Jt9mI-CAX_1TqkBLDEDcr2WeXBbKUY")

Node.js

drive/snippets/drive_v3/file_snippets/export_pdf.js

Afficher sur GitHub

/**
 * Download a Document file in PDF format
 * @param{string} fileId file ID
 * @return{obj} file status
 * */
async function exportPdf(fileId) {
  const {GoogleAuth} = require('google-auth-library');
  const {google} = require('googleapis');

  // Get credentials and build service
  // TODO (developer) - Use appropriate auth mechanism for your app
  const auth = new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/drive',
  });
  const service = google.drive({version: 'v3', auth});

  try {
    const result = await service.files.export({
      fileId: fileId,
      mimeType: 'application/pdf',
    });
    console.log(result.status);
    return result;
  } catch (err) {
    // TODO(developer) - Handle error
    throw err;
  }
}

PHP

drive/snippets/drive_v3/src/DriveExportPdf.php

Afficher sur GitHub

use Google\Client;
use Google\Service\Drive;
function exportPdf()
{
    try {
        $client = new Client();
        $client->useApplicationDefaultCredentials();
        $client->addScope(Drive::DRIVE);
        $driveService = new Drive($client);
        $realFileId = readline("Enter File Id: ");
        $fileId = '1ZdR3L3qP4Bkq8noWLJHSr_iBau0DNT4Kli4SxNc2YEo';
        $fileId = $realFileId;
        $response = $driveService->files->export($fileId, 'application/pdf', array(
            'alt' => 'media'));
        $content = $response->getBody()->getContents();
        return $content;

    }  catch(Exception $e) {
         echo "Error Message: ".$e;
    }

}

Affichez les fichiers convertis en lecture seule ou présentez une boîte de dialogue permettant à l'utilisateur d'enregistrer le fichier en tant que nouveau type de fichier.

Le paramètre state est encodé au format URL. Votre application doit donc gérer les caractères d'échappement et l'analyser au format JSON.

Utilisateurs et nouveaux événements

Les applications Drive doivent traiter tous les événements "Ouvrir avec" comme des connexions potentielles. Certains utilisateurs peuvent avoir plusieurs comptes. Il est donc possible que l'ID utilisateur du paramètre state ne corresponde pas à la session en cours. Si l'ID utilisateur du paramètre state ne correspond pas à la session en cours, mettez fin à la session en cours pour votre application et connectez-vous en tant qu'utilisateur demandé.

Articles associés

En plus d'ouvrir une application à partir de l'interface utilisateur Google Drive, les applications peuvent afficher un sélecteur de fichier pour sélectionner du contenu au sein d'une application. Pour en savoir plus, consultez le sélecteur Google.