Konfigurowanie integracji interfejsu Dysku

Aby wyświetlić aplikację na Dysku Google, gdy użytkownik utworzy lub otworzy plik: musi najpierw skonfigurować integrację z interfejsem użytkownika Dysku. Konfiguracja jest też wymagana do umieszczenia aplikacji w Google Workspace Marketplace

Włączanie interfejsu Drive API

Zanim zaczniesz korzystać z interfejsów API Google, musisz je włączyć w Google Cloud w projektach AI. W jednym Google Cloud możesz włączyć jeden lub więcej interfejsów API w projektach AI.

Aby rozpocząć integrację z interfejsem Dysku Google, musisz włączyć API Dysku. Daje to dostęp do interfejsu API i integracji z interfejsem użytkownika funkcje zabezpieczeń.

Skonfiguruj integrację z interfejsem użytkownika Dysku

  1. W konsoli interfejsów API Google otwórz Menu . > Interfejsy API i Usługi > Włączone interfejsy API i usług.

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

  2. Na dole sekcji Interfejsy API W panelu usług kliknij Google Drive API. Pojawi się strona konfiguracji interfejsu Google Drive API.
  3. Wybierz kartę Integracja z interfejsem Dysku.
  4. (Opcjonalnie) Wpisz nazwę w polu Nazwa aplikacji. Aplikacja nazwa jest wyświetlana użytkownikom na karcie Zarządzaj aplikacjami na Dysku ustawieniach.
  5. (Opcjonalnie) Wpisz krótki, jednowierszowy opis w polu Krótki opis . Krótki opis jest wyświetlany na karcie Zarządzaj aplikacjami w Ustawienia Dysku.
  6. (Opcjonalnie) W polu Długi opis wpisz pełny opis.
  7. Prześlij co najmniej jedną ikonę aplikacji, która będzie wyświetlana na liście użytkowników połączonych aplikacji Dysku oraz w sekcji „Otwórz w” w menu kontekstowym. Ikony powinny być w formacie PNG i mieć przezroczyste tło. Ikony można przetrwać do 24 godzin na pojawienie się na Dysku.

  8. Korzystanie z funkcji „Otwórz w” w interfejsie Dysku menu item, wpisz adres URL aplikacji w polu Pole Otwórz URL. Ten adres URL jest używany przez regułę „Otwórz za pomocą” w menu kontekstowym.

    • Ten adres URL musi zawierać w pełni kwalifikowaną nazwę domeny. localhost nie w naszej pracy.
    • Ten URL powinien być dostępny dla odpowiednich użytkowników aplikacji. Jeśli masz wiele wersji aplikacji, na przykład jedną wersję publiczną wersji i drugiej przeznaczonej tylko dla wybranych użytkowników. powinien używać unikalnego adresu URL. Dzięki temu możesz utworzyć inną aplikację, konfiguracji w każdej wersji.
    • Musisz potwierdź własność tego adresu URL , zanim udostępnisz aplikację w Google Workspace Marketplace.
    • Domyślnie parametr zapytania state jest dołączany do tego adresu URL, aby przekazywać z interfejsu Dysku do aplikacji. Informacje na temat: zawartości parametru state znajdziesz tutaj: state .
  9. (Opcjonalnie) Wpisz domyślne typy MIME i rozszerzenia plików w polu Pola Domyślne typy MIME i Domyślne rozszerzenia plików. Domyślne MIME typy i rozszerzenia plików reprezentują pliki, dla których została utworzona aplikacja otwartego. Na przykład aplikacja może otworzyć wbudowany format do warstw edytowanie obrazów. Uwzględnij tylko standardowe multimedia i sprawdzać, czy nie ma w nich literówek ani błędów. Jeśli aplikacja otwiera się tylko plików skrótów innych firm, możesz zostawić pole typu MIME puste.

  10. (Opcjonalnie) Wpisz dodatkowe typy MIME i rozszerzenia plików w polu Dodatkowe Typy MIME i Dodatkowe rozszerzenia plików. Dodatkowe typy MIME i rozszerzenia plików wskazują pliki, które aplikacja może otwierać, ale nie są określone do Twojej aplikacji. Może to być np. aplikacja do edytowania obrazów, która otwiera się Obrazy w formatach PNG i JPG. Uwzględnij tylko standardowe multimedia i sprawdzać, czy nie ma w nich literówek ani błędów. Jeśli aplikacja otwiera się tylko plików skrótów innych firm, możesz zostawić pole typu MIME puste.

  11. Aby użyć nowej wersji interfejsu Dysku i poproś użytkowników o utworzenie pliku Twojej aplikacji, zaznacz pole Tworzenie plików. pola Nowy adres URL i opcjonalnie Pojawią się pola Nazwa dokumentu.

    • Ten adres URL musi zawierać w pełni kwalifikowaną nazwę domeny. localhost nie w naszej pracy.
    • Musisz potwierdzić, że jesteś właścicielem Adres URL , zanim udostępnisz aplikację w Google Workspace Marketplace.
    • Domyślnie parametr zapytania state jest dołączany do tego adresu URL, aby przekazywać z interfejsu Dysku do aplikacji. Informacje na temat: zawartości parametru state znajdziesz tutaj: state .
  12. Wpisz adres URL w polu Nowy adres URL. Ten URL jest używany przez sekcję „Nowy” przycisk aby przekierować użytkownika do Twojej aplikacji.

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

  14. (Opcjonalnie) Jeśli Twoja aplikacja musi zarządzać plikami na dyskach współdzielonych, sprawdź Pole Obsługa dysków współdzielonych. Aby uzyskać więcej informacji o wsparciu dyski współdzielone w aplikacji – przeczytaj artykuł Wdrażanie dysku współdzielonego pomocy.

  15. Kliknij Prześlij.

Poproś o zakres drive.install

Aby aplikacje pojawiały się jako opcja w oknie „Otwórz w” lub „Nowy” menu, poproś o zakres https://www.googleapis.com/auth/drive.install, aby przeprowadzić integrację za pomocą interfejsu Dysku. Po wysłaniu żądania dotyczącego tego zakresu użytkownicy otrzymają wiadomość 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 Dysku, i o tym, jak o nie prosić, zawiera artykuł na temat autoryzacji i uwierzytelniania dla interfejsu API informacje.

Parametr state

Domyślnie parametr state jest dołączany zarówno do otwartego, jak i nowego adresu URL. na przekazywanie danych z interfejsu Dysku do aplikacji. Ten parametr zawiera ciąg zakodowany w formacie JSON ze zmiennymi szablonu i danymi o do Twojej aplikacji. Uwzględnione zmienne zależą od typu użytego adresu URL (otwarta Adres URL lub nowy adres URL):

Zmienna szablonu Opis Zastosowanie adresu URL
{ids} Rozdzielona przecinkami lista otwieranych identyfikatorów plików. Otwórz URL
{exportIds} Rozdzielona przecinkami lista eksportowanych identyfikatorów plików (tylko używana) podczas otwierania wbudowanych dokumentów Google). Otwórz URL
{resourceKeys} Słownik JSON z identyfikatorami plików zmapowanymi na odpowiednie zasoby klawiszy. 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 otwartego adresu URL lub create jeśli 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ć zmianę znaczenia i przeanalizuj go jako JSON. Aplikacje mogą wykryć wartość create w state, aby zweryfikować żądanie utworzenia pliku.

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

Informacje state dla nowego adresu URL:

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

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

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 pobierania pliku treści. Gdy aplikacja ma identyfikator pliku i token dostępu, może sprawdzić, uprawnień, pobierania metadanych pliku oraz pobierania jego zawartości zgodnie z opisem. w metodzie files.get.

Zainstalowana aplikacja musi mieć możliwość tworzenia i otwierania działań uruchamianych za pomocą w interfejsie Dysku. Więcej informacji znajdziesz w sekcji Integracja z usługą Nowy wygląd interfejsu Dysku lub Integracja z opcją „Otwórz w” w interfejsie Dysku kontekst