Aby kontynuować, upewnij się, że wykonałeś czynności opisane w sekcji Wymagania wstępne, i że zatwierdziliśmy Twój projekt do uzyskania dostępu do interfejsów API Profilu Firmy.
Włącz interfejsy API
Z Profilem Firmy jest powiązanych 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
- My Business Lodging API
- My Business Place Actions API
- My Business Notifications API
- My Business Verifications API
- My Business Business Information API
- My Business Q&A API
Włączanie API
Jeśli spełnisz wszystkie wymagania wstępne i uzyskasz dostęp do interfejsu API, ale nadal nie możesz korzystać z podanego skrótu, możesz go włączyć ręcznie, wykonując te czynności.
Aby włączyć interfejs API w projekcie:
- Otwórz Bibliotekę API w konsoli interfejsów API Google. Jeśli pojawi się taka prośba, wybierz projekt lub utwórz nowy. Biblioteka interfejsów API zawiera listę wszystkich dostępnych interfejsów API, pogrupowanych według rodziny produktów i popularności.
- Jeśli interfejs API, który chcesz włączyć, nie jest widoczny na liście, znajdź go za pomocą wyszukiwarki.
- 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 usługi interfejsu API.
Jeśli jesteś użytkownikiem Google Workspace, sprawdź, czy Profil Firmy w Google jest włączony na Twoim koncie w organizacji Google Workspace. Jeśli profil firmy w Google jest wyłączony na Twoim koncie w organizacji Google Workspace, podczas korzystania z interfejsów API Profilu Firmy w Google pojawi się błąd 403 – PERMISSION DENIED.
Prośba o identyfikator klienta OAuth 2.0
Aplikacja ma dostęp do chronionych, niepublicznych danych, dlatego musisz mieć identyfikator klienta OAuth 2.0. Dzięki temu Twoja aplikacja może prosić o autoryzację dostępu do danych o lokalizacji organizacji w imieniu użytkowników aplikacji.
Aplikacja musi wysyłać token OAuth 2.0 z każdą prośbą interfejsów API Profilu Firmy, która uzyskuje dostęp do prywatnych danych użytkownika.
Jeśli jeszcze tego nie zrobiono, otwórz sekcję „Dane uwierzytelniające” w Konsoli Google API i kliknij Utwórz dane uwierzytelniające > Identyfikator klienta OAuth, aby utworzyć dane uwierzytelniające OAuth 2.0. Po utworzeniu danych logowania możesz zobaczyć identyfikator klienta na stronie Dane logowania. Kliknij identyfikator klienta, aby wyświetlić takie informacje, jak tajny klucz klienta, identyfikatory URI przekierowania, adres źródła kodu JavaScript i adres e-mail.
Podstawy protokołu REST
Interfejsy API można wywoływać na 2 sposoby:
- Wysyła żądanie HTTP i analizuje odpowiedzi.
- Używaj bibliotek klientów.
Jeśli zdecydujesz się nie używać bibliotek klienta, musisz poznać podstawy protokołu REST.
REST to styl architektury oprogramowania, który zapewnia 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 korzystania z czasowników HTTP do pobierania i modyfikowania reprezentacji danych przechowywanych przez Google.
System RESTful przechowuje zasoby w magazynie danych. Klient wysyła żądanie, aby serwer wykonał określone działanie, takie jak utworzenie, pobranie, zaktualizowanie lub usunięcie zasobu. Serwer wykonuje działanie i wysyła odpowiedź. Odpowiedź ta często ma postać reprezentacji określonego zasobu.
W interfejsach API REST Google klient określa działanie za pomocą czasownika HTTP, takiego jak GET, POST, PUT lub DELETE. Klient określa zasób za pomocą identyfikatora URI o globalnie unikalnym identyfikatorze w tym formacie:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Wszystkie zasoby interfejsu API mają unikalne identyfikatory URI dostępne w ramach protokołu HTTP, dlatego REST umożliwia buforowanie danych i jest zoptymalizowany pod kątem pracy z rozproszoną infrastrukturą sieci.
Warto zapoznać się z definicjami metod w dokumentacji standardu HTTP 1.1. Obejmują one specyfikacje GET, POST, PUT i DELETE.
Interfejsy REST w interfejsach Business Profile API
Operacje interfejsów API Profilu Firmy są mapowane bezpośrednio na czasowniki HTTP REST.
Format interfejsów Business Profile API jest widoczny w tym URI:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Pełny zestaw identyfikatorów URI używanych w przypadku każdej obsługiwanej operacji w interfejsach API znajduje się w dokumentacji Referencyjnej 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 tak:
accounts/accountId
Ścieżka zasobu dla lokalizacji ma postać:
locations/locationId
Podstawy formatu JSON
Interfejsy API Profilu Firmy zwracają dane w formacie JSON.
JavaScript Object Notation (JSON) to powszechny format danych niezależny od języka, który zapewnia prostą tekstową reprezentację dowolnych struktur danych. Więcej informacji znajdziesz na stronie json.org.
Używanie Oauth Playground do wysyłania prostych żądań HTTP
Aby eksperymentować z interfejsami Business Profile API, możesz użyć OAuth 2.0 Playground. Interfejsy Business Profile API nie są interfejsami publicznymi, więc aby z nich korzystać na platformie Playground, musisz wykonać kilka dodatkowych czynności. Aby kontynuować, musisz mieć identyfikator klienta aplikacji internetowej.
- Otwórz Konsolę interfejsów API Google i otwórz swój projekt. Jeśli nie masz identyfikatora klienta OAuth dla aplikacji internetowych, utwórz go:
- Na liście Utwórz dane logowania kliknij Identyfikator klienta OAuth.
- Jako Typ aplikacji kliknij Aplikacja internetowa.
Jako prawidłowy identyfikator URI przekierowania dodaj:
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ć te zmiany:
- Ustaw Proces OAuth na Po stronie klienta.
- Kliknij Użyj własnych danych logowania OAuth.
- Wklej identyfikator klienta OAuth.
- Zamknij opcje konfiguracji.
W sekcji „Krok 1. Wybierz i autoryzuj interfejsy API” wklej w polu Wpisz własne zakresy następujący zakres dla interfejsów API Profilu Firmy:
https://www.googleapis.com/auth/business.manage
- Kliknij Autoryzuj interfejsy API.
- Gdy pojawi się odpowiedni komunikat, kliknij Akceptuj.
-
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 sposobach przesyłania różnych typów żądań znajdziesz w dokumentacji interfejsów Business Profile API.
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 analizowanie danych w formacie JSON.
Aby pobrać biblioteki klienta, zapoznaj się z artykułem Biblioteki.