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

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

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

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

  • Для типов MIME, указанных в поле «Типы MIME по умолчанию», идентификатор файла передаётся в ваше приложение. Сведения об обработке файлов, специфичных для приложения, см. в разделе Обработка открытых URL-адресов для документов, специфичных для приложения .

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

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

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

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

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

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

  • ID : Идентификатор родительской папки.
  • RESOURCE_KEYS : словарь JSON идентификаторов файлов, сопоставленных с соответствующими ключами ресурсов.
  • open : выполняемое действие. Значение open при использовании Open URL.
  • 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

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

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

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

  • EXPORT_ID : список идентификаторов экспортируемых файлов, разделенных запятыми (используется только при открытии встроенных документов Google).
  • RESOURCE_KEYS : словарь JSON идентификаторов файлов, сопоставленных с соответствующими ключами ресурсов.
  • open : выполняемое действие. Значение open при использовании Open URL.
  • 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 . Подробнее о ключах ресурсов см. в разделе Доступ к файлам, доступным по ссылке, с помощью ключей ресурсов .

    Ява

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

    Питон

    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

    диск/сниппеты/диск_v3/файл_сниппеты/экспорт_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
    <?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» .