Konfigurowanie integracji interfejsu Dysku

Aby wyświetlać aplikację na Dysku Google, gdy użytkownik utworzy lub otworzy plik, musisz najpierw skonfigurować integrację interfejsu użytkownika Dysku. Konfiguracja jest też wymagana do wyświetlania aplikacji w Google Workspace Marketplace.

Włączanie interfejsu Drive API

Zanim zaczniesz korzystać z interfejsów API Google, musisz włączyć je 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. Daje to dostęp do interfejsu API i funkcji integracji interfejsu użytkownika.

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. Kliknij 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) Wpisz krótki, jednowierszowy opis w polu Krótki opis. Krótki opis jest wyświetlany użytkownikom na karcie Zarządzaj aplikacjami w ustawieniach Dysku.
  6. (Opcjonalnie) Wpisz pełny opis w polu Długi opis.

  7. Prześlij co najmniej jedną ikonę aplikacji, która będzie wyświetlana na liście połączonych aplikacji Dysku użytkownika i w menu kontekstowym „Otwórz w”. Ikony powinny mieć format PNG na przezroczystym tle. Zanim ikony pojawią się na Dysku, może minąć do 24 godzin.

  8. Aby korzystać z elementu menu „Otwórz za pomocą” w interfejsie Dysku, wpisz adres URL aplikacji w polu Otwórz URL. Ten adres URL jest używany w menu kontekstowym „Otwórz za pomocą”.

    • Ten adres URL musi zawierać pełną i jednoznaczną nazwę domeny. localhost nie działa.
    • Adres URL powinien być dostępny dla docelowych użytkowników aplikacji. Jeśli masz wiele wersji aplikacji, np. jedną dla wersji publicznej i drugą dla wybranych użytkowników, każda z nich powinna używać unikalnego adresu URL. Możesz utworzyć różne konfiguracje dla każdej wersji.
    • Zanim opublikujesz aplikację w Google Workspace Marketplace, musisz zweryfikować własność tego adresu URL.
    • Domyślnie do tego adresu URL jest dołączany parametr zapytania state, aby przekazywać do aplikacji dane z interfejsu Dysku. Informacje o zawartości parametru state znajdziesz w sekcji dotyczącej parametru 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 możesz otwierać bezpośrednio w aplikacji. Aplikacja może na przykład otwierać wbudowany format do nakładania warstw i edytowania obrazów. Dozwolone są tylko standardowe typy multimediów i nie mogą zawierać literówek ani literówek. Jeśli Twoja aplikacja otwiera tylko skróty lub pliki skrótów innych firm, możesz pozostawić pusty typ MIME.

  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 otworzyć, ale nie są ściśle związane z aplikacją. Może to być na przykład aplikacja do edytowania obrazów, w której otwiera się obrazy w formacie PNG i JPG. Dozwolone są tylko standardowe typy multimediów i nie mogą zawierać literówek ani literówek. Jeśli Twoja aplikacja otwiera tylko skróty lub pliki skrótów innych firm, możesz pozostawić pusty typ MIME.

  11. Aby użyć przycisku „Nowy” w interfejsie Dysku i poprosić użytkowników o utworzenie pliku w Twojej aplikacji, zaznacz pole Tworzenie plików. Pojawią się pola Nowy adres URL i opcjonalne pola Nazwa dokumentu.

    • Ten adres URL musi zawierać pełną i jednoznaczną nazwę domeny. localhost nie działa.
    • Zanim opublikujesz aplikację w Google Workspace Marketplace, musisz zweryfikować własność tego adresu URL.
    • Domyślnie do tego adresu URL jest dołączany parametr zapytania state, aby przekazywać do aplikacji dane z interfejsu Dysku. Informacje o zawartości parametru state znajdziesz w sekcji dotyczącej parametru state.

  12. Wpisz adres URL w polu Nowy adres URL. Ten adres URL jest używany przez przycisk „Nowy” w celu przekierowania 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 Twoja aplikacja musi zarządzać plikami na dyskach współdzielonych, zaznacz pole Obsługa dysków współdzielonych. Więcej informacji o obsłudze 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ć wyświetlanie aplikacji jako opcji w menu „Otwórz w” lub „Nowym”, poproś o integrację zakresu https://www.googleapis.com/auth/drive.install z interfejsem Dysku. Gdy poprosisz o ten zakres, użytkownicy zobaczą okno podobne do tego:

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

Więcej informacji o zakresach, o które możesz prosić w przypadku aplikacji Dysku, i o tym, jak o nie prosić, znajdziesz w artykule Informacje o autoryzacji i uwierzytelniania w przypadku interfejsów API.

Parametr state

Domyślnie parametr state jest dołączany zarówno do otwartego, jak i nowego adresu URL, aby przekazywać do aplikacji dane z interfejsu Dysku. Ten parametr zawiera zakodowany w formacie JSON ciąg znaków ze zmiennymi szablonu i danymi o żądaniu wysłanym do aplikacji. Uwzględnione zmienne zależą od typu użytego adresu URL (Otwórz lub Nowy URL):

Zmienna szablonu Opis Aplikacja URL
{ids} Rozdzielona przecinkami lista identyfikatorów plików, które chcesz otworzyć. Otwórz URL
{exportIds} Lista rozdzielonych przecinkami identyfikatorów eksportowanych plików (używana tylko podczas otwierania wbudowanych dokumentów Google). Otwórz URL
{resourceKeys} Słownik JSON z identyfikatorami plików zmapowanymi 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} Wykonywana czynność. Wartość to open w przypadku użycia opcji Otwórz adres URL lub create, gdy używasz nowego adresu URL. Otwórz URL i nowy URL

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

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

Informacja o polu state nowego adresu URL:

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

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

Informacje state dotyczące otwartego adresu URL:

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

Identyfikatory i klucze zasobów służą do pobierania metadanych pliku i zawartości pliku. 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 i otwierania działań uruchamianych z poziomu interfejsu Dysku oraz zarządzania nimi. Więcej informacji znajdziesz w artykule o integracji z przyciskiem „Nowy” w interfejsie Dysku lub w menu kontekstowym „Otwórz z” w interfejsie Dysku.