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 redirige l'utilisateur vers l'URL d'ouverture de cette application, définie dans Configurer une intégration de l'interface utilisateur Drive.

Si vous avez coché la case "Importation" lorsque vous avez configuré une intégration de l'interface utilisateur Drive, l'utilisateur peut sélectionner une combinaison de fichiers spécifiques à l'application et de fichiers Google Workspace à ouvrir. Lorsque vous configurez une intégration de l'interface utilisateur 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 à ceux que vous avez définis par défaut et comme secondaires :

Pour les types MIME définis dans le champ "Types MIME par défaut", l'ID du 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 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 Drive et que le champ "Types MIME secondaires" suggère que votre application est compatible avec text/plain ou application/pdf, l'interface utilisateur Drive demande à l'utilisateur s'il souhaite effectuer la conversion au format texte brut ou PDF.

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

Gérer une URL d'ouverture pour les documents spécifiques à l'application

Comme indiqué dans Configurer une intégration de l'interface utilisateur Drive , votre application reçoit des variables de modèle contenant 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 state paramètre. Les informations state par défaut pour une URL d'ouverture spécifique à l'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 d'ID de fichier mappés à leurs clés de ressource respectives.
open : action en cours d'exécution. La valeur est open lorsque vous utilisez une URL d'ouverture.
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, récupérer les métadonnées du fichier et télécharger le contenu du fichier à l'aide des valeurs ID.
Si resourceKeys a été défini dans 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 ressource, consultez Accéder aux fichiers partagés par lien à l'aide de clés de ressource.

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 d'ouverture pour les documents Google Workspace

Comme indiqué dans Configurer une intégration de l'interface utilisateur Drive, 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 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 fichier à exporter, séparés par une virgule. Utilisé uniquement lors de l'ouverture de fichiers Google Workspace.
RESOURCE_KEYS : dictionnaire JSON d'ID de fichier mappés à leurs clés de ressource respectives.
open : action en cours d'exécution. La valeur est open lorsque vous utilisez une URL d'ouverture.
USER_ID : ID de profil qui identifie l'utilisateur.

Votre application doit répondre à cette requête 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, récupérer les métadonnées du fichier et déterminer le type MIME à l'aide des EXPORT_ID valeurs.
Convertissez le contenu du fichier à l'aide de la files.export méthode. L'exemple de code suivant montre comment exporter un document Google Workspace vers le type MIME demandé.

Si resourceKey a été défini dans 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 ressource, consultez Accéder aux fichiers partagés par lien à l'aide de clés de ressource.

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

import {GoogleAuth} from 'google-auth-library';
import {google} from 'googleapis';

/**
 * Exports a Google Doc as a PDF.
 * @param {string} fileId The ID of the file to export.
 * @return {Promise<number>} The status of the export request.
 */
async function exportPdf(fileId) {
  // Authenticate with Google and get an authorized client.
  // TODO (developer): Use an appropriate auth mechanism for your app.
  const auth = new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/drive',
  });

  // Create a new Drive API client (v3).
  const service = google.drive({version: 'v3', auth});

  // Export the file as a PDF.
  const result = await service.files.export({
    fileId,
    mimeType: 'application/pdf',
  });

  // Print the status of the export.
  console.log(result.status);
  return result.status;
}

PHP

drive/snippets/drive_v3/src/DriveExportPdf.php

Afficher sur GitHub

<?php
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 sous le 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. L'ID utilisateur dans le paramètre state peut donc ne pas correspondre à la session actuelle. Si l'ID utilisateur dans le paramètre state ne correspond pas à la session actuelle, mettez fin à la session actuelle 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 fichiers pour sélectionner du contenu dans une application. Pour en savoir plus, consultez Google Picker.

Intégrer à l'interface utilisateur Drive "Ouvrir avec le menu contextuel" Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Gérer une URL d'ouverture pour les documents spécifiques à l'application

Gérer une URL d'ouverture pour les documents Google Workspace

Java

Python

Node.js

PHP

Utilisateurs et nouveaux événements

Articles associés

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