Aby kontynuować, wykonaj czynności opisane w wymaganiach wstępnych i upewnij się, że zatwierdziliśmy dostęp Twojego projektu do interfejsów API Profilu Firmy.
Włączanie interfejsów API
Z Profilem Firmy powiązane jest 8 interfejsów API, które należy włączyć w konsoli interfejsów API Google:
- Google My Business API
- My Business Account Management API
- Interfejs My Business Lodging API
- Interfejs My Business Place Actions API
- My Business Notifications API
- Interfejs My Business Verifications API
- Interfejs My Business Information API
- My Business Q&A API
Włączanie API
Jeśli spełniasz wszystkie wymagania wstępne i otrzymujesz dostęp do interfejsu API, ale nadal nie możesz korzystać z podanego skrótu, możesz włączyć interfejs API ręcznie, wykonując czynności opisane poniżej.
Aby włączyć interfejs API w projekcie, wykonaj te czynności:
- Otwórz Bibliotekę API w konsoli interfejsów API Google. Jeśli pojawi się taka prośba, wybierz projekt lub utwórz nowy. Zawiera ona wszystkie dostępne interfejsy API pogrupowane według rodziny usług i popularności.
- Jeśli interfejsu API, który chcesz włączyć, nie ma na liście, wyszukaj go za pomocą wyszukiwarki.
- Wybierz interfejs API, który chcesz włączyć, a następnie kliknij przycisk Włącz.
- Włącz płatności, jeśli pojawi się taka prośba.
- Jeśli pojawi się taka prośba, zaakceptuj Warunki korzystania z usługi API.
Jeśli jesteś użytkownikiem Google Workspace, sprawdź, czy w organizacji Google Workspace masz włączony Profil Firmy w Google. Jeśli korzystasz z interfejsów API Profilu Firmy w Google, na Twoim koncie w organizacji Google Workspace pojawi się komunikat „Błąd 403 – ODRZUCONO UPRAWNIENIA”.
Żądanie identyfikatora klienta OAuth 2.0
Twoja aplikacja uzyskuje dostęp do chronionych, niepublicznych danych, więc potrzebujesz identyfikatora klienta OAuth 2.0. Dzięki temu aplikacja będzie mogła prosić o autoryzację dostępu do danych o lokalizacji organizacji w imieniu użytkowników.
Twoja aplikacja musi wysyłać token OAuth 2.0 z każdym żądaniem do interfejsów API Profilu Firmy, które uzyskuje dostęp do prywatnych danych użytkownika.
Aby utworzyć dane logowania OAuth 2.0, przejdź do sekcji „Dane logowania” w Konsoli interfejsów API Google i kliknij Utwórz dane logowania > Identyfikator klienta OAuth. Gdy utworzysz dane logowania, identyfikator klienta będzie widoczny na stronie Dane logowania. Kliknij identyfikator klienta, aby wyświetlić szczegółowe informacje, takie jak tajny klucz klienta, identyfikatory URI przekierowania, adres źródła JavaScript i adres e-mail.
Podstawy REST
Interfejsy API można wywoływać na 2 sposoby:
- wysłać żądanie HTTP i przeanalizować odpowiedzi;
- Użyj bibliotek klienta.
Jeśli zdecydujesz się nie używać bibliotek klienta, musisz poznać podstawy REST.
REST to styl architektury oprogramowania, który zapewnia wygodne i spójne podejście do żądania oraz modyfikowania danych.
Skrót REST to reprezentatywny transfer stanowy. W kontekście interfejsów API Google oznacza to używanie czasowników HTTP do pobierania i modyfikowania reprezentacji danych przechowywanych przez Google.
System typu REST przechowuje zasoby w magazynie danych. Klient wysyła do serwera żądanie wykonania określonego działania, takiego jak utworzenie, pobranie, zaktualizowanie lub usunięcie zasobu, a serwer wykonuje to działanie i wysyła odpowiedź. Odpowiedź ta często reprezentuje określony zasób.
W interfejsach API typu REST firmy Google klient określa działanie za pomocą czasownika HTTP, na przykład GET, POST, PUT lub DELETE. Klient określa zasób za pomocą globalnie unikalnego identyfikatora URI w następującym formacie:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Ponieważ wszystkie zasoby interfejsu API mają unikalne identyfikatory URI dostępne przez HTTP, interfejs REST umożliwia buforowanie danych i jest zoptymalizowany pod kątem pracy z rozproszoną infrastrukturą sieciową.
W dokumentacji standardów HTTP 1.1 mogą Ci się przydać definicje metod. Zawierają one specyfikacje tych usług: GET, POST, PUT i DELETE.
REST w interfejsach Business Profile API
Operacje interfejsów Business Profile API są mapowane bezpośrednio na czasowniki HTTP typu REST.
Konkretny format interfejsów Business Profile API jest wyświetlany w tym identyfikatorze URI:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Pełny zestaw identyfikatorów URI używanych w przypadku poszczególnych obsługiwanych operacji w interfejsach API znajdziesz w dokumentacji interfejsów API Profilu Firmy.
Ścieżki zasobów różnią się w zależności od punktu końcowego.
Ścieżka zasobu do konta wygląda na przykład w tym przykładzie:
accounts/accountId
Ścieżka zasobu dla lokalizacji ma postać:
locations/locationId
Podstawy kodu JSON
Interfejsy Business Profile API zwracają dane w formacie JSON.
JSON (JavaScript Object Notation) to popularny, niezależny od języka format danych, który w prosty sposób przedstawia dowolne struktury danych. Więcej informacji znajdziesz na stronie json.org.
Tworzenie prostego żądania HTTP przy użyciu Oauth Playground
Za pomocą OAuth 2.0 Playground możesz eksperymentować z interfejsami API Profilu Firmy. Interfejsy Business Profile API nie są publicznymi interfejsami API, dlatego aby korzystać z nich w Playground, musisz wykonać kilka dodatkowych czynności. Aby kontynuować, potrzebujesz identyfikatora klienta aplikacji internetowej.
- Otwórz konsolę interfejsów API Google i otwórz projekt. Jeśli nie masz identyfikatora klienta OAuth na potrzeby aplikacji internetowych, utwórz go teraz:
- Z listy Utwórz dane logowania wybierz Identyfikator klienta OAuth.
- Jako Typ aplikacji kliknij Aplikacja internetowa.
Dodaj ten identyfikator jako prawidłowy identyfikator URI przekierowania:
https://developers.google.com/oauthplayground
- Kliknij Utwórz.
- Skopiuj identyfikator klienta do schowka.
- Otwórz stronę OAuth 2.0 Playground.
- Kliknij ikonę koła zębatego, aby otworzyć opcje konfiguracji i wprowadzić te zmiany:
- Ustaw Przepływ OAuth na Po stronie klienta.
- Wybierz Użyj własnych danych logowania OAuth.
- Wklej identyfikator klienta OAuth.
- Zamknij opcje konfiguracji.
W sekcji „Krok 1 – Wybierz i autoryzuj interfejsy API” w polu Wpisz własne zakresy wklej ten zakres interfejsów API Profilu Firmy:
https://www.googleapis.com/auth/business.manage
- Kliknij Authorize APIs.
- Kliknij Zaakceptuj, gdy zobaczysz komunikat.
-
W sekcji „Krok 2. Skonfiguruj żądanie do interfejsu API” wklej ten identyfikator URI w polu Identyfikator URI żądania:
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- Kliknij Wyślij prośbę. Odpowiedź powinna zawierać stan
200 OK.
Więcej informacji o wysyłaniu różnych typów żądań znajdziesz w dokumentacji interfejsów API Profilu Firmy.
Biblioteki klienta
Biblioteki klienta interfejsów Business Profile API obsługują funkcje interfejsów Business Profile API. Zapewniają one funkcje wspólne dla wszystkich interfejsów API Google, takie jak transport HTTP, obsługa błędów, uwierzytelnianie i analiza JSON.
Aby pobrać biblioteki klienta, zobacz Biblioteki.