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

ユーザーがファイルを選択して [ドライブの管理画面の「アプリで開く」]メニュー項目をクリックすると、ドライブはユーザーを、[ドライブの管理画面の統合を設定する]で定義されているアプリのオープン URL にリダイレクトします。

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

ユーザーが開こうとしているファイルごとに、ドライブは定義済みのデフォルトの MIME タイプと予備の MIME タイプと照合して MIME タイプを確認します。

[デフォルトの MIME タイプ] フィールドで定義された MIME タイプの場合、ファイル ID がアプリに渡されます。アプリ固有のファイルの処理方法については、アプリ固有のドキュメントのオープン URL を処理するをご覧ください。
[予備の MIME タイプ] フィールドで定義された MIME タイプの場合、ドライブの管理画面に、Google Workspace ファイルを変換するファイル形式をユーザーに尋ねるダイアログが表示されます。たとえば、ドライブの管理画面で Google ドキュメントファイルを選択し、[予備の MIME タイプ] フィールドでアプリが text/plain または application/pdf をサポートしていることが示されている場合、ドライブの管理画面でプレーンテキストまたは PDF に変換するかどうかをユーザーに尋ねます。

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

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

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

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

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

ID：親フォルダの ID。
RESOURCE_KEYS: ファイル ID を対応するリソースキーにマッピングした JSON ディクショナリ。
open: 実行中のアクション。オープン URL を使用する場合、値は open になります。
USER_ID: ユーザーを一意に識別するプロファイル ID。

アプリは、次の手順でこのリクエストに対応する必要があります。

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

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

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

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

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

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

EXPORT_ID: エクスポートされるファイル ID のカンマ区切りのリスト。Google Workspace ファイルを開く場合にのみ使用されます。
RESOURCE_KEYS: ファイル ID を対応するリソースキーにマッピングした JSON ディクショナリ。
open: 実行中のアクション。オープン URL を使用する場合、値は open になります。
USER_ID: ユーザーを識別するプロファイル ID。

アプリは、次の手順でこのリクエストに対応する必要があります。

state フィールドの open 値と exportIds フィールドの存在の両方を検出して、ファイルを開くリクエストであることを確認します。
files.get メソッドを使用して、権限を確認し、ファイルメタデータを取得し、 EXPORT_ID 値を使用して MIME タイプを決定します。
files.export メソッドを使用して、ファイルコンテンツを変換します。次のコードサンプルは、Google Workspace ドキュメントをリクエストされた MIME タイプにエクスポートする方法を示しています。

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

Java

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

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

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

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

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;
    }

}

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

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

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

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

ドライブの UI の [アプリで開く] コンテキスト メニューと統合する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

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

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

Java

Python

Node.js

PHP

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

関連トピック

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