Aby kontynuować, sprawdź, czy spełniasz wymagania opisane w sekcji Wymagania wstępne, a Twój projekt zatwierdziliśmy dostęp do interfejsów API Profilu Firmy.
Włącz interfejsy API
Z Profilem Firmy jest powiązanych 8 interfejsów API, które musisz włączyć w konsoli interfejsów API Google:
- Google My Business API
- Interfejs My Business Account Management API
- Interfejs API My Business Lodging
- Interfejs My Business Place Actions API
- My Business Notifications API
- Interfejs My Business Verifications API
- Interfejs My Business Information API
- Interfejs My Business Q&A API
Włączanie API
Jeśli spełniasz wszystkie wymagania wstępne i masz dostęp do interfejsu API, ale nadal nie możesz używać podanego skrótu, możesz włączyć interfejs API ręcznie, wykonując opisane poniżej czynności.
Aby włączyć interfejs API w projekcie, wykonaj te czynności:
- Otwórz Bibliotekę interfejsów API w Konsoli interfejsów API Google. Jeśli pojawi się taka prośba, wybierz projekt lub utwórz nowy. W bibliotece interfejsów API wymienione są wszystkie dostępne interfejsy API pogrupowane według rodziny usług i popularności.
- Jeśli interfejs API, który chcesz włączyć, nie jest widoczny na liście, znajdź go za pomocą wyszukiwania.
- Wybierz interfejs API, który chcesz włączyć, a następnie kliknij przycisk Włącz.
- Jeśli pojawi się taka prośba, włącz płatności.
- Jeśli pojawi się taka prośba, zaakceptuj Warunki korzystania z interfejsu API.
Jeśli jesteś użytkownikiem Google Workspace, sprawdź, czy Profil Firmy w Google jest włączony w Twojej organizacji korzystającej z Google Workspace. Jeśli podczas korzystania z interfejsów API Profilu Firmy w Google Workspace Profil Firmy w Google jest wyłączony na Twoim koncie w organizacji Google Workspace, otrzymasz komunikat o błędzie 403 „ODRZUCONO UPRAWNIENIE”.
Poproś o identyfikator klienta OAuth 2.0
Twoja aplikacja ma dostęp do chronionych, niepublicznych danych, dlatego potrzebujesz identyfikatora klienta protokołu OAuth 2.0. Dzięki temu aplikacja będzie mogła w imieniu użytkowników zażądać autoryzacji dostępu do danych o lokalizacji organizacji.
Twoja aplikacja musi wysyłać token OAuth 2.0 z każdym żądaniem do interfejsu Business Profile API, który uzyskuje dostęp do prywatnych danych użytkownika.
Otwórz sekcję „Dane logowania” w Konsoli interfejsów API Google i kliknij Utwórz dane logowania > Identyfikator klienta OAuth, aby utworzyć dane uwierzytelniające OAuth 2.0. Po utworzeniu danych logowania identyfikator klienta będzie widoczny na stronie Dane logowania. Kliknij identyfikator klienta, aby wyświetlić szczegóły, takie jak tajny klucz klienta, identyfikatory URI przekierowania, adres źródła JavaScript oraz adres e-mail.
Poznaj podstawy REST
Interfejsy API można wywoływać na 2 sposoby:
- Wyślij żądanie HTTP i przeanalizuj odpowiedzi.
- Użyj bibliotek klienta.
Jeśli nie chcesz korzystać z bibliotek klienta, musisz znać podstawy działania REST.
REST to styl architektury oprogramowania zapewniający wygodne i spójne podejście do żądania i modyfikowania danych.
Termin REST to skrót od „Representational State Transfer”. W kontekście interfejsów API Google odnosi się do użycia czasowników HTTP do pobierania i modyfikowania reprezentacji danych przechowywanych przez Google.
System REST przechowuje zasoby w magazynie danych. Klient wysyła do serwera żądanie wykonania określonego działania, na przykład utworzenia, pobrania, zaktualizowania lub usunięcia zasobu, a serwer wykonuje działanie i wysyła odpowiedź. Odpowiedź ma często postać reprezentacji określonego zasobu.
W interfejsach API Google typu REST klient określa działanie z czasownikiem HTTP, np. GET, POST, PUT lub DELETE. Klient określa zasób za pomocą identyfikatora URI, który ma globalnie unikalny identyfikator w tej formie:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Wszystkie zasoby interfejsu API mają unikalne identyfikatory URI dostępne przez HTTP, dlatego REST umożliwia buforowanie danych i jest zoptymalizowany pod kątem współpracy z rozproszoną infrastrukturą sieci.
Definicje metod mogą być przydatne w dokumentacji standardów HTTP 1.1. Obejmują one specyfikacje GET, POST, PUT i DELETE.
REST w interfejsach Business Profile API
Operacje interfejsów Business Profile API mapują bezpośrednio na czasowniki HTTP REST.
Konkretny format interfejsów Business Profile API jest podany w tym identyfikatorze URI:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Pełny zestaw identyfikatorów URI używanych w każdej obsługiwanej operacji w interfejsach API znajdziesz w dokumentacji interfejsów Business Profile API.
Ścieżki zasobów różnią się w zależności od punktu końcowego.
Na przykład ścieżka zasobu do konta wygląda jak w tym przykładzie:
accounts/accountId
Ścieżka zasobu w danej lokalizacji ma taki format:
locations/locationId
Podstawy formatu 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 przedstawia proste struktury danych w formacie tekstowym. Więcej informacji znajdziesz na stronie json.org.
Tworzenie prostego żądania HTTP
Za pomocą narzędzia OAuth 2.0 Playground możesz eksperymentować z interfejsami API Profilu Firmy. Interfejsy Business Profile API nie są publicznymi interfejsami API, więc aby korzystać z nich w Playground, musisz wykonać kilka dodatkowych czynności. Aby kontynuować, potrzebujesz identyfikatora klienta aplikacji internetowej.
- Przejdź do Konsoli interfejsów API Google i otwórz projekt. Jeśli nie masz identyfikatora klienta OAuth dla aplikacji internetowych, utwórz go teraz:
- Na liście Utwórz dane logowania wybierz Identyfikator klienta OAuth.
- W polu Typ aplikacji kliknij Aplikacja internetowa.
Dodaj ten ciąg znaków jako prawidłowy identyfikator URI przekierowania:
https://developers.google.com/oauthplayground
- Kliknij Utwórz.
- Skopiuj identyfikator klienta do schowka.
- Otwórz OAuth 2.0 Playground.
- Kliknij ikonę koła zębatego, aby otworzyć opcje konfiguracji i wprowadzić następujące 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 następujący zakres interfejsów API Profilu Firmy:
https://www.googleapis.com/auth/business.manage
- Kliknij Autoryzuj interfejsy API.
- Gdy pojawi się komunikat, kliknij Zaakceptuj.
-
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 mieć 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 API Profilu Firmy. Udostępniają 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.