Konfigurowanie aplikacji w pakiecie SDK Google Workspace Marketplace

Na tej stronie dowiesz się, jak skonfigurować aplikację w pakiecie SDK Google Workspace Marketplace i zarządzać nią w Google Workspace Marketplace.

Aby udostępnić aplikację do użytku, musisz ją skonfigurować w pakiecie Marketplace SDK. Pakiet SDK Marketplace to zestaw narzędzi, który umożliwia tworzenie aplikacji w Marketplace i zarządzanie nią. Za pomocą pakietu Marketplace SDK możesz zarządzać ustawieniami platformy, takimi jak:

  • czy aplikacja jest dostępna dla konkretnej organizacji Google Workspace (aplikacja prywatna) czy dla wszystkich użytkowników Marketplace (aplikacja publiczna);
  • 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 utworzył aplikację i kto nią zarządza.

Niezależnie od tego, czy publikujesz aplikację prywatnie, czy publicznie, musisz używać pakietu Marketplace SDK do zarządzania aplikacją w Marketplace.

Włącz pakiet SDK Marketplace

Jeśli jeszcze tego nie zrobiono, w projekcie Google Cloud włącz pakiet SDK Marketplace.

Otwórz projekt w chmurze w konsoli Google Cloud

Jeśli nie jest jeszcze otwarty, otwórz projekt w chmurze, którego chcesz użyć w tym przykładzie:

  1. W konsoli Google Cloud otwórz stronę Wybierz projekt.

    Wybierz projekt w chmurze

  2. Wybierz projekt w chmurze Google, którego chcesz używać. Możesz też kliknąć Utwórz projekt i postępować zgodnie z instrukcjami wyświetlanymi na ekranie. Jeśli utworzysz projekt Google Cloud, może być konieczne włączenie płatności za ten projekt.

Włączanie pakietu SDK Marketplace

Zanim zaczniesz korzystać z interfejsów API Google, musisz je włączyć w projekcie w chmurze Google. W jednym projekcie Google Cloud możesz włączyć co najmniej 1 interfejs API.
  • W konsoli Google Cloud włącz pakiet SDK Google Workspace Marketplace.

    Włącz pakiet SDK

Określanie ustawień konfiguracji aplikacji

Poniższe informacje opisują ustawienia dostępne na stronie Konfiguracja aplikacji w pakiecie SDK Marketplace.

Wybierz, kto może wyświetlać i instalować Twoją aplikację

Podczas konfigurowania aplikacji określasz użytkowników, którzy mogą mieć do niej dostęp, za pomocą tych ustawień:

  • Widoczność aplikacji: jeśli publikujesz aplikację w organizacji Google Workspace, możesz określić, czy jej karta ma być niepubliczna, widoczna dla wszystkich użytkowników w organizacji czy dla wszystkich osób korzystających z Google Workspace.
  • Ustawienia instalacji: 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 odkrywania, instalowania ani używania aplikacji ze względu na ustawienia skonfigurowane przez administratorów. Administratorzy mogą wpływać na dostępność aplikacji w ten sposób:

  • Określać, czy użytkownicy mogą wyświetlać aplikacje w Marketplace i instalować je w ich imieniu.
  • Używać listy dozwolonych, aby zarządzać aplikacjami w organizacji i je wybierać. Jeśli tworzysz aplikację dla organizacji, która korzysta z list dozwolonych, skontaktuj się z administratorem i poproś o dodanie aplikacji do listy dozwolonych.
  • wyłączyć niektóre aplikacje Google Workspace, np. usunąć dostęp do Google Chat, aplikacji Google Chat lub obu tych usług; W takich przypadkach użytkownicy nie będą mogli zainstalować 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 organizację, w której pracujesz lub do której uczęszczasz). Jeśli używasz konta dla użytkowników indywidualnych (kończącego się na „@gmail.com”), możesz publikować tylko publicznie.

  • Publiczna: aplikację mogą znaleźć i zainstalować osoby spoza Twojej domeny. Jeśli wybierzesz widoczność publiczną, Google sprawdzi i zatwierdzi informacje o aplikacji przed ich opublikowaniem.
  • Prywatne: tylko osoby w Twojej domenie mogą znaleźć i zainstalować aplikację.

Jeśli zdecydujesz się opublikować aplikację jako niepubliczną, nie będzie ona widoczna w wynikach przeglądania ani wyszukiwania. 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, możesz to zrobić 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ę ze strony informacji o niej w sklepie w Marketplace.

  • Instalacja dowolnego użytkownika i administratora (domyślnie): aplikację mogą zainstalować użytkownicy lub administratorzy w domenie, jednostce organizacyjnej lub grupie użytkowników. Zasady domeny użytkownika mogą uniemożliwiać mu zainstalowanie aplikacji, nawet jeśli instalacje indywidualne są włączone.
  • Instalacja tylko przez administratora: aplikację mogą instalować tylko administratorzy w swojej domenie, jednostce organizacyjnej lub grupie użytkowników. Aplikacja będzie wyświetlana w wynikach wyszukiwania w Google Workspace Marketplace tylko administratorom i osobom, które nie są zalogowane na konto Google. Wybierz tę opcję, jeśli aplikacja wymaga instalacji domeny.

Typowe ustawienia instalacji i widoczności

W tabeli poniżej znajdziesz podsumowanie niektórych typowych opcji konfiguracji aplikacji dotyczących instalacji i widoczności:

Docelowi użytkownicy aplikacji Ustawienie Widoczność aplikacji Ustawienie Instalacja aplikacji Kto może zainstalować moją aplikację? Kto może korzystać z mojej aplikacji?
W przypadku aplikacji stworzonych dla organizacji korzystającej z Google Workspace  
określeni użytkownicy w Twojej organizacji; Prywatny i Niepubliczny Instalacja dowolnego użytkownika i administratora Jeśli jest to dozwolone, każda osoba w Twojej organizacji, która ma adres URL strony aplikacji. Jeśli jest to dozwolone, każda osoba w Twojej organizacji, która ma adres URL strony aplikacji.
Twojej organizacji, Prywatne Instalacja dowolnego użytkownika i administratora 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ą aplikację zainstalowaną przez administratora.
W przypadku aplikacji dostępnych dla użytkowników spoza określonej organizacji Google Workspace  
Użytkownicy w organizacjach Google Workspace Publiczny Tylko administrator Administratorzy Użytkownicy, którzy mają aplikację zainstalowaną przez administratora.
Wszyscy użytkownicy Google Workspace Publiczny Instalacja dowolnego użytkownika i administratora
  • Każda osoba, która korzysta z aplikacji Google Workspace do użytku osobistego.
  • Jeśli jest to dozwolone, użytkownicy z organizacji Google Workspace.
  • Każda osoba, która korzysta z aplikacji Google Workspace do użytku osobistego.
  • Jeśli jest to dozwolone, użytkownicy z organizacji Google Workspace.

Określanie sposobu integracji aplikacji z aplikacjami Google Workspace

Opcja Integracje aplikacji umożliwia wybór usług Google Workspace, z którymi Twoja aplikacja lub Twój dodatek ma działać, np. dodatku do Google Workspace lub aplikacji do Google Chat. Musisz wybrać co najmniej 1 opcję. W niektórych przypadkach w informacjach o aplikacji możesz uwzględnić kilka integracji aplikacji. Zobacz Listę integracji aplikacji.

W przypadku każdego dodatku do Google Workspace na stronie wyświetlany jest stan publikacji dla każdego obsługiwanego produktu hosta. Dzięki temu dowiesz się, które integracje są dostępne dla Twoich użytkowników. Możliwe stany integracji aplikacji:

  • Unsaved: dodano lub zmodyfikowano integrację, ale zmiany nie zostały zapisane na karcie Konfiguracja aplikacji.
  • Draft: zmiany zostały zapisane, ale nie zostały opublikowane.
  • Under review: przesłano zaktualizowaną integrację aplikacji do sprawdzenia.
  • Published: integracja aplikacji jest uwzględniona w informacjach w Marketplace.

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 opisujemy dodatkowe ustawienia wymagane w przypadku poszczególnych opcji:

Dodatek do Google Workspace

Aby opublikować dodatek do Google Workspace, musisz podać identyfikator wdrożenia dodatku.

Aby znaleźć identyfikator wdrożenia w Apps Script:

  1. Otwórz dodatek do Google Workspace w edytorze Apps Script.
  2. Kliknij Wdróż> Zarządzaj wdrożeniami.
  3. Pod identyfikatorem wdrożenia kliknij Kopiuj.

Aby znaleźć identyfikator wdrożenia dodatku HTTP, wykonaj te czynności:

  1. Na stronie Konfiguracja aplikacji w sekcji „Dodatek do Google Workspace” kliknij Wdrożenia HTTP lub inne> Wybierz wdrożenie.
  2. Wybierz wdrożenie, które chcesz opublikować.
  3. Kliknij Wybierz.

Dodatek do edytora (Dokumenty, Arkusze, Prezentacje, Formularze)

Aby opublikować dodatek do Edytora, musisz podać identyfikator skryptu projektuwersję, którą chcesz opublikować.

Aby znaleźć identyfikator skryptu projektu, wykonaj te czynności:

  1. Otwórz dodatek w edytorze skryptów Apps Script.
  2. Po lewej stronie kliknij Ustawienia projektu .
  3. W sekcji „Identyfikatory” skopiuj identyfikator skryptu.

Aby sprawdzić wersję, wykonaj te czynności:

  1. Otwórz dodatek w edytorze skryptów Apps Script.
  2. W prawym górnym rogu kliknij Wdróż> Zarządzaj wdrożeniami.
  3. Numer wersji jest widoczny w sekcji „Konfiguracja”.

Aplikacja Google Chat

Aby opublikować interaktywną aplikację Google Chat, zapoznaj się z tą dokumentacją:

Aplikacja Dysku

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, który prowadzi do aplikacji internetowej z menu aplikacji Google . Twoja aplikacja internetowa musi być w wersji produkcyjnej i w pełni funkcjonalna.

Wypełniając stronę z informacjami o aplikacji, musisz podać dodatkowe ikony o rozmiarach 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:

  1. Otwórz dodatek do Google Workspace w edytorze Apps Script.
  2. Kliknij Wdróż> Nowe wdrożenie.
  3. W sekcji „Wybierz typ” kliknij Aplikacja internetowa.
  4. Wypełnij opcje i kliknij Wdróż.
  5. Kliknij Kopiuj.

Określ poziom dostępu wymagany przez aplikację

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 zakresami wyświetlanymi na ekranie zgody OAuth i w manifeście Apps Script (jeśli dotyczy).

Jeśli uwzględniasz więcej niż 1 integrację aplikacji, dodaj zakresy z każdej z nich na stronie konfiguracji aplikacji w pakiecie SDK Marketplace i na ekranie zgody OAuth.

Zawsze używaj jak najwęższych zakresów (np. nie uwzględniaj pełnego zakresu Dysku, jeśli potrzebujesz tylko zakresu tylko do odczytu).

Więcej informacji o projektach Apps Script znajdziesz w artykule Zakresy autoryzacji.

Podawanie informacji o deweloperze aplikacji

W sekcji Informacje o deweloperze podaj informacje kontaktowe i inne dane. Te pola pojawiają się na stronie informacji o aplikacji.

Pola
Status przedsiębiorcy

Ze względu na przepisy dotyczące ochrony konsumentów musimy informować konsumentów z Europejskiego Obszaru Gospodarczego, czy sprzedawcy na platformie handlowej są przedsiębiorcami czy osobami niebędącymi przedsiębiorcami:

  • Przedsiębiorca: przedsiębiorca to osoba, która działa w celach związanych z działalnością handlową, gospodarczą, rzemieślniczą lub wykonywanym zawodem, albo w imieniu lub na rzecz przedsiębiorcy.
  • Osoba niebędąca przedsiębiorcą: osoba niebędąca przedsiębiorcą (konsument) to osoba, która działa w celach niezwiązanych z działalnością zawodową.

Jeśli nie podasz tej informacji, na stronie informacji o aplikacji pojawi się komunikat „Status sprzedawcy nieokreślony”.

Nazwa dewelopera Nazwa, która będzie wyświetlana jako autor aplikacji. Jeśli jesteś przedsiębiorcą, podaj nazwę handlową lub imię i nazwisko.
Adres pocztowy dewelopera

Wymagane w przypadku sprzedawcó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ć.

Adres URL witryny dewelopera Witryna, w której Ty (lub Twoja organizacja) jesteś opisany(-a) jako deweloper.
Adres e-mail dewelopera

Adres e-mail, który będzie używany jako punkt kontaktowy. Nie jest ona uwzględniona w informacjach o aplikacji. Upewnij się, że ten adres e-mail jest aktualny, ponieważ jest on używany:

  • Jeśli Google musi skontaktować się z deweloperem, np. podczas procesu weryfikacji aplikacji.
  • Wysyłanie opinii z dodatków do Edytora, jeśli na stronie informacji w sklepie nie podano adresu URL zgłoszenia problemu.
Adres URL witryny aplikacji Opcjonalnie. Witryna, która zawiera więcej informacji o aplikacji.

Zapisywanie ustawień konfiguracji aplikacji w pakiecie SDK Marketplace

Korzystając z informacji z poprzedniej sekcji, zapisz konfigurację aplikacji w pakiecie SDK Marketplace:

  1. W konsoli Google Cloud otwórz stronę Marketplace SDK – Konfiguracja aplikacji:

    Otwórz stronę konfiguracji pakietu SDK Marketplace

  2. Wypełnij każdą sekcję na podstawie informacji określonych w poprzedniej sekcji.

  3. Kliknij Zapisz wersję roboczą.

  4. (Opcjonalnie) Możesz uzyskać dane analityczne dotyczące korzystania z aplikacjiGoogle Analytics. Aby to zrobić, dodaj identyfikator Google Analytics w pakiecie SDK Marketplace.

    1. Otwórz kartę Statystyki.
    2. Wpisz swój identyfikator Google Analytics.
    3. 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 i wyświetla się ten 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 Marketplace SDK API jest włączony i używasz roli IAM innej niż Editor lub Owner.

Aby rozwiązać ten problem, zastosuj jedno z tych rozwiązań:

  • Poproś właściciela projektu o przypisanie roli roles/appmetadata.workspaceMarketplaceAppConfigurationAdmin do konta, na którym brakuje uprawnień, aby umożliwić mu konfigurowanie aplikacji i zarządzanie nią w pakiecie SDK Marketplace.

  • Poproś właściciela projektu o dodanie brakujących uprawnień do roli niestandardowej na stronie Administracja > Role w konsoli Google Cloud. Następnie przypisz rolę niestandardową do konta, na którym brakuje uprawnień.

  • Do publikowania aplikacji można używać elementów pierwotnych roles/editor lub roles/owner. Dokumentacja Bezpieczne korzystanie z IAM uznaje to za złą praktykę, ponieważ nie można łatwo ograniczyć dostępu do edycji innych zasobów w projekcie.