Jeśli Twoja aplikacja prosi o pozwolenie na używanie interfejsów API Google w celu uzyskania dostępu do danych użytkowników Google, przed pierwszym publicznym udostępnieniem aplikacji może być konieczne przeprowadzenie procesu weryfikacji.
To, czy ten wymóg ma zastosowanie do Twojej aplikacji, zależy głównie od 2 czynników:
- Rodzaj danych użytkownika, do których masz dostęp – informacje z profilu publicznego, wpisy w kalendarzu, pliki na Dysku, niektóre dane o zdrowiu i aktywności fizycznej itp.
- Zakres dostępu, którego potrzebujesz – tylko do odczytu, do odczytu i zapisu itp.
Gdy używasz protokołu OAuth 2.0, aby uzyskać od użytkownika konta Google zgodę na dostęp do jego danych, używasz ciągów znaków zwanych zakresami, aby określić typ danych, do których chcesz uzyskać dostęp w jego imieniu. Jeśli Twoja aplikacja prosi o zakresy sklasyfikowane jako wrażliwe lub ograniczone, prawdopodobnie musisz przejść proces weryfikacji, chyba że sposób użycia aplikacji kwalifikuje się do wyjątku.
Przykłady zakresów poufnych to odczytywanie wydarzeń zapisanych w Kalendarzu Google, zapisywanie nowego kontaktu w Kontaktach Google lub usuwanie filmu na YouTube. Więcej informacji o dostępnych zakresach i ich klasyfikacjach znajdziesz w dokumentacji referencyjnej punktów końcowych interfejsu API wywoływanych przez aplikację oraz w powiązanym przewodniku autoryzacji opublikowanym dla interfejsu API.
Musisz prosić o zakresy, które wymagają najmniejszego dostępu do danych użytkownika niezbędnego do zapewnienia danej funkcjonalności. Na przykład aplikacja, która tylko odczytuje dane, nie może prosić o dostęp do odczytywania, zapisywania i usuwania treści, jeśli dla interfejsu API i powiązanych z nim punktów końcowych dostępny jest węższy zakres. Dane otrzymane z interfejsu API Google muszą być wykorzystywane wyłącznie zgodnie z zasadami tego interfejsu API oraz w sposób, w jaki informujesz o tym użytkowników w działaniach aplikacji i w swojej polityce prywatności.
W planie wprowadzenia aplikacji lub nowych funkcji, które wymagają nowego zakresu, uwzględnij czas potrzebny na ukończenie weryfikacji. Proces weryfikacji zakresu wrażliwego może potrwać do 10 dni. Uwaga: Twoja aplikacja może kwalifikować się do weryfikacji marki w ramach prośby o weryfikację zakresów wrażliwych.
Omówienie zakresów wrażliwych
Zakresy wrażliwe muszą zostać sprawdzone przez Google, zanim jakiekolwiek konto Google będzie mogło przyznać dostęp. Administratorzy organizacji Google Workspace mogą ograniczyć dostęp do zakresów wrażliwych, aby uniemożliwić dostęp identyfikatorom klientów OAuth, które nie zostały przez organizację wyraźnie oznaczone jako zaufane.
Informacje o używaniu lunety
- Sprawdź zakresy, których używa Twoja aplikacja lub których chcesz używać. Aby sprawdzić, jakich zakresów obecnie używasz, przejrzyj kod źródłowy aplikacji i poszukaj zakresów wysyłanych z prośbami o autoryzację.
- Sprawdź, czy każdy żądany zakres jest niezbędny do zamierzonych działań funkcji aplikacji i czy używa jak najmniejszych uprawnień wymaganych do udostępnienia tej funkcji. Interfejs API Google zwykle ma dokumentację referencyjną dotyczącą punktów końcowych produktu na stronie Google dla deweloperów. Zawiera ona zakres wymagany do wywołania punktu końcowego lub określonych właściwości w ramach tego punktu. Więcej informacji o zakresach dostępu wymaganych w przypadku punktów końcowych interfejsu API wywoływanych przez aplikację znajdziesz w dokumentacji referencyjnej tych punktów końcowych.
- Dane otrzymane z interfejsu API Google muszą być wykorzystywane wyłącznie zgodnie z zasadami tego interfejsu oraz w sposób, w jaki informujesz o tym użytkowników w działaniach aplikacji i w polityce prywatności.
- Więcej informacji o każdym zakresie, w tym o jego potencjalnym stanie, znajdziesz w dokumentacji API.
- Zadeklaruj wszystkie zakresy używane przez aplikację na stronie Dostęp do danych w Cloud Console. Określone zakresy są grupowane w kategoriach wrażliwych lub z ograniczeniami, aby wyróżnić dodatkową weryfikację, która jest wymagana.
- Znajdź najlepszy zakres, który pasuje do danych używanych przez Twoją integrację, poznaj jego zastosowanie, ponownie sprawdź, czy wszystko działa w środowisku testowym, a potem przygotuj się do przesłania prośby o weryfikację.
Przygotowanie do weryfikacji
Wszystkie aplikacje, które używają interfejsów API Google do wysyłania próśb o dostęp do danych, muszą wykonać te czynności, aby przejść weryfikację marki:
- Sprawdź, czy Twoja aplikacja nie należy do żadnego z przypadków użycia wymienionych w sekcji Wyjątki od wymagań dotyczących weryfikacji.
- Upewnij się, że Twoja aplikacja jest zgodna z wymaganiami dotyczącymi marki powiązanych interfejsów API lub usługi. Na przykład zapoznaj się z wytycznymi dotyczącymi marki w przypadku zakresów Logowania przez Google.
- Potwierdź własność autoryzowanych domen projektu w Google Search Console. Użyj konta Google powiązanego z projektem w Konsoli interfejsów API jako właściciel lub edytujący.
- Upewnij się, że wszystkie informacje o marce na ekranie zgody OAuth, takie jak nazwa aplikacji, adres e-mail pomocy, identyfikator URI strony głównej, identyfikator URI polityki prywatności itp., dokładnie odzwierciedlają tożsamość aplikacji.
Wymagania dotyczące strony głównej aplikacji
Upewnij się, że Twoja strona główna spełnia te wymagania:
- Strona główna musi być dostępna publicznie, a nie tylko dla zalogowanych użytkowników witryny.
- Strona główna musi być wyraźnie powiązana z aplikacją, która jest w trakcie sprawdzania.
- Linki do informacji o aplikacji w Sklepie Google Play lub na jej stronie na Facebooku nie są uznawane za prawidłowe strony główne aplikacji.
Wymagania dotyczące linku do polityki prywatności aplikacji
Upewnij się, że polityka prywatności aplikacji spełnia te wymagania:
- Polityka prywatności musi być widoczna dla użytkowników, hostowana w tej samej domenie co strona główna aplikacji i powiązana z ekranem zgody OAuth w Konsoli interfejsów API Google. Pamiętaj, że strona główna musi zawierać opis funkcjonalności aplikacji oraz linki do polityki prywatności i opcjonalnych warunków korzystania z usługi.
- Polityka prywatności musi określać sposób, w jaki aplikacja uzyskuje dostęp do danych użytkowników Google, wykorzystuje, przechowuje lub udostępnia te dane. Musisz ograniczyć wykorzystywanie danych użytkowników Google do praktyk, które są opisane w opublikowanej przez Ciebie polityce prywatności.
Jak przesłać aplikację do weryfikacji
Projekt w konsoli Google Cloud porządkuje wszystkie zasoby konsoli Cloud. Projekt składa się z zestawu powiązanych kont Google, które mają uprawnienia do wykonywania operacji w projekcie, zestawu włączonych interfejsów API oraz ustawień płatności, uwierzytelniania i monitorowania tych interfejsów. Na przykład projekt może zawierać co najmniej jednego klienta OAuth, konfigurować interfejsy API do użytku przez tych klientów i konfigurować ekran zgody OAuth, który jest wyświetlany użytkownikom przed autoryzacją dostępu do aplikacji.
Jeśli któryś z Twoich klientów OAuth nie jest gotowy do wdrożenia w środowisku produkcyjnym, usuń go z projektu, który wysyła prośbę o weryfikację. Możesz to zrobić na stronie Klienci.
Aby przesłać prośbę o weryfikację, wykonaj te czynności:
- Upewnij się, że Twoja aplikacja jest zgodna z Warunkami korzystania z interfejsów API Google i zasadami dotyczącymi danych użytkownika w usługach interfejsów API Google.
- Dbaj o to, aby role właściciela i edytującego na powiązanych kontach projektu były aktualne. W konsoli Cloud Console aktualizuj też adres e-mail pomocy dla użytkowników na ekranie zgody OAuth oraz informacje kontaktowe dewelopera. Dzięki temu odpowiedni członkowie zespołu będą otrzymywać powiadomienia o nowych wymaganiach.
- Otwórz w konsoli Cloud stronę OAuth Centrum weryfikacji.
- Kliknij przycisk Selektor projektów.
-
W wyświetlonym oknie Wybierz spośród wybierz swój projekt. Jeśli nie możesz znaleźć projektu, ale znasz identyfikator projektu, możesz utworzyć adres URL w przeglądarce w tym formacie:
https://console.developers.google.com/auth/branding?project=[PROJECT_ID]
Zastąp [PROJECT_ID] identyfikatorem projektu, którego chcesz użyć.
- Kliknij przycisk Edytuj aplikację.
- Na stronie ekranu zgody OAuth wpisz niezbędne informacje, a potem kliknij przycisk Zapisz i kontynuuj.
- Kliknij przycisk Dodaj lub usuń zakresy, aby zadeklarować wszystkie zakresy, o które prosi Twoja aplikacja. W sekcji Zakresy niewrażliwe wstępnie wypełniony jest początkowy zestaw zakresów niezbędnych do Logowania przez Google. Dodane zakresy są klasyfikowane jako niewrażliwe.
sensitive, or
<a href="/identity/protocols/oauth2/production-readiness/restricted-scope-verification"
restricted
- Podaj maksymalnie 3 linki do istotnej dokumentacji dotyczącej powiązanych funkcji w aplikacji.
-
W kolejnych krokach podaj dodatkowe informacje o aplikacji, o które Cię poprosimy.
- Prepare a detailed justification for each requested sensitive scope, as
well as an explanation for why a narrower scope isn't sufficient. For
example: "My app will use
https://www.googleapis.com/auth/calendarto show a user's Google calendar data on the scheduling screen of my app. This lets users manage their schedules through my app and sync the changes with their Google calendar." -
Prepare a video that fully demonstrates how a user initiates and grants access to the requested scopes and shows, in detail, the usage of the granted sensitive and restricted scopes in the app. Upload the video to YouTube Studio and set its Visibility as Unlisted. You need to provide a link to the demonstration video in the YouTube link field.
- Show the OAuth grant process that users will experience, in English. This includes the consent flow and, if you use Google Sign-In, the sign-in flow.
- Show that the OAuth consent screen correctly displays the App Name.
- Show that the browser address bar of the OAuth consent screen correctly includes your app's OAuth client ID.
- To show how the data will be used, demonstrate the functionality that's enabled by each sensitive scope that you request.
- Prepare a detailed justification for each requested sensitive scope, as
well as an explanation for why a narrower scope isn't sufficient. For
example: "My app will use
- Jeśli podana przez Ciebie konfiguracja aplikacji wymaga weryfikacji, możesz przesłać aplikację do weryfikacji. Wypełnij wymagane pola, a następnie kliknij Prześlij, aby rozpocząć proces weryfikacji.
Po przesłaniu aplikacji zespół ds. bezpieczeństwa i zaufania Google skontaktuje się z Tobą e-mailem, aby poprosić o dodatkowe informacje lub poinstruować Cię, co musisz zrobić. Sprawdź adresy e-mail w sekcji Informacje kontaktowe dewelopera oraz adres e-mail pomocy na ekranie zgody OAuth, aby sprawdzić, czy nie ma tam próśb o dodatkowe informacje. Możesz też wyświetlić stronę ekranu zgody OAuth w projekcie, aby sprawdzić jego bieżący stan sprawdzania, w tym czy proces sprawdzania został wstrzymany, ponieważ czekamy na Twoją odpowiedź.
Wyjątki od wymagań weryfikacyjnych
Jeśli Twoja aplikacja będzie używana w którymś z scenariuszy opisanych w kolejnych sekcjach, nie musisz przesyłać jej do sprawdzenia.
Do użytku osobistego
Może to być przydatne, jeśli jesteś jedynym użytkownikiem aplikacji lub jeśli korzysta z niej tylko kilku użytkowników, których znasz osobiście. Ty i ograniczona liczba użytkowników możecie bez obaw przejść przez ekran aplikacji bez weryfikacji i przyznać dostęp do aplikacji swoim kontom osobistym.
Projekty używane na poziomach Development, Testing lub Staging
Aby zachować zgodność z zasadami Google OAuth 2.0, zalecamy używanie różnych projektów w środowiskach testowych i produkcyjnych. Zalecamy przesyłanie aplikacji do weryfikacji tylko wtedy, gdy chcesz udostępnić ją wszystkim użytkownikom mającym konto Google. Dlatego jeśli aplikacja jest na etapie programowania, testowania lub stagingu, weryfikacja nie jest wymagana.
Jeśli Twoja aplikacja jest w fazie rozwoju lub testów, możesz pozostawić Stan publikowania w ustawieniu domyślnym Testowanie. To ustawienie oznacza, że Twoja aplikacja jest nadal w fazie rozwoju i jest dostępna tylko dla użytkowników, których dodasz do listy testowych. Musisz zarządzać listą kont Google, które są zaangażowane w rozwój lub testowanie Twojej aplikacji.
Tylko dane należące do usługi
Jeśli Twoja aplikacja używa konta usługi, aby uzyskiwać dostęp tylko do własnych danych, i nie uzyskuje dostępu do danych użytkownika (połączonych z kontem Google), nie musisz przesyłać jej do weryfikacji.
Aby dowiedzieć się, czym są konta usługi, zapoznaj się z sekcją Konta usługi w dokumentacji Google Cloud. Instrukcje korzystania z konta usługi znajdziesz w artykule Używanie OAuth 2.0 w aplikacjach serwer-serwer.
Jest przeznaczony tylko do użytku wewnętrznego
Oznacza to, że aplikacja jest używana tylko przez osoby z Twojej organizacji Google Workspace lub Cloud Identity. Projekt musi należeć do organizacji, a jego ekran zgody OAuth musi być skonfigurowany dla wewnętrznego typu użytkownika. W takim przypadku aplikacja może wymagać zatwierdzenia przez administratora organizacji. Więcej informacji znajdziesz w artykule Dodatkowe kwestie dotyczące Google Workspace.
- Dowiedz się więcej o aplikacjach publicznych i wewnętrznych.
- Dowiedz się, jak oznaczyć aplikację jako wewnętrzną, z często zadawanego pytania Jak oznaczyć aplikację jako przeznaczoną tylko do użytku wewnętrznego.
Instalacja w całej domenie
Jeśli planujesz, że Twoja aplikacja będzie przeznaczona tylko dla użytkowników organizacji Google Workspace lub Cloud Identity i zawsze będzie używać instalacji w całej domenie, nie będzie wymagać weryfikacji marki. Jeśli jednak aplikacja korzysta z zakresów o ograniczonym dostępie lub zakresów wrażliwych, wymagana jest weryfikacja aplikacji. Dzieje się tak, ponieważ instalacja w całej domenie umożliwia administratorowi domeny przyznanie aplikacjom zewnętrznym i wewnętrznym dostępu do danych użytkowników. Administratorzy organizacji są jedynymi kontami, które mogą dodać aplikację do listy dozwolonych do użytku w swoich domenach.
Więcej informacji o tym, jak przekształcić aplikację w instalację w całej domenie, znajdziesz w sekcji Najczęstsze pytania. Moja aplikacja ma użytkowników z kontami firmowymi z innej domeny Google Workspace.