Эта страница переведена с помощью Cloud Translation API.

Интеграция с функцией «Открыть с помощью» пользовательского интерфейса Drive. контекстное меню

Когда пользователь выбирает файл и нажимает пункт меню «Открыть с помощью» пользовательского интерфейса Диска , Диск перенаправляет пользователя на URL-адрес открытия этого приложения, определенный в разделе «Настройка интеграции пользовательского интерфейса Диска» .

Если вы установили флажок «Импортировать» при настройке интеграции пользовательского интерфейса Drive, пользователь может выбрать для открытия комбинацию файлов приложения и файлов Google Workspace. При настройке интеграции пользовательского интерфейса Drive файлы, специфичные для приложения, определяются в полях «Типы MIME по умолчанию» и «Расширения файлов по умолчанию», тогда как файлы Google Workspace определяются в полях «Вторичные типы MIME» и «Вторичные расширения файлов».

Для каждого файла, который пользователь хочет открыть, Диск проверяет типы MIME на соответствие определенным вами по умолчанию и дополнительным типам MIME:

Для типов MIME, определенных в поле «Типы MIME по умолчанию», идентификатор файла передается в ваше приложение. Информацию о том, как обращаться с файлами, специфичными для приложения, см. в разделе «Обработка открытого URL-адреса для документов, специфичных для приложения» .
Для типов MIME, определенных в поле «Вторичные типы MIME», в пользовательском интерфейсе Диска отображается диалоговое окно с вопросом, в какой тип файла преобразовать файл Google Workspace. Например, если вы выбираете файл Google Docs в пользовательском интерфейсе Диска, и в поле «Вторичные типы MIME» указывается, что ваше приложение поддерживает текст/обычный текст или приложение/pdf, пользовательский интерфейс Диска спрашивает пользователя, хотят ли они преобразовать его в обычный текст или PDF. .
Информацию о том, как обращаться с файлами Google Workspace, см. в разделе «Обработка открытого URL-адреса для документов Google Workspace» . Список документов Google Workspace и форматов преобразования типов MIME см. в разделе Экспорт типов MIME для документов Google Workspace .

Обработка открытого URL-адреса для документов, специфичных для приложения.

Как упоминалось в разделе Настройка интеграции пользовательского интерфейса Drive , ваше приложение получает переменные шаблона с информацией, позволяющей вашему приложению открыть файл. Ваше приложение получает набор переменных шаблона по умолчанию в параметре state . Информация state по умолчанию для открытого URL-адреса конкретного приложения следующая:

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

Этот вывод включает в себя следующие значения:

ID : идентификатор родительской папки.
RESOURCE_KEYS : словарь JSON идентификаторов файлов, сопоставленных с соответствующими ключами ресурсов.
open : выполняемое действие. Значение open при использовании открытого URL-адреса.
USER_ID : идентификатор профиля, который однозначно идентифицирует пользователя.

Ваше приложение должно отреагировать на этот запрос, выполнив следующие действия:

Убедитесь, что поле action имеет значение open и поле ids присутствует.
Используйте значение userId , чтобы создать новый сеанс для пользователя. Дополнительную информацию о вошедших в систему пользователях см. в разделе Пользователи и новые события .
Используйте метод files.get для проверки разрешений, получения метаданных файла и загрузки содержимого файла, используя значения ID .
Если в запросе был установлен resourceKeys , установите заголовок запроса X-Goog-Drive-Resource-Keys . Дополнительные сведения о ключах ресурсов см. в разделе Доступ к файлам, доступным по ссылке, с помощью ключей ресурсов .

Параметр state закодирован в URL-адресе, поэтому ваше приложение должно обрабатывать escape-символы и анализировать их как JSON.

Примечание. Все приложения, включая приложения, открывающие файлы с помощью ярлыков и сторонних ярлыков, должны вызывать метод files.get для проверки разрешений пользователя для документа. Приложения должны предупреждать пользователей, имеющих доступ только для чтения, когда они открывают файл, который они не могут редактировать или сохранять (вместо того, чтобы позволять им тратить время на редактирование, а затем отображать ошибку при сохранении).

Обработка открытого URL-адреса для документов Google Workspace

Как упоминалось в разделе Настройка интеграции пользовательского интерфейса Drive , ваше приложение получает набор переменных шаблона по умолчанию в параметре state . Информация state по умолчанию для открытого URL-адреса Google Workspace:

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

Этот вывод включает в себя следующие значения:

EXPORT_ID : разделенный запятыми список идентификаторов экспортируемых файлов (используется только при открытии встроенных документов Google).
RESOURCE_KEYS : словарь JSON идентификаторов файлов, сопоставленных с соответствующими ключами ресурсов.
open : выполняемое действие. Значение open при использовании открытого URL-адреса.
USER_ID : идентификатор профиля, идентифицирующий пользователя.

Ваше приложение должно отреагировать на этот запрос, выполнив следующие действия:

Убедитесь, что это запрос на открытие файла, определив как значение open в поле state , так и наличие поля exportIds .
Используйте метод files.get для проверки разрешений, получения метаданных файла и определения типа MIME с использованием значений EXPORT_ID .
Преобразуйте содержимое файла с помощью метода files.export . В следующем примере кода показано, как экспортировать документ Google Workspace в запрошенный тип MIME.

Если в запросе был установлен resourceKey , установите заголовок запроса X-Goog-Drive-Resource-Keys . Дополнительные сведения о ключах ресурсов см. в разделе Доступ к файлам, доступным по ссылке, с помощью ключей ресурсов .

Ява

диск/фрагменты/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;
    }
  }
}

Питон

диск/фрагменты/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_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_v3/src/DriveExportPdf.php

Посмотреть на 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;
    }

}

Отобразите преобразованные файлы как доступные только для чтения или отобразите диалоговое окно, позволяющее пользователю сохранить файл как файл нового типа.

Пользователи и новые события

Приложения Диска должны рассматривать все события «Открытие с помощью» как потенциальные входы в систему. У некоторых пользователей может быть несколько учетных записей, поэтому идентификатор пользователя в параметре state может не соответствовать текущему сеансу. Если идентификатор пользователя в параметре state не соответствует текущему сеансу, завершите текущий сеанс приложения и войдите в систему как запрошенный пользователь.

Связанные темы

Помимо открытия приложения из пользовательского интерфейса Google Диска, приложения могут отображать средство выбора файлов для выбора контента из приложения. Для получения дополнительной информации см. Google Picker .