Zarejestruj się na stronie Google Developers Console i utworzyć nowy projekt lub użyć istniejącego projektu Google.

Przejdź do sekcji "Poświadczenia" w Google Developers Console.
Utwórz poświadczenia "OAuth Client ID", aby uzyskać dostęp do włączonych interfejsów API:
Typ aplikacji: Aplikacja internetowa
Imię i nazwisko: Wewnętrzna nazwa użytkownika
Dodaj 2 autoryzowane URI przekierowania:
https://{{YOUR_DSN}}/api/v1/hosted/google_auth_request_callback (swój DSN można znaleźć w prawym górnym rogu strony Unipile Dashboardprzykład https://api1.unipile.com:13211/api/v1/hosted/google_auth_request_callback
https://{{YOUR_DSN less port}}/api/v1/hosted/google_auth_request_callback/port{{YOUR_DSN less domain}} (możesz znaleźć swój DSN w prawym górnym rogu Unipile Dashboard, na przykład https://api1.unipile.com/api/v1/hosted/google_auth_request_callback/port13211

Kliknij "UTWÓRZ"
Dodaj Client ID i Client Secret do Unipile Dashboard > Ustawienia > Google OAuth.

Przejdź do sekcji "Biblioteka" w Google Developers Console.
Włącz wymagane biblioteki API:
Wyszukaj i włącz wszystkie biblioteki API, których będzie potrzebować Twoja aplikacja: Gmail API

W trakcie wdrożenia możesz utrzymywać swój Google Project w różnych stanach:

"Typ użytkownika" jako "Wewnętrzny": W tym trybie aplikacja jest ograniczona do użytkowników Google Workspace w organizacji.
"Typ użytkownika" jako "Zewnętrzny" i "Status publikacji" jako "W trakcie testowania":
Uwaga: Podczas testowania należy dodać użytkowników testowych. Tokeny wygasają po 7 dniach i wymagają od użytkowników ponownego uwierzytelnienia.
Aby uzyskać więcej informacji na temat statusu publikacji, kliknij tutaj.
Szczegółowe informacje na temat typów użytkowników, kliknij tutaj.

Upewnij się, że wybrałeś odpowiedni typ użytkownika i status publikacji w oparciu o fazę testowania i wdrażania projektu.

Przejdź do sekcji "Włączone APIS i usługi" w Google Developers Console.
Sprawdź Włączone interfejsy API: Przejrzyj i zweryfikuj pełną listę interfejsów API włączonych w ramach projektu Google.
Pulpit nawigacyjny zapewnia przegląd wszystkich włączonych interfejsów API, umożliwiając potwierdzenie stanu wybranych interfejsów API dla projektu. Skorzystaj z tej sekcji, aby upewnić się, że niezbędne interfejsy API są włączone w celu zapewnienia płynnej integracji z aplikacją.

Należy podać następujące informacje:

Wprowadź nazwę aplikacji: Podaj nazwę aplikacji.
E-mail wsparcia użytkownika: Dołącz adres e-mail, na który użytkownicy mogą się kontaktować w przypadku pytań dotyczących ich zgody. Zaleca się użycie aliasu lub listy dystrybucyjnej z odpowiednimi stronami.
Dodaj logo aplikacji: Prześlij logo aplikacji w celu identyfikacji wizualnej.

Uzupełnienie tych informacji w sekcji ekranu zgody OAuth jest niezbędne, aby użytkownicy mogli zrozumieć i zaufać Twojej aplikacji podczas procesu wyrażania zgody. Uwzględnij dokładne szczegóły i elementy brandingu, aby zapewnić użytkownikom płynną obsługę.

W sekcji App Domain należy podać następujące informacje:

Adres URL strony głównej aplikacji: Dodaj adres URL strony głównej aplikacji.
Upewnij się, że jest to prawdziwa strona główna, a nie tylko strona logowania.
Link do polityki prywatności aplikacji: Dołącz link do polityki prywatności aplikacji.
Ważne: Upewnij się, że Twój zespół prawny zapoznał się z Polityką prywatności, aby spełnić jej wymogi. Szczegółowe wymagania Google, w szczególności z sekcji "Ograniczone użycie" w dostarczonym dokumencie.
Łącze do warunków świadczenia usług aplikacji: Dodaj łącze do Warunków świadczenia usług aplikacji.

Wykonaj poniższe kroki, aby dodać autoryzowane domeny:

• Dodaj domenę aplikacji wykorzystywaną w projekcie Google. Upewnij się, że domena jest domeną produkcyjną, a nie deweloperską / testową.
• Dodaj domenę unipile.com

• Wprowadź adres e-mail:
  • Podaj adres e-mail dla informacji kontaktowych dewelopera.
  • Ważne: Powinien to być adres e-mail listy dystrybucyjnej, zapewniający wszystkim odpowiednim stronom otrzymywanie wiadomości e-mail związanych z Weryfikacją Google i powiadomień o wszelkich zmianach w projekcie. Lista dystrybucyjna powinna być aktualizowana w miarę dołączania i odchodzenia członków zespołu.
• Monitorowanie po weryfikacji:
  • Po przesłaniu do weryfikacji należy uważnie monitorować projekt Google pod kątem wszelkich działań ze strony Google.
  • Uwaga: Google wysyła wiadomości e-mail na ten adres, ale mogą one trafiać do folderów spamu lub być blokowane przez serwery. Regularnie sprawdzaj aktualizacje, aby nie przegapić ważnych wiadomości.

Upewnij się, że podałeś aktywnie monitorowany i regularnie sprawdzany adres e-mail, aby otrzymywać informacje o statusie projektu Google i wszelkich wymaganych działaniach po weryfikacji.

• Kliknij przycisk "DODAJ LUB USUŃ ZAKRES ", aby uzyskać dostęp do menu.
• Dodaj następujące zakresy (jeśli nie pojawią się na liście, odśwież stronę):
  ./auth/gmail.send
  ./auth/gmail.labels
  ./auth/gmail.readonly
  ./auth/gmail.modify (niepotrzebne, jeśli nie chcesz przenosić ani usuwać wiadomości e-mail. Będziesz musiał udowodnić Google, że naprawdę go używasz. Poinformuj nas, abyśmy ręcznie usunęli go z Twojego konta Unipile)

Do tego kroku można przystąpić dopiero wtedy, gdy integracja zostanie w pełni ukończona i będzie działać w środowisku produkcyjnym.

Przygotuj i udostępnij film demonstracyjny zgodny z wymaganiami Google. Aby zweryfikować swoją aplikację w Google, musisz również przesłać film prezentujący funkcjonalność aplikacji. Ten film powinien zostać przesłany jako "Nienotowany" film YouTube do celów weryfikacji i dozwolony jest tylko jeden link do filmu.

• Twoja aplikacja i przepływ OAuth są prezentowane w języku angielskim, jak wskazano w dokumentacji Google w sekcjach "Aplikacje żądające wrażliwych zakresów" i "Aplikacje żądające ograniczonych zakresów".
• Demonstracja jest przeprowadzana w domenie produkcyjnej.
• W ustawieniach Google Project przejdź do Menu nawigacji -> Interfejsy API i usługi -> Ekran zgody OAuth i potwierdź następujące elementy:
  • Status publikacji jest ustawiony na "W produkcji".
  • Typ użytkownika to "Zewnętrzny".

• Wyświetlaj stronę główną aplikacji z pełnym adresem URL, podkreślając jej status produkcyjny.
• Zilustruj, w jaki sposób klient Google może połączyć swoje konto, podkreślając użycie oficjalnego przycisku logowania Google.
• Podczas procesu uwierzytelniania, gdy wyświetlany jest ekran procesu OAuth, podświetl adres URL i przeciągnij go, aby wyświetlić identyfikator klienta w adresie URL.

• Sekwencyjnie prezentuj każdy żądany zestaw zakresów, dostosowując je do konkretnego przypadku użycia.
• Zademonstruj dwukierunkową funkcjonalność, pokazując synchronizację między aplikacją a Gmailem. Użyj oddzielnych kart, aby przełączać się między aplikacją a każdą odpowiednią sekcją Gmaila. Na przykład wysłanie wiadomości e-mail za pośrednictwem aplikacji, zilustrowanie, w jaki sposób zmiany są synchronizowane na liście wiadomości wysłanych w Gmailu, a z drugiej strony wyświetlenie odbioru przychodzącej wiadomości e-mail w aplikacji.

Postępując zgodnie z tymi wskazówkami, film demonstracyjny będzie skutecznie przekazywał proces uwierzytelniania i możliwości funkcjonalne aplikacji zsynchronizowanej z usługami Google.

Po utworzeniu demo wideo i upewnieniu się, że spełnia ono wszystkie przedstawione kryteria, uprzejmie udostępnij nam adres URL filmu YouTube. Możemy pomóc w procesie weryfikacji lub możesz bezpośrednio przesłać swoją aplikację do weryfikacji.

Zwróć uwagę na następujące kroki:

• Dodaj ostateczny film do swojego projektu Google jako "nienotowany" link wideo YouTube.
• Prześlij adres URL filmu YouTube do swojego Customer Success Managera w celu sprawdzenia.
• Po dokonaniu przeglądu przejdź do przesłania weryfikacji aplikacji.

Należy pamiętać, że czas trwania procesu weryfikacji może się różnić. Po zgłoszeniu może on potrwać od 2 do 8 tygodni, w zależności od kolejki zgłoszeń Google i liczby rund naprawczych, które uznają za konieczne. Bądź na bieżąco i koordynuj z nami cały proces weryfikacji.

Jeśli aplikacja wykorzystuje ograniczone zakresy, wymagane są dodatkowe kroki. Oto krótki przegląd tego, czego należy się spodziewać:

Ocena bezpieczeństwa Google
Aby zapewnić bezpieczeństwo danych użytkowników, aplikacje żądające dostępu do danych użytkowników Google o ograniczonym zakresie muszą przejść ocenę bezpieczeństwa. Ocena ta ma kluczowe znaczenie dla sprawdzenia, czy wszystkie aplikacje uzyskujące dostęp do danych użytkowników Google mogą bezpiecznie obsługiwać dane i usuwać dane użytkowników na żądanie. Szczegółowy proces oceny jest opisany na stronie CASA (Cloud Application Security Assessment).

Google klasyfikuje aplikację jako warstwę 2 lub 3.

Poziom 2 (samodzielne skanowanie - weryfikacja laboratoryjna) >> Najczęściej spotykane
Opcja bezpłatna LUB płatna (asesor zewnętrzny)
Proces CASA Poziom 2
Poziom 3 (skanowanie laboratoryjne - weryfikacja laboratoryjna)
Płatne - musi być wypełnione przez niezależnego rzeczoznawcę.
Po otrzymaniu klasyfikacji poziomu Google dostarczy instrukcje i narzędzia do ukończenia oceny. Aby uzyskać bardziej szczegółowe informacje, zapoznaj się z podanym linkiem do informacji o ocenie bezpieczeństwa Google i przewiń w dół do często zadawanych pytań dotyczących oceny bezpieczeństwa. Zapewnij zgodność z tym procesem, aby zademonstrować zdolność aplikacji do bezpiecznego przetwarzania danych użytkownika podczas korzystania z ograniczonych zakresów.

Informacje o ocenie bezpieczeństwa Google

Coroczna ponowna ocena bezpieczeństwa aplikacji z ograniczonymi zakresami
Aplikacje, które uzyskują dostęp do ograniczonych zakresów, muszą przechodzić coroczny proces ponownej weryfikacji pod kątem zgodności i przeprowadzać ocenę bezpieczeństwa co 12 miesięcy, aby utrzymać dostęp do zweryfikowanych ograniczonych zakresów. Proces ten zapewnia ciągłe przestrzeganie standardów bezpieczeństwa i chroni dane użytkowników.

Jeśli w dowolnym momencie wprowadzisz nowy ograniczony zakres, który nie został wcześniej oceniony i zatwierdzony, Twoja aplikacja może wymagać ponownej oceny w tym czasie.

Zespół Google ds. weryfikacji nawiąże kontakt za pośrednictwem poczty e-mail, gdy nadejdzie czas ponownej certyfikacji aplikacji. Ważne jest, aby informacje o właścicielu projektu i edytorze projektu były aktualne w Cloud Console. Zapewni to, że właściwi członkowie zespołu otrzymają powiadomienia o tym corocznym egzekwowaniu, co pozwoli na terminowe i płynne spełnienie wymagań ponownej oceny. Zachowaj czujność i szybko reaguj na komunikaty od Google, aby utrzymać bezpieczeństwo i zgodność swojej aplikacji. Więcej informacji można znaleźć w Google FAQ.

Opcja białej listy
Jeśli wolisz alternatywę dla standardowych procesów weryfikacji i przeglądu bezpieczeństwa, masz możliwość umieszczenia swojej aplikacji na białej liście. Pozwala to ominąć zwykłe procedury, ale należy pamiętać, że ta opcja ma zastosowanie tylko wtedy, gdy aplikacja spełnia bardzo szczegółowe kryteria. Chociaż większość przypadków użycia nie spełnia tych kryteriów, przedstawiliśmy poniżej wymagania, abyś mógł ocenić, czy biała lista może być odpowiednia dla Twojej aplikacji.

Wymagania:

Większość klientów korzysta z Google Workspace:
Większość klientów powinna korzystać z kont Google Workspace (dawniej GSuite), tj. posiadać adresy e-mail w formacie @company.com.
Biała lista wymaga działania administratorów użytkowników końcowych w celu zezwolenia na dostęp. Musisz podać administratorom użytkowników swój identyfikator klienta Google projet. Muszą otworzyć swoją konsolę: https://admin.google.com/ac/owl/list?tab=configuredApps i zezwolić na client_id.
Ograniczone korzystanie z osobistego konta Gmail:
Mniej niż 100 osobistych kont Gmail (adresy @gmail.com) powinno być w stanie uwierzytelnić się w tym przepływie.
Niezweryfikowane projekty mają limit 100 (dożywotnich) użytkowników na projekt. Po umieszczeniu na białej liście konta Google Workspace nie są wliczane do tego limitu. Jednak osobiste konta Gmail zawsze będą wliczane do tego limitu.
Bezpłatni użytkownicy wersji próbnej i biała lista:
Bezpłatni użytkownicy wersji próbnej muszą używać swojego adresu e-mail Workspace i umieścić aplikację na białej liście.
Należy pamiętać, że biała lista jest rozwiązaniem obejścia i może nie być odpowiednia dla wszystkich przypadków użycia. Należy dokładnie ocenić te wymagania, aby określić, czy aplikacja spełnia kryteria białej listy. Jeśli tak, podejmij niezbędne kroki, aby spełnić te wymagania i zbadaj to alternatywne podejście.

Interfejs API Gmaila został zaprojektowany specjalnie do interakcji z kontami Gmail i nie integruje się bezpośrednio z innymi klientami poczty e-mail lub usługami. Programiści mogą jednak używać API do synchronizacji lub migracji wiadomości e-mail do lub z Gmaila, a następnie obsługiwać interakcje z klientami innymi niż Gmail za pośrednictwem ich odpowiednich interfejsów API lub protokołów, takich jak IMAP lub SMTP.

Interfejs API Gmaila jest zgodny z surową polityką prywatności Google i przepisami takimi jak RODO. Zgoda użytkownika jest obowiązkowa, a aplikacje muszą używać OAuth 2.0 do uwierzytelniania i autoryzacji, zapewniając, że użytkownicy wyraźnie udzielają pozwolenia na dostęp do swoich kont Gmail. Zakres dostępu aplikacji jest ograniczony do tego, co jest niezbędne dla funkcjonalności, a użytkownicy mogą cofnąć dostęp w dowolnym momencie.

Koszt korzystania z interfejsu API Gmail zależy od liczby kont użytkowników połączonych za pośrednictwem aplikacji. Szczegółowe informacje na temat cen można znaleźć na stronie strona z cenami na stronie internetowej Unipile. Zapewni to szczegółowe informacje na temat różnych poziomów cenowych w oparciu o liczbę kont, pomagając zrozumieć koszty związane z konkretnymi potrzebami integracji.

Unipile zapewnia szeroki dokumentacja na temat interfejsu API usługi Gmail, w tym przewodnik dla deweloperów, odniesienia do interfejsu API i samouczki. Zasoby te są pomocne w rozwiązywaniu problemów i uzyskiwaniu porad dotyczących najlepszych praktyk w zakresie integracji API.