Интеграция с контекстным меню "Открыть с помощью" в интерфейсе Диска

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

Если при настройке интеграции с интерфейсом Диска вы установили флажок "Импорт", пользователь может выбрать для открытия как файлы, относящиеся к приложению, так и файлы Google Workspace. При настройке интеграции с интерфейсом Диска файлы, относящиеся к приложению, определяются в полях "MIME-типы по умолчанию" и "Расширения имени файла по умолчанию", а файлы Google Workspace – в полях "Дополнительные MIME-типы" и "Дополнительные расширения имени файла".

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

  • Для MIME-типов, указанных в поле "MIME-типы по умолчанию", идентификатор файла передается в приложение. Информацию о том, как обрабатывать файлы, относящиеся к приложению, можно найти в разделе Обработка URL открытия для документов, относящихся к приложению.

  • Для MIME-типов, определенных в поле "Дополнительные MIME-типы", в интерфейсе Диска отображается диалоговое окно, в котором пользователю предлагается выбрать тип файла, в который нужно преобразовать файл Google Workspace. Например, если вы выберете файл Google Документов в интерфейсе Диска и в поле "Дополнительные MIME-типы" будет указано, что ваше приложение поддерживает text/plain или application/pdf, интерфейс Диска спросит пользователя, хочет ли он преобразовать файл в обычный текст или PDF.

    Информацию о том, как работать с файлами Google Workspace, можно найти в статье Как обрабатывать URL для открытия документов Google Workspace. Список документов Google Workspace и форматов преобразования MIME-типов приведен в статье MIME-типы экспорта для документов Google Workspace.

Как обрабатывать URL для документов, связанных с приложениями

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

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

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

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

Приложение должно выполнить этот запрос, следуя приведенным ниже инструкциям.

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

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

Как обрабатывать URL для открытия документов Google Workspace

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

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

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

  • EXPORT_ID – список идентификаторов экспортируемых файлов, разделенный запятыми. Используется только при открытии файлов Google Workspace.
  • RESOURCE_KEYS – словарь JSON с идентификаторами файлов, сопоставленными с соответствующими ключами ресурсов.
  • open – выполняемое действие. Если используется URL перехода, значение равно open.
  • USER_ID – идентификатор профиля, который позволяет идентифицировать пользователя.

Приложение должно выполнить этот запрос, следуя приведенным ниже инструкциям.

  1. Убедитесь, что это запрос на открытие файла, проверив значение open в поле state и наличие поля exportIds.

  2. Используйте метод files.get, чтобы проверить разрешения, получить метаданные файла и определить MIME-тип с помощью значений EXPORT_ID.

  3. Преобразуйте содержимое файла с помощью метода files.export. В следующем примере кода показано, как экспортировать документ Google Workspace в запрошенный MIME-тип.

  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
    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
    <?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 может не совпадать с текущим сеансом. Если идентификатор пользователя в параметре state не соответствует текущему сеансу, завершите текущий сеанс для приложения и войдите в аккаунт нужного пользователя.

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