Na tej stronie dowiesz się, jak za pomocą pakietu SDK Google Workspace Marketplace skonfigurować aplikację i zarządzać nią w Google Workspace Marketplace.
Aby udostępnić aplikację, musisz ją skonfigurować w pakiecie SDK Marketplace. Pakiet SDK Marketplace to zestaw narzędzi, który umożliwia tworzenie aplikacji w Marketplace i nad nimi zarządzanie. Za pomocą pakietu Marketplace SDK możesz zarządzać ustawieniami Marketplace, takimi jak:
- czy aplikacja jest dostępna dla konkretnej organizacji Google Workspace (prywatna aplikacja) czy dla wszystkich użytkowników Marketplace (publiczna aplikacja).
- Typy użytkowników Marketplace, którzy mogą zainstalować Twoją aplikację
- z którymi aplikacjami Google Workspace integruje się Twoja aplikacja;
- Zakresy protokołu OAuth, których wymaga Twoja aplikacja
- informacje o tym, kto stworzył aplikację i kto ją obsługuje;
Niezależnie od tego, czy publikujesz aplikację prywatnie, czy publicznie, musisz zarządzać nią w Marketplace za pomocą pakietu SDK Marketplace.
Włączanie pakietu SDK Marketplace
Jeśli nie masz jeszcze włączonego pakietu Marketplace SDK, zrób to w projekcie Google Cloud.
Otwieranie projektu Cloud w konsoli Google Cloud
Jeśli nie jest jeszcze otwarty, otwórz projekt Cloud, którego chcesz użyć w przypadku tego przykładu:
- W konsoli Google Cloud otwórz stronę Wybierz projekt.
- Wybierz projekt Google Cloud, którego chcesz użyć. Możesz też kliknąć Utwórz projekt i postępować zgodnie z instrukcjami wyświetlanymi na ekranie. Jeśli utworzysz projekt Google Cloud, konieczne może być włączenie płatności.
Włączanie pakietu SDK Marketplace
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.W konsoli Google Cloud włącz pakiet SDK Google Workspace Marketplace.
Określanie ustawień konfiguracji aplikacji
W tym dokumencie znajdziesz opis ustawień dostępnych na stronie Konfiguracja aplikacji w pakiecie SDK Marketplace.
Wybierz, kto może wyświetlać i instalować Twoją aplikację
Podczas konfigurowania aplikacji określasz, którzy użytkownicy mogą uzyskać do niej dostęp, korzystając z tych ustawień:
- Widoczność aplikacji: jeśli publikujesz aplikację w organizacji Google Workspace, określ, czy jej strona ma być niewidoczna, widoczna dla wszystkich użytkowników w organizacji czy dla każdego, kto korzysta z Google Workspace.
- Ustawienia instalacji: określają, czy aplikację mogą instalować tylko administratorzy Google Workspace.
Niezależnie od ustawień określonych w informacjach o aplikacji użytkownicy należący do organizacji Google Workspace mogą nie mieć możliwości znalezienia, zainstalowania ani używania Twojej aplikacji ze względu na ustawienia określone przez ich administratorów. Administratorzy mogą wpływać na dostępność aplikacji w następujące sposoby:
- określać, czy użytkownicy mogą wyświetlać aplikacje w Marketplace, oraz instalować aplikacje w imieniu swoich użytkowników.
- Za pomocą listy dozwolonych aplikacji zarządzają aplikacjami w organizacji. Jeśli tworzysz aplikację dla organizacji, która korzysta z list dozwolonych, skontaktuj się z jej administratorem i poproś o dodanie aplikacji do listy dozwolonych.
- wyłączyć niektóre aplikacje Google Workspace, np. przez usunięcie dostępu do Google Chat lub aplikacji Google Chat; W takich przypadkach użytkownicy nie będą mogli zainstalować Twojej aplikacji z Marketplace.
Aby dowiedzieć się, jak administratorzy zarządzają dostępem do Marketplace, zapoznaj się z dokumentacją pomocy dla administratorów Marketplace.
Ustawienia widoczności aplikacji
Opcja Widoczność aplikacji jest widoczna, jeśli używasz konta Google Workspace (konta utworzonego przez Twoją organizację lub szkołę). Jeśli używasz konta dla użytkowników indywidualnych (konta kończącego się na „@gmail.com”), możesz publikować tylko publicznie.
- Publiczne: aplikację mogą znaleźć i zainstalować osoby spoza Twojej domeny. Jeśli wybierzesz widoczność publiczną, Google sprawdzi i zatwierdzi informacje o aplikacji przed jej opublikowaniem.
- Prywatne: aplikację mogą znaleźć i zainstalować tylko osoby z Twojej domeny.
Jeśli zdecydujesz się opublikować aplikację jako niepubliczną, jej strona nie będzie widoczna w wynikach wyszukiwania ani w wynikach przeglądania. Użytkownicy mogą uzyskać dostęp do strony aplikacji w sklepie tylko za pomocą bezpośredniego adresu URL.
Jeśli chcesz ograniczyć dostępność aplikacji do określonych krajów i regionów, skonfiguruj to w sekcji Dystrybucja podczas tworzenia strony aplikacji w sklepie.
Ustawienia instalacji aplikacji
Opcja Ustawienia instalacji określa, czy użytkownicy lub administratorzy Google Workspace mogą zainstalować Twoją aplikację z strony z informacjami o aplikacji w Google Workspace Marketplace.
.- Instalacja indywidualna i administratora (domyślnie): aplikację mogą instalować zarówno użytkownicy, jak i administratorzy w domenie, jednostce organizacyjnej lub grupie użytkowników. Zasady dotyczące domeny użytkownika mogą uniemożliwić mu zainstalowanie aplikacji, nawet jeśli indywidualne instalacje są włączone.
- Instalacja tylko przez administratora: aplikację mogą instalować tylko administratorzy w domenie, jednostce organizacyjnej lub grupie użytkowników. Twoja aplikacja wyświetla się w wynikach wyszukiwania Google Workspace Marketplace tylko dla administratorów i osób, które nie są zalogowane na swoje konta Google. Wybierz tę opcję, jeśli aplikacja wymaga instalacji w domenie.
Typowe ustawienia instalacji i widoczności
W tabeli poniżej znajdziesz podsumowanie niektórych najczęstszych opcji konfiguracji aplikacji dotyczących instalacji i widoczności:
| Docelowi użytkownicy aplikacji | Ustawienie Widoczność aplikacji | Ustawienie Instalacja aplikacji | Kto może instalować moją aplikację? | Kto może korzystać z mojej aplikacji? | |
|---|---|---|---|---|---|
| Aplikacje tworzone dla organizacji Google Workspace | |||||
| określeni użytkownicy w Twojej organizacji; | Prywatne i Niepubliczne | Instalacja indywidualna i administracyjna | Jeśli zezwolisz na to, każda osoba w Twojej organizacji, która ma URL strony aplikacji, będzie mogła ją otworzyć. | Jeśli jest to dozwolone, każda osoba w Twojej organizacji, która ma URL strony aplikacji. | |
| Twojej organizacji, | Prywatne | Instalacja indywidualna i administracyjna | Jeśli jest to dozwolone, każda osoba w organizacji. | Jeśli jest to dozwolone, każda osoba w organizacji. | |
| Twojej organizacji, | Prywatne | Tylko administrator | Administratorzy | Użytkownicy, którzy mają zainstalowaną aplikację zainstalowaną przez administratora. | |
| Aplikacje dostępne dla użytkowników spoza konkretnej organizacji Google Workspace | |||||
| Użytkownicy w organizacjach Google Workspace | Publiczny | Tylko administrator | Administratorzy | Użytkownicy, którzy mają zainstalowaną aplikację zainstalowaną przez administratora. | |
| Wszyscy użytkownicy Google Workspace | Publiczny | Instalacja indywidualna i administracyjna |
|
|
|
Sprawdzanie, jak aplikacja integruje się z aplikacjami Google Workspace
Wybierz usługi Google Workspace, w których Twoja aplikacja lub Twój dodatek ma działać, np. dodatek Google Workspace lub aplikacja Google Chat. Musisz wybrać co najmniej jedną opcję. W niektórych przypadkach możesz uwzględnić w informacjach o aplikacji kilka integracji. Zobacz artykuł Lista integracji aplikacji.
W zależności od wybranych integracji aplikacji może być konieczne podanie dodatkowych informacji i włączenie odpowiednich interfejsów API w projekcie Google Cloud. W tabeli poniżej znajdziesz opis dodatkowych ustawień wymaganych w przypadku każdego z tych modeli:
Dodatek do Google Workspace (Apps Script)
Aby opublikować dodatek Google Workspace, musisz podać jego identyfikator wdrożenia. Aby znaleźć identyfikator wdrożenia:
- Otwórz dodatek Google Workspace w edytorze Apps Script.
- Kliknij Wdróż> Zarządzaj wdrożeniami.
- Pod identyfikatorem wdrożenia kliknij Kopiuj.
Dodatek do Google Workspace (wdrożenia HTTP)
Jeśli Twój dodatek do Google Workspace został utworzony przy użyciu punktów końcowych HTTP, wykonaj te czynności, aby uzyskać identyfikator wdrożenia z zasobu wdrożenia Google Cloud.
- Na stronie Konfiguracja aplikacji w sekcji „Google Workspace add-on” kliknij HTTP lub inne wdrożenia > Wybierz wdrożenie.
- Wybierz wdrożenie, które chcesz opublikować.
- Kliknij Wybierz.
Dodatek do edytora (Dokumenty, Arkusze, Prezentacje, Formularze)
Aby opublikować dodatek do Edytora, musisz podać identyfikator skryptu projektu i wersję, którą chcesz opublikować.
Aby znaleźć identyfikator skryptu projektu:
- Otwórz dodatek w edytorze Apps Script.
- Po lewej stronie kliknij Ustawienia projektu .
- W sekcji „Identyfikatory” skopiuj identyfikator skryptu.
Aby znaleźć wersję, wykonaj te czynności:
- Otwórz dodatek w edytorze Apps Script.
- W prawym górnym rogu kliknij Wdróż> Zarządzaj wdrożeniami.
- Numer wersji znajduje się w sekcji „Konfiguracja”.
Aplikacja Google Chat
Aby opublikować aplikację Google Chat, musisz skonfigurować interfejs Google Chat API. Zobacz publikowanie aplikacji Google Chat.
Aplikacja Dysk
Aby opublikować aplikację na Dysku, musisz włączyć i skonfigurować interfejs Google Drive API.
Aplikacja internetowa
Aby opublikować aplikację internetową, musisz podać jej uniwersalny adres URL nawigacji, czyli adres URL wskazujący na aplikację internetową w menu aplikacji Google . Aplikacja internetowa musi być w wersji produkcyjnej i w pełni funkcjonalna.
Podczas wypełniania strony z informacjami o aplikacji musisz przesłać dodatkowe ikony o wymiarach 96 x 96 i 48 x 48 pikseli.
Jeśli aplikacja internetowa została utworzona w Apps Script, wykonaj te czynności, aby uzyskać uniwersalny adres URL nawigacji:
- Otwórz dodatek Google Workspace w edytorze Apps Script.
- Kliknij Wdróż > Nowe wdrożenie.
- W sekcji „Wybierz typ” kliknij Aplikacja internetowa.
- Wypełnij opcje i kliknij Wdróż.
- Kliknij Kopiuj.
Określ poziom dostępu, którego wymaga Twoja aplikacja
W sekcji Zakresy OAuth podaj pełną listę zakresów OAuth 2.0, których wymaga Twoja aplikacja. Zakresy OAuth, które tu wpiszesz, powinny być zgodne z tymi, które wyświetlasz na ekranie zgody OAuth i (w odpowiednich przypadkach) w manifeście Apps Script.
Jeśli używasz więcej niż 1 integracji aplikacji, dodaj zakresy każdej z nich na stronie konfiguracji pakietu SDK Marketplace i na ekranie zgody OAuth.
Zawsze używaj jak najmniejszych zakresów (np. nie uwzględniaj pełnego zakresu Drive, jeśli potrzebujesz tylko dostępu tylko do odczytu).
Więcej informacji o projektach Apps Script znajdziesz w sekcji Zakresy autoryzacji.
Podawanie informacji o deweloperze aplikacji
W sekcji Informacje o deweloperze podaj dane kontaktowe i inne informacje. Te pola są widoczne na stronie aplikacji w sklepie.
| Pola | |
|---|---|
| Stan przedsiębiorcy |
Ze względu na przepisy dotyczące ochrony konsumentów musimy informować konsumentów z Europejskiego Obszaru Gospodarczego, czy sprzedawca na platformie handlowej jest przedsiębiorcą, czy nie jest:
Jeśli nie podasz informacji o stanie, na stronie aplikacji będzie widoczna informacja „Stan przedsiębiorcy nieokreślony”. |
| Nazwa dewelopera | Nazwa wyświetlana jako autora aplikacji. Jeśli jesteś sprzedawcą, podaj nazwę handlową lub nazwę prawną. |
| Adres pocztowy dewelopera |
Wymagany w przypadku traderów. Nie są zbierane w przypadku osób niebędących przedsiębiorcami. Lokalizacja Twojej firmy. Wpisz prawidłowy adres pocztowy, pod którym można się z Tobą skontaktować. |
| URL witryny dewelopera | witryna, która przedstawia Cię (lub Twoją organizację) jako dewelopera; |
| E-mail dla dewelopera |
Adres e-mail, który będzie używany jako punkt kontaktowy. nie jest uwzględniona na stronie aplikacji; Upewnij się, że ten adres e-mail jest aktualny, ponieważ jest używany:
|
| Adres URL witryny aplikacji | Opcjonalnie: Witryna internetowa, która zawiera więcej informacji o Twojej aplikacji. |
Zapisywanie ustawień konfiguracji aplikacji w pakiecie SDK Marketplace
Korzystając z informacji z poprzedniej sekcji, zapisz konfigurację aplikacji w pakiecie SDK Marketplace:
W konsoli Google Cloud otwórz stronę Konfiguracja platformy programistycznej Marketplace SDK:
Wypełnij każdą sekcję na podstawie informacji podanych w poprzedniej sekcji.
Kliknij Zapisz.
(Opcjonalnie) W Google Analytics możesz uzyskać dane analityczne o użytkowaniu aplikacji. Aby to zrobić, dodaj identyfikator Google Analytics w pakiecie SDK Marketplace.
- Otwórz kartę Statystyki.
- Wpisz identyfikator Google Analytics.
- Kliknij Zapisz.
Rozwiązywanie problemów
W tej sekcji opisujemy typowe problemy, które mogą wystąpić.
Brak wymaganych uprawnień podczas publikowania aplikacji w Marketplace
Nie możesz publikować aplikacji w Marketplace, ponieważ próby skonfigurowania aplikacji na stronie Konfiguracja aplikacji w pakiecie SDK Marketplace kończą się niepowodzeniem z tego powodu, że pojawia się komunikat o błędzie:
You are missing at least one of the following required permissions: Project workspacemarketplace.appconfiguration.view / workspacemarketplace.appconfiguration.update
Ten błąd występuje, gdy interfejs API Marketplace SDK jest włączony i używana jest rola IAM inna niż Editor lub Owner.
Aby rozwiązać ten problem, zastosuj jedno z tych rozwiązań:
Poproś właściciela projektu o dodanie brakujących uprawnień do roli niestandardowej na stronie Uprawnienia > Role w konsoli Google Cloud. Następnie przypisz do konta rolę niestandardową z brakującymi uprawnieniami.
Do publikowania aplikacji można używać typu prymitywnego
roles/editorlubroles/owner. Jednak dokumentacja Bezpieczne korzystanie z IAM wskazuje, że jest to zła praktyka, ponieważ nie można łatwo ograniczyć dostępu do edycji innych zasobów w projekcie.