Interfejs API Looker Studio

Interfejs Looker Studio API pozwala na wyszukiwanie zasobów Looker Studio i zarządzanie nimi.

Głównym przypadkiem użycia interfejsu API jest umożliwianie 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.

Przegląd wymagań

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

1. Skonfiguruj aplikację pod kątem korzystania z interfejsu API.
2. Autoryzuj aplikację w konsoli administracyjnej Google.
3. Uzyskaj tokeny dostępu OAuth 2.0 i wywołaj interfejs API.

Podane wyżej czynności mogą zostać wykonane przez tę samą organizację lub różne organizacje w następujących typowych sytuacjach:

• Aplikacje wewnętrzne opracowane dla organizacji. Organizacja konfiguruje i autoryzuje aplikację dla wszystkich użytkowników w swojej organizacji.
• Aplikacje innych firm opracowywane z myślą o użytkownikach/klientach zewnętrznych (tzn. deweloperzy i użytkownicy należą do różnych organizacji). Deweloper konfiguruje aplikację, ale organizacja użytkownika zezwala na korzystanie z aplikacji innej firmy.

1. Konfigurowanie aplikacji pod kątem 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 API Looker Studio w konsoli interfejsów API Google.
2. Jeśli pojawi się taka prośba, 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żej znajdziesz ogólne wskazówki, jak utworzyć klienta OAuth. Należy je dostosować do wymagań aplikacji.

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

1. Przejdź do sekcji Konfigurowanie ekranu 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 KWALIFIKACJE.
   2. Wybierz Identyfikator klienta OAuth.
   3. Wybierz odpowiedni element (Application Type). (Najczęściej używana jest aplikacja internetowa).
   4. Wypełnij wymagane pola i kliknij Utwórz.
3. Zwróć uwagę na identyfikator klienta, bo jest on używany do autoryzacji aplikacji.

2. Autoryzowanie aplikacji w organizacji

Aplikacje używające Looker Studio API mogą uwierzytelniać i autoryzować użytkowników Google Workspace tylko wtedy, gdy ich organizacja autoryzowała je przy użyciu przekazywania dostępu w całej domenie do kontrolowania dostępu do interfejsu API.

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

Ważne: administrator Workspace musi wykonać poniższe czynności. Administrator potrzebuje identyfikatora klienta OAuth aplikacji i listy zakresów OAuth wymaganych przez aplikację.

1. Zaloguj się w konsoli administracyjnej Google i przejdź do sekcji Przekazywanie dostępu w całej domenie.
2. W aplikacji API clients kliknij Dodaj nowe.
3. Wpisz Client ID aplikacji do autoryzacji (tzn. aplikację, która używa interfejsu Looker Studio API).
4. Wpisz wszystkie zakresy OAuth wymagane przez aplikację. Często używa się tych zakresów, jeśli do zarządzania zasobami jest używany interfejs Looker Studio API:
   • 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, rozważ zastosowanie bardziej restrykcyjnego zakresu https://www.googleapis.com/auth/datastudio.readonly, a nie https://www.googleapis.com/auth/datastudio.

Po autoryzowaniu aplikacji każdy użytkownik Workspace należący do organizacji automatycznie uzyska możliwość korzystania z niej za pomocą interfejsu Looker Studio API.

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

Gdy utworzysz i autoryzujesz aplikację, będziesz mieć niezbędny dostęp do wywoływania użytkowników interfejsu API dla Workspace. Więcej informacji o korzystaniu z interfejsów API Google przy użyciu OAuth znajdziesz w artykule o używaniu OAuth 2.0. Informacje o dostępnych operacjach znajdziesz w dokumentacji API.

Rozwiązywanie problemów

Brak okna OAuth

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

Błąd 400: nieprawidłowy_zakres

Jeśli użytkownik otrzyma komunikat Error 400: invalid_scope, gdy spróbuje autoryzować aplikację, oznacza to, że organizacja nie autoryzowała aplikacji lub nie zrobił tego prawidłowo. Aby rozwiązać ten problem, użytkownik musi poprosić o to, aby jego organizacja autoryzowała aplikację.