このページは Cloud Translation API によって翻訳されました。

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

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

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

ユーザーが開こうとしているファイルごとに、ドライブは定義されたデフォルトの MIME タイプと予備の MIME タイプに対して MIME タイプをチェックします。

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

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

アプリ固有のドキュメントの URL を開く処理

ドライブ UI 統合を構成するで説明したように、アプリは、アプリがファイルを開くための情報を含むテンプレート変数を受け取ります。アプリは、state パラメータ内でテンプレート変数のデフォルトセットを受け取ります。アプリ固有の Open 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 ドキュメントの Open URL を処理する

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

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

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

EXPORT_ID: エクスポートされるファイル ID のカンマ区切りのリスト（組み込みの Google ドキュメントを開く場合にのみ使用されます）。
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 で表示

/**
 * 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

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 ドキュメントの Open URL を処理する

Java

Python

Node.js

PHP

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

関連トピック

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