Wymagania dotyczące oprogramowania sprzęgającego partnera

Zapoznaj się z przeglądem publikowanych zmian, aby poznać korzyści i wymagany poziom zaangażowania w publikowanie oprogramowania sprzęgającego. Aby opublikować oprogramowanie sprzęgające partnera, musi ono spełniać wszystkie wymagania opisane poniżej.

Google Apps Script

Przed przesłaniem łącznika do sprawdzenia wykonaj w Apps Script te czynności:

  1. Udostępnij uprawnienia do wyświetlania projektu Apps Script tym osobom:
  2. Utwórz wdrożenie o nazwie Production i zaktualizuj Production wdrożenie do wersji kodu, którą chcesz opublikować.
  3. Sprawdź, czy wdrożenie Production zostało zaktualizowane do wersji kodu, którą chcesz sprawdzić.
  4. Sprawdź, czy plik manifestu jest widoczny w Apps Script. Po lewej stronie kliknij Ustawienia projektu . Zaznacz pole wyboru Wyświetlaj plik manifestu „appsscript.json” w edytorze.

Plik manifestu

W pliku manifestu konektora umieść te elementy i upewnij się, że projekt Apps Script jest skonfigurowany tak, aby w edytorze wyświetlać appsscript.json plik manifestu.

Więcej informacji znajdziesz w dokumentacji manifestu społecznościowego oprogramowania sprzęgającego.

dataStudio

  1. description powinien zawierać informacje i instrukcje, które pozwolą użytkownikom zrozumieć podstawy działania złącza i sposób jego używania. Złącza z niejasnymi i niekompletnymi opisami zostaną odrzucone.
  2. addOnUrl powinna być dedykowaną stroną hostowaną zawierającą informacje o Twoim oprogramowaniu sprzęgającym, najlepiej hostowaną w Twojej domenie. Strona musi zawierać:
    • Polityka prywatności i Warunki korzystania z usługi lub link do tych treści w tej samej domenie co addOnUrl.
    • Szczegóły, które użytkownik musi znać, aby korzystać z konektora.
    • Link do rejestracji, jeśli do korzystania z konektora wymagane jest konto.
    • treści hostowane najlepiej w Twojej domenie; Hosting na platformie https://sites.google.com/ jest niedozwolony.
    • Zobacz przykładowe strony obecnych partnerów: Funnel, Supermetrics, CallRail.
  3. supportUrl powinna być stroną hostowaną, aby uzyskać pomoc dotyczącą łącznika. Nie może to być adres e-mail ani link mailto.
  4. logoUrl powinien wskazywać obraz statyczny hostowany pod Twoją kontrolą. Nie możesz używać obrazów udostępnianych przez usługi Google w domenach takich jak *.gstatic.com, *.ggpht.com, *.google.com, *.googleusercontent.com. Używanie Google Cloud Storage do wyświetlania obrazów z domeny *.googleapis.com jest dopuszczalne i jest zalecaną opcją hostingu.
    • Oprogramowanie sprzęgające z animowanymi ikonami zostanie odrzucone. Używaj obrazów statycznych.
    • Zalecamy użycie obrazu o wymiarach co najmniej 48 x 48 pikseli.
    • Unikaj obrazów zawierających tylko tekst, które są trudne do odczytania po zmniejszeniu do rozmiaru 48 x 48 pikseli.
  5. Wypełnij usługę sources wszystkimi źródłami, z którymi łączy się Twój konektor. Więcej informacji znajdziesz w sekcji Źródła w dokumentacji pliku manifestu.
    • Obecną listę źródeł możesz wyświetlić w repozytorium rejestru danych. Jeśli źródło, z którym chcesz się połączyć, nie istnieje w repozytorium, wyślij żądanie pull do repozytorium rejestru danych, aby dodać to źródło. Jeśli źródła w pliku manifestu nie będą istnieć w repozytorium, Twój konektor nie przejdzie procesu weryfikacji.
    • Są to dodatkowe metadane oprogramowania sprzęgającego, które będą indeksowane na potrzeby funkcji wyszukiwania w galerii. Twój łącznik będzie się wyświetlać w wynikach wyszukiwania, gdy użytkownicy będą szukać w galerii konkretnego źródła.
  6. Podaj wartości dla shortDescription, authType, feeType, privacyPolicyUrl i termsOfServiceUrl.
  7. name powinna bezpośrednio odzwierciedlać cel złącza. Jasna nazwa pomoże użytkownikom określić, czy Twój łącznik spełnia ich potrzeby. Unikaj używania w nazwie słowa connector, ponieważ użytkownicy wiedzą, że mają do czynienia z oprogramowaniem sprzęgającym.
    • Nie używaj znaków specjalnych ani niewidocznych, aby zwrócić uwagę na łącznik lub potencjalnie zmienić jego pozycję.
  8. Nie używaj w pliku manifestu skróconych nazw Studia danych (np. GDS, DS itp.).
  9. Emotikony są niedozwolone w żadnym polu pliku manifestu (description, shortDescription, name itp.). Zasadniczo nie należy używać znaków specjalnych ani niewidocznych, aby zwrócić uwagę na złącze.
  10. Jeśli oprogramowanie sprzęgające ma stały schemat, utwórz szablon raportu dla oprogramowania sprzęgającego i dodaj go do pliku manifestu. Włącz Udostępnianie przez link w przypadku raportu.

urlFetchWhitelist

  1. Ogranicz liczbę punktów końcowych wywoływanych przez UrlFetchApp do tych, które są absolutnie niezbędne do działania łącznika. Dodaj właściwość urlFetchWhitelist do najwyższego poziomu pliku manifestu. Więcej informacji znajdziesz w dokumentacji urlFetchWhitelist.
    • Uwzględnij wszystkie punkty końcowe używane w usłudze UrlFetchApp.
    • Jeśli oprogramowanie sprzęgające nie pobiera zasobów za pomocą UrlFetchApp usługi, ustaw urlFetchWhitelist na pustą listę [].
    • Jeśli łącznik nie łączy się z zestawem stałych punktów końcowych lub prefiks punktu końcowego jest różny, pomiń właściwość urlFetchWhitelist i podaj szczegóły w polu formularza Wyjątek dla urlFetchWhitelist podczas przesyłania prośby o sprawdzenie.

oauthScopes

  1. Ustaw w manifeście wyraźne zakresy OAuth. Oprogramowanie sprzęgające bez wyraźnie określonych zakresów protokołu OAuth zostanie odrzucone.

Oprogramowanie sprzęgające

  1. Jeśli użytkownik potrzebuje konta, aby korzystać z oprogramowania sprzęgającego, upewnij się, że w oprogramowaniu sprzęgającymdescription lub w addOnUrl linku znajdują się instrukcje, które pomogą użytkownikowi utworzyć konto.
  2. Oprogramowanie sprzęgające nie może być w stanie niedokończonym ani w wersji beta. Musisz opublikować kompletny i funkcjonalny łącznik. Oprogramowanie sprzęgające możesz zawsze zaktualizować, ale wdrożenie produkcyjne udostępniane użytkownikom powinno być przetestowane i zawierać wszystkie funkcje.
  3. Wyświetlaj użytkownikom przydatne komunikaty o błędach, gdy napotkają wewnętrzny błąd łącznika. Obejmuje to przypadki, gdy użytkownik podaje nieprawidłowe lub puste dane wejściowe podczas konfiguracji.
  4. Linki shortDescription, description, addOnUrl, supportUrl i strona OAuth (w stosownych przypadkach) nie powinny zawierać błędów ortograficznych ani gramatycznych.
  5. shortDescription nie może zawierać adresów URL.
  6. Używaj metod uwierzytelniania udostępnianych przez getAuthType(). Nie proś o dane logowania za pomocą getConfig().
  7. Przejdź proces weryfikacji klienta OAuth. Weryfikacja jest obowiązkowa w przypadku wszystkich oprogramowań sprzęgających, niezależnie od metody uwierzytelniania w getAuthType(). Proces weryfikacji różni się od sprawdzania łącznika i jest obsługiwany przez osobny zespół, a nie przez Studio danych. Więcej informacji znajdziesz w najczęstszych pytaniach dotyczących weryfikacji interfejsu API OAuth. Jeśli proces weryfikacji klienta OAuth nie zostanie ukończony, Twój łącznik zostanie odrzucony.
    • Podczas procesu weryfikacji OAuth dodaj wymagane zakresy OAuth konektora w ramach konfiguracji ekranu akceptacji OAuth. Jeśli nie dodasz wszystkich wymaganych zakresów, możesz przejść proces weryfikacji protokołu OAuth, ale oprogramowanie sprzęgające nadal będzie wyświetlać ekran niezweryfikowanej aplikacji. Spowoduje to niepowodzenie procesu weryfikacji oprogramowania sprzęgającego się partnera.
      Po przejściu procesu weryfikacji OAuth autoryzuj i przetestuj oprogramowanie sprzęgające przy użyciu nowego konta, aby mieć pewność, że użytkownikom nie będzie się wyświetlać ekran niezweryfikowanej aplikacji.
  8. Upewnij się, że przestrzegasz Warunków korzystania z usługi Galerie Studia danych (dla przesyłającego).

Gdy spełnisz wszystkie wymagania, kliknij ten przycisk, aby poprosić o sprawdzenie oprogramowania sprzęgającego:

Publikowanie organizatora partnera