ドライブの UI の [アプリで開く] コンテキスト メニューと統合する

ユーザーがファイルを選択してドライブ UI の [アプリで開く] メニュー項目をクリックすると、ドライブ UI 統合を構成するで定義されたそのアプリのオープン URL にユーザーがリダイレクトされます。

ドライブの UI 統合を構成するときに [インポート] チェックボックスをオンにした場合、ユーザーはアプリ固有のファイルと Google Workspace ファイルの組み合わせを選択して開くことができます。ドライブの UI 統合を構成すると、アプリ固有のファイルは [デフォルトの MIME タイプ] フィールドと [デフォルトのファイル拡張子] フィールドで定義されます。Google Workspace のファイルは [セカンダリ MIME タイプ] と [セカンダリ ファイル拡張子] フィールドで定義されます。

ドライブは、ユーザーが開こうとしているファイルごとに、MIME タイプを定義済みのデフォルトおよびセカンダリ MIME タイプと照合します。

  • [デフォルトの MIME タイプ] フィールドで定義された MIME タイプの場合、ファイル ID がアプリに渡されます。アプリ固有のファイルを処理する方法については、アプリ固有のドキュメントのオープン URL を処理するをご覧ください。

  • [セカンダリ MIME タイプ] フィールドで定義した MIME タイプについては、Google Workspace ファイルの変換先のファイル形式を尋ねるダイアログがドライブの UI に表示されます。たとえば、ドライブの UI で Google ドキュメント ファイルを選択し、[Secondary MIME タイプ] でアプリが text/plain または application/pdf をサポートしていると示された場合、ドライブの UI に、書式なしテキストまたは PDF に変換するかどうかをユーザーに尋ねるメッセージが表示されます。

    Google Workspace ファイルの処理方法については、Google Workspace ドキュメントのオープン URL を処理するをご覧ください。Google Workspace ドキュメントと MIME タイプの変換形式のリストについては、Google Workspace ドキュメントの MIME タイプをエクスポートするをご覧ください。

アプリ固有のドキュメントのオープン URL を処理する

ドライブ UI 統合を構成するで説明したように、アプリは、ファイルを開くための情報を含むテンプレート変数を受け取ります。アプリは、state パラメータ内でデフォルトのテンプレート変数のセットを受け取ります。アプリ固有のオープン URL のデフォルトの state 情報は次のとおりです。

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

この出力には次の値が含まれます。

  • ID: 親フォルダの ID。
  • RESOURCE_KEYS: それぞれのリソースキーにマッピングされたファイル ID の JSON 辞書。
  • open: 実行されるアクション。Open URL を使用する場合、値は open です。
  • USER_ID: ユーザーを一意に識別するプロファイル ID。

アプリは、このリクエストに応じて以下の手順を行う必要があります。

  1. action フィールドの値が open であり、ids フィールドが存在することを確認します。
  2. userId 値を使用して、ユーザーの新しいセッションを作成します。ログイン ユーザーの詳細については、ユーザーと新しいイベントをご覧ください。
  3. files.get メソッドを使用して、権限の確認、ファイル メタデータのフェッチ、ID 値によるファイル コンテンツのダウンロードを行います。
  4. リクエストで resourceKeys が設定されている場合は、X-Goog-Drive-Resource-Keys リクエスト ヘッダーを設定します。リソースキーの詳細については、リソースキーを使用してリンク共有ファイルにアクセスするをご覧ください。

state パラメータは URL エンコードされているため、アプリでエスケープ文字を処理して JSON として解析する必要があります。

Google Workspace ドキュメントのオープン URL を処理する

ドライブ UI 統合を構成するで説明したように、アプリは state パラメータ内でデフォルトのテンプレート変数のセットを受け取ります。Google Workspace のオープン URL のデフォルトの state 情報は次のとおりです。

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

この出力には次の値が含まれます。

  • EXPORT_ID: エクスポートされるファイル ID のカンマ区切りのリスト(組み込みの Google ドキュメントを開く場合にのみ使用されます)。
  • RESOURCE_KEYS: それぞれのリソースキーにマッピングされたファイル ID の JSON 辞書。
  • open: 実行されるアクション。Open URL を使用する場合、値は open です。
  • USER_ID: ユーザーを識別するプロファイル ID。

アプリは、このリクエストに応じて以下の手順を行う必要があります。

  1. state フィールドの open 値と exportIds フィールドの有無を両方とも検出して、これがファイルを開くリクエストであることを確認します。

  2. files.get メソッドを使用して、権限の確認、ファイル メタデータのフェッチ、EXPORT_ID 値による MIME タイプの確認を行います。

  3. files.export メソッドを使用して、ファイルの内容を変換します。次のコードサンプルは、リクエストされた MIME タイプに Google Workspace ドキュメントをエクスポートする方法を示しています。

  4. リクエストで resourceKey が設定されている場合は、X-Goog-Drive-Resource-Keys リクエスト ヘッダーを設定します。リソースキーの詳細については、リソースキーを使用してリンク共有ファイルにアクセスするをご覧ください。

    Java

    drive/snippets/drive_v3/src/main/java/ExportPdf.java
    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
    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
    /**
     * 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
    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;
        }
    
    }

変換されたファイルを読み取り専用として表示するか、ユーザーが新しいファイル形式でファイルを保存できるダイアログを表示します。

state パラメータは URL エンコードされているため、アプリでエスケープ文字を処理して JSON として解析する必要があります。

ユーザーと新しいイベント

ドライブアプリは、「アプリで開く」イベントを潜在的なログインとして扱う必要があります。複数のアカウントを持っているユーザーもいるため、state パラメータのユーザー ID が現在のセッションと一致しない場合があります。state パラメータのユーザー ID が現在のセッションと一致しない場合は、アプリの現在のセッションを終了し、リクエストされたユーザーとしてログインします。

Google ドライブの UI からアプリを開くだけでなく、アプリ内からコンテンツを選択するためのファイル選択ツールを表示することもできます。詳細については、Google Picker をご覧ください。