Konfigurowanie integracji interfejsu Dysku

Aby wyświetlać aplikację na Dysku Google, gdy użytkownik utworzy lub otworzy plik, musisz najpierw skonfigurować integrację z interfejsem użytkownika Dysku. Konfiguracja jest też wymagana, aby umieścić aplikację na Google Workspace Marketplace.

Włączanie interfejsu Drive API

Zanim zaczniesz używać interfejsów API Google, musisz je włączyć w projekcie Google Cloud. W jednym projekcie Google Cloud możesz włączyć 1 lub więcej interfejsów API.

Aby rozpocząć integrację z interfejsem Dysku Google, musisz włączyć interfejs Drive API. Dzięki temu uzyskasz dostęp do interfejsu API i funkcji integracji interfejsu użytkownika.

Konfigurowanie integracji z interfejsem Dysku

  1. W Konsoli interfejsu API Google kliknij Menu  > Interfejsy API i usługi > Włączone interfejsy API i usługi.

    Otwórz stronę Włączone interfejsy API i usługi

  2. U dołu panelu Interfejsy API i usługi kliknij Interfejs API Dysku Google. Pojawi się strona konfiguracji interfejsu API Dysku Google.
  3. Wybierz kartę Integracja z interfejsem Dysku.
  4. (Opcjonalnie) Wpisz nazwę w polu Nazwa aplikacji. Nazwa aplikacji jest wyświetlana użytkownikom na karcie Zarządzaj aplikacjami w ustawieniach Dysku.
  5. (Opcjonalnie) W polu Krótki opis wpisz krótki opis składający się z 1 wiersza. Krótki opis wyświetla się użytkownikom na karcie Zarządzaj aplikacjami w ustawieniach Dysku.
  6. (Opcjonalnie) W polu Długi opis wpisz pełny opis.

  7. Prześlij co najmniej 1 ikonę aplikacji, która będzie wyświetlana na liście połączonych aplikacji Dysku użytkownika oraz w menu kontekstowym „Otwórz za pomocą”. Ikony powinny być w formacie PNG z przezroczystym tłem. Ikony mogą pojawić się w Drive w ciągu 24 godzin.

  8. Aby użyć opcji „Otwórz za pomocą” w menu interfejsu Dysku, wpisz adres URL swojej aplikacji w polu Otwórz URL. Ten adres URL jest używany przez menu kontekstowe „Otwórz za pomocą”.

    • Adres URL musi zawierać pełną i jednoznaczną nazwę domeny. Adres localhost nie działa.
    • Ten adres URL powinien być dostępny dla użytkowników aplikacji. Jeśli masz kilka wersji aplikacji, np. jedną do publicznego wydania i jedną do wydania ograniczonego dla wybranych użytkowników, każda z nich powinna mieć unikalny adres URL. Następnie możesz utworzyć różne konfiguracje aplikacji dla każdej wersji.
    • Zanim dodasz aplikację do Google Workspace Marketplace, musisz potwierdzić własność tego adresu URL.
    • Domyślnie do tego adresu URL jest dołączany parametr zapytania state, który służy do przekazywania danych z interfejsu Drive do aplikacji. Informacje o treści parametru state znajdziesz w sekcji Parametry zapytania.state

  9. (Opcjonalnie) W polach Domyślne typy MIME i Domyślne rozszerzenia plików wpisz domyślne typy MIME i rozszerzenia plików. Domyślne typy MIME i rozszerzenia plików reprezentują pliki, które aplikacja może otworzyć. Aplikacja może na przykład otworzyć wbudowany format do nakładania i edytowania obrazów. Uwzględniaj tylko standardowe typy multimediów i upewnij się, że nie zawierają one literówek. Jeśli aplikacja otwiera tylko pliki skrótów lub skróty innych firm, pole Typ MIME możesz pozostawić puste.

  10. (Opcjonalnie) Wpisz dodatkowe typy MIME i rozszerzenia plików w polach Dodatkowe typy MIME i Dodatkowe rozszerzenia plików. Dodatkowe typy MIME i ich rozszerzenia to pliki, które aplikacja może otworzyć, ale nie są one specyficzne dla tej aplikacji. Możesz na przykład mieć aplikację do edycji zdjęć, która otwiera obrazy PNG i JPG. Uwzględniaj tylko standardowe typy multimediów i upewnij się, że nie zawierają one literówek. Jeśli aplikacja otwiera tylko pliki skrótów lub skróty innych firm, pole Typ MIME możesz pozostawić puste.

  11. Aby używać przycisku „Nowy” w interfejsie Dysku i umożliwić użytkownikom tworzenie plików w aplikacji, zaznacz pole Tworzenie plików. Pojawi się pole Nowy adres URL i opcjonalne pole Nazwa dokumentu.

    • Adres URL musi zawierać pełną i jednoznaczną nazwę domeny. Adres localhost nie działa.
    • Zanim umieścisz aplikację w Google Workspace Marketplace, musisz potwierdzić własność tego adresu URL.
    • Domyślnie do tego adresu URL dołączany jest parametr zapytania state, który umożliwia przekazywanie danych z interfejsu Drive do aplikacji. Informacje o zawartości parametru state znajdziesz w sekcji Parametry state.

  12. Wpisz adres URL w polu Nowy URL. Ten URL jest używany przez przycisk „Nowy”, aby przekierować użytkownika do Twojej aplikacji.

  13. (Opcjonalnie) Jeśli chcesz, aby aplikacja otwierała pliki obsługiwane przez Google Workspace, zaznacz pole Importowanie.

  14. (Opcjonalnie) Jeśli aplikacja musi zarządzać plikami na dyskach współdzielonych, zaznacz pole Obsługa dysków współdzielonych. Więcej informacji o obsługiwaniu dysków współdzielonych w aplikacji znajdziesz w artykule Wdrażanie obsługi dysków współdzielonych.

  15. Kliknij Prześlij.

Poproś o zakres drive.install

Aby umożliwić aplikacjom wyświetlanie się jako opcji w menu „Otwórz za pomocą” lub „Nowy”, poproś o uprawnienia https://www.googleapis.com/auth/drive.install, aby zintegrować aplikację z interfejsem Dysku. Gdy użytkownicy otrzymają prośbę o taki zakres, zobaczą okno podobne do tego:

Okno instalacji interfejsu Dysku Google.
Rysunek 1. Okno instalacji podczas korzystania z zakresów w interfejsie Dysku.

Więcej informacji o zakresach, o które możesz poprosić w przypadku aplikacji na Dysku, oraz o tym, jak je poprosić, znajdziesz w artykule Informacje na temat autoryzacji i uwierzytelniania w interfejsie API (w języku angielskim).

Parametr state

Domyślnie parametr state jest dołączany do adresów URL Otwórz i Nowy, aby przekazywać dane z interfejsu Drive do aplikacji. Zawiera on ciąg znaków zakodowany w formacie JSON z uwzględnieniem zmiennych szablonu i danych dotyczących żądania do aplikacji. Dołączone zmienne zależą od typu użytego adresu URL (Otwórz lub Nowy):

Zmienna szablonu Opis Aplikacja adresu URL
{ids} Lista identyfikatorów otwieranych plików rozdzielona przecinkami. Otwórz URL
{exportIds} Lista identyfikatorów plików rozdzielana przecinkami (używana tylko podczas otwierania wbudowanych dokumentów Google). Otwórz URL
{resourceKeys} słownik JSON z identyfikatorami plików mapowanymi na odpowiednie klucze zasobów. Otwórz URL
{folderId} Identyfikator folderu nadrzędnego. Nowy URL
{folderResourceKey} Klucz zasobu folderu nadrzędnego. Nowy URL
{userId} Identyfikator profilu, który identyfikuje użytkownika. Otwórz adres URL i Nowy adres URL
{action} Wykonywane działanie. Wartość to: open, gdy używasz opcji Otwórz URL, lub create, gdy używasz opcji Nowy URL. Otwórz adres URL i Nowy adres URL

Parametr state jest zakodowany w formacie adresu URL, więc aplikacja musi obsługiwać znaki ucieczki i analizować go jako dane JSON. Aplikacje mogą wykrywać wartość create w parametrze state, aby zweryfikować żądanie utworzenia pliku.

Przykład informacji o stanie w formacie JSON dla nowego adresu URL

Informacje state dotyczące nowego adresu URL:

{
  "action":"create",
  "folderId":"FOLDER_ID",
  "folderResourceKey":"FOLDER_RESOURCE_KEY",
  "userId":"USER_ID"
}

Przykład informacji o stanie w formacie JSON dla akcji Otwieranie adresu URL

Informacje state dotyczące adresu URL w trybie otwartym:

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

Identyfikatory i klucze zasobów są używane do pobierania metadanych plików i treści plików. Gdy aplikacja ma identyfikator pliku i token dostępu, może sprawdzać uprawnienia, pobierać metadane pliku i pobierać zawartość pliku zgodnie z opisem w metodzie files.get.

Zainstalowana aplikacja musi mieć możliwość tworzenia, zarządzania i otwierania działań uruchomionych z interfejsu Dysku. Więcej informacji znajdziesz w artykule Integracja z przyciskiem „Nowy” w interfejsie Dysku lub Integracja z menu kontekstowym „Otwórz za pomocą” w interfejsie Dysku.