Interfejs API Looker Studio

Interfejs Looker Studio API umożliwia wyszukiwanie zasobów Looker Studio i zarządzanie nimi.

Głównym zastosowaniem interfejsu API jest umożliwienie organizacjom korzystającym z Google Workspace lub Cloud Identity automatyzacji zarządzania zasobami Looker Studio i ich migracji.

Ważne: interfejs API jest dostępny tylko dla użytkowników należących do organizacji korzystającej z Google Workspace lub Cloud Identity.

Omówienie wymagań

Aby korzystać z interfejsu Looker Studio API, wykonaj te czynności:

1. Skonfiguruj aplikację do korzystania z interfejsu API
2. Użyj konsoli administracyjnej Google, aby autoryzować aplikację.
3. Uzyskaj tokeny dostępu OAuth 2.0 i wywołaj interfejs API.

Powyższe czynności mogą być wykonywane przez tę samą lub różne organizacje w zależności od tych typowych scenariuszy:

• Aplikacje wewnętrzne opracowane dla organizacji. Organizacja konfiguruje i autoryzuje aplikację dla wszystkich użytkowników.
• Aplikacje innych firm opracowane dla użytkowników zewnętrznych lub klientów (tzn. deweloper i użytkownicy należą do różnych organizacji). Deweloper konfiguruje aplikację, ale organizacja użytkownika autoryzuje aplikację innej firmy.

1. Konfigurowanie aplikacji do korzystania z interfejsu API

Aby skonfigurować aplikację, wykonaj te czynności:

• Włączanie interfejsu API
• Tworzenie klienta OAuth

Włącz API

Aby włączyć interfejs API w projekcie:

1. Otwórz [interfejs Looker Studio API] w konsoli interfejsów API Google.
2. Jeśli pojawi się monit, wybierz projekt lub utwórz nowy.
3. Kliknij Włącz.
4. Jeśli pojawi się taka prośba, przeczytaj i zaakceptuj Warunki korzystania z interfejsu API.

Tworzenie klienta OAuth

Poniższe kroki tworzenia klienta OAuth to ogólne wskazówki, które należy dostosować do wymagań aplikacji.

Ważne: nie dodawaj zakresów Looker Studio do klienta OAuth. Zakresy zostaną dodane przez administratora Workspace podczas autoryzacji aplikacji.

1. Otwórz skonfigurowany ekran zgody OAuth.
   1. Wybierz Wewnętrzny i kliknij Utwórz.
   2. Wypełnij wymagane pola i kliknij Zapisz.
2. Otwórz Dane logowania.
   1. Kliknij UTWÓRZ DANE LOGOWANIA.
   2. Kliknij Identyfikator klienta OAuth.
   3. Wybierz odpowiedni Application Type. (Aplikacja internetowa jest najczęściej stosowana).
   4. Wypełnij wymagane pola i kliknij Utwórz.
3. Zapisz Client ID (Identyfikator klienta), ponieważ jest on używany do autoryzacji aplikacji.

2. Autoryzowanie aplikacji w organizacji

Aplikacje korzystające z interfejsu Looker Studio API mogą uwierzytelniać i autoryzować tylko użytkowników Google Workspace, których organizacja autoryzowała aplikację za pomocą delegowania w całej domenie w celu kontrolowania dostępu do interfejsu API.

Skonfiguruj przekazywanie dostępu w całej domenie za pomocą identyfikatora klienta OAuth aplikacji i zakresów wymaganych przez aplikację.

Ważne: te czynności musi wykonać administrator Workspace. Administrator będzie potrzebować identyfikatora klienta OAuth aplikacji i listy zakresów OAuth wymaganych przez aplikację.

1. Zaloguj się w konsoli administracyjnej Google i przejdź do przekazywania dostępu w całej domenie.
2. W sekcji API clients kliknij Dodaj nowe.
3. Wpisz Client ID aplikacji, którą chcesz autoryzować (czyli aplikacji korzystającej z interfejsu Looker Studio API).
4. Wpisz wszystkie zakresy OAuth wymagane przez aplikację. Jeśli używasz interfejsu Looker Studio API do zarządzania zasobami, często wymagane są te zakresy:
   • https://www.googleapis.com/auth/datastudio
   • https://www.googleapis.com/auth/userinfo.profile
5. Kliknij Autoryzuj.

Uwaga: jeśli Twoja aplikacja nie musi zarządzać zasobami Looker Studio, zamiast zakresu https://www.googleapis.com/auth/datastudio użyj bardziej restrykcyjnego zakresu https://www.googleapis.com/auth/datastudio.readonly.

Po autoryzacji aplikacji każdy użytkownik Workspace należący do organizacji będzie automatycznie uprawniony do korzystania z niej za pomocą interfejsu Looker Studio API.

3. Uzyskiwanie tokenów dostępu OAuth 2.0 i wywoływanie interfejsu API

Po opracowaniu i autoryzacji aplikacji uzyskasz niezbędny dostęp do wywoływania interfejsu API dla użytkowników Workspace. Szczegółowe informacje o korzystaniu z interfejsów API Google za pomocą OAuth znajdziesz w artykule Używanie protokołu OAuth 2.0 na potrzeby dostępu do interfejsów API Google. Dostępne operacje znajdziesz w dokumentacji interfejsu API.

Rozwiązywanie problemów

Brak okna OAuth

Jeśli organizacja użytkownika autoryzowała aplikację, użytkownicy tej organizacji nie będą widzieć okna OAuth podczas autoryzowania aplikacji. Wyjątkiem jest sytuacja, w której aplikacja prosi o autoryzację dodatkowych zakresów interfejsu API Google, które nie zostały skonfigurowane przez administratora Workspace. W takim przypadku użytkownicy zobaczą okno OAuth.

Błąd 400: invalid_scope

Jeśli podczas próby autoryzacji aplikacji użytkownik otrzyma komunikat Error 400: invalid_scope, oznacza to, że organizacja użytkownika nie autoryzowała aplikacji lub zrobiła to nieprawidłowo. Aby rozwiązać ten problem, użytkownik musi poprosić organizację o autoryzację aplikacji.