Konfigurowanie integracji interfejsu Dysku

Aby aplikacja wyświetlała się na Dysku Google, gdy użytkownik tworzy lub otwiera plik, musisz najpierw skonfigurować integrację interfejsu Dysku. Konfiguracja jest też wymagana, aby aplikacja była widoczna w Google Workspace Marketplace.

Włączanie interfejsu Drive API

Zanim zaczniesz korzystać z 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.

Konfigurowanie integracji z interfejsem Dysku

  1. W Konsoli interfejsów 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 Google Drive API. Pojawi się strona konfiguracji interfejsu Google Drive API.
  3. Wybierz kartę Integracja interfejsu 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, jednolinijkowy opis. Krótki opis jest wyświetlany 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 i w menu kontekstowym „Otwórz w programie”. Ikony powinny być w formacie PNG z przezroczystym tłem. Zanim ikony pojawią się na Dysku, może minąć do 24 godzin.

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

    • Ten adres URL musi zawierać pełną i jednoznaczną nazwę domeny. Adres localhost nie działa.
    • Ten adres URL powinien być dostępny dla docelowych użytkowników aplikacji. Jeśli masz kilka wersji aplikacji, np. jedną do publicznego udostępnienia i jedną do ograniczonego udostępnienia wybranym użytkownikom, każda wersja powinna używać unikalnego adresu URL. Następnie możesz utworzyć różne konfiguracje aplikacji dla każdej wersji.
    • Zanim opublikujesz aplikację w 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 Dysku do aplikacji. Informacje o zawartości parametru state znajdziesz w sekcji Parametr state.

  9. (Opcjonalnie) Wpisz domyślne typy MIME i rozszerzenia plików w polach Domyślne typy MIME i Domyślne rozszerzenia plików. Domyślne typy MIME i rozszerzenia plików reprezentują pliki, które aplikacja jest przeznaczona do otwierania. Na przykład aplikacja może otworzyć wbudowany format do nakładania warstw i edytowania obrazów. Uwzględniaj tylko standardowe typy multimediów i upewnij się, że nie zawierają one literówek ani błędów pisowni. Jeśli aplikacja otwiera tylko pliki skrótów lub skrótów innych firm, możesz pozostawić typ MIME pusty.

  10. (Opcjonalnie) Wpisz dodatkowe typy MIME i rozszerzenia plików w polach Dodatkowe typy MIME i Dodatkowe rozszerzenia plików. Dodatkowe typy MIME i rozszerzenia plików reprezentują pliki, które aplikacja może otwierać, ale nie są one specyficzne dla Twojej aplikacji. Na przykład Twoja aplikacja może być aplikacją do edycji obrazów, która otwiera obrazy PNG i JPG. Uwzględniaj tylko standardowe typy multimediów i upewnij się, że nie zawierają one literówek ani błędów pisowni. Jeśli aplikacja otwiera tylko pliki skrótów lub skrótów innych firm, możesz pozostawić typ MIME pusty.

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

    • Ten adres URL musi zawierać pełną i jednoznaczną nazwę domeny. Adres localhost nie działa.
    • Zanim opublikujesz aplikację w 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 Dysku do aplikacji. Informacje o zawartości parametru state znajdziesz w sekcji Parametr state.

  12. Wpisz adres URL w polu Nowy URL. Ten URL jest używany przez przycisk „Nowy” do przekierowywania 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 tym, jak obsługiwać dyski współdzielone w aplikacji, znajdziesz w artykule Wdrażanie obsługi dysków współdzielonych.

  15. Kliknij Prześlij.

Poproś o zakres drive.install

Aby aplikacje pojawiały się jako opcja w menu „Otwórz za pomocą” lub „Nowy”, poproś o zakres https://www.googleapis.com/auth/drive.install, aby zintegrować je z interfejsem Dysku. Gdy poprosisz o ten zakres, użytkownicy zobaczą okno podobne do tego:

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

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

Parametr state

Domyślnie do adresu URL otwarcia i nowego adresu URL jest dołączany parametr state, który umożliwia przekazywanie danych z interfejsu Dysku do aplikacji. Ten parametr zawiera ciąg znaków zakodowany w formacie JSON ze zmiennymi szablonu i danymi o żądaniu wysłanym do aplikacji. Uwzględnione zmienne zależą od typu użytego adresu URL (adres URL otwarcia lub nowy adres URL):

Zmienna szablonu Opis Aplikacja URL
{ids} Lista rozdzielonych przecinkami identyfikatorów otwieranych plików. Otwórz URL
{exportIds} Rozdzielona przecinkami lista identyfikatorów eksportowanych plików. Używane tylko podczas otwierania plików Google Workspace. Otwórz URL
{resourceKeys} Słownik JSON identyfikatorów plików zmapowanych 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 URL i Nowy URL
{action} Wykonywane działanie. Wartość to open, gdy używasz otwartego adresu URL, lub create, gdy używasz nowego adresu URL. Otwórz URL i Nowy URL

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

Przykładowe informacje o stanie w formacie JSON dla nowego adresu URL

Informacje o state dla nowego adresu URL:

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

Przykładowe informacje o stanie w formacie JSON dla otwartego adresu URL

Informacje o state w przypadku otwarcia adresu URL:

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

Identyfikatory i klucze zasobów służą do pobierania metadanych i zawartoś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.

Aplikacja instalowana musi umożliwiać tworzenie, zarządzanie i otwieranie działań uruchamianych z interfejsu Dysku. Więcej informacji znajdziesz w artykułach Integracja z przyciskiem „Nowy” w interfejsie Dysku i Integracja z menu kontekstowym „Otwórz w” w interfejsie Dysku.