Aby kontynuować, wykonaj czynności opisane w Wymagania wstępne i zatwierdzenie Twojego projektu w Profilu Firmy Dostęp do interfejsów API.
Włączanie interfejsów API
Z Profilem Firmy jest powiązane 8 interfejsów API, które należy włączyć w interfejsie API Google Konsola:
- 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
Gdy wykonasz wszystkie podane niżej czynności mają wymagania wstępne i mają dostęp do interfejsu API, ale nadal nie jest to możliwe; aby użyć podanego skrótu, możesz włączyć interfejs API ręcznie, wykonując poniższe czynności.
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 lub utwórz nowy projekt. W bibliotece interfejsów API wymienione są 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, użyj wyszukiwania, aby ją znaleźć.
- Wybierz interfejs API, który chcesz włączyć, a następnie kliknij Włącz Przycisk
- 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 Identyfikator klienta OAuth 2.0. Dzięki temu aplikacja może wysyłać żądania dostęp do danych o lokalizacji organizacji w imieniu użytkowników aplikacji.
Z każdym żądaniem interfejsu Business Profile API aplikacja musi wysyłać token OAuth 2.0 który uzyskuje dostęp do prywatnych danych użytkowników.
Otwórz sekcję „Dane logowania”. strony Konsola interfejsów API Google i kliknij Utwórz dane logowania > Identyfikator klienta OAuth na potrzeby tworzenia danych logowania OAuth 2.0. Po utworzonych danych logowania, identyfikator klienta znajdziesz na stronie Dane logowania. Kliknij identyfikatora klienta, takich jak tajny klucz klienta, identyfikatory URI przekierowania, adres źródła JavaScript czy adres e-mail. adresu.
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 żądań i modyfikowania danych.
Termin REST to skrót od „Reprezentacyjny transfer stanowy”. W kontekście interfejsów API Google odnosi się on do pobierania i modyfikowania reprezentacji danych przechowywanych przez Google przy użyciu czasowników HTTP.
System typu REST przechowuje zasoby w magazynie danych. Klient wysyła żądanie serwer wykonujący określone działanie, takie jak utworzenie, pobranie, zaktualizowanie lub usunięcie zasobu; a serwer wykonuje działanie i wysyła odpowiedź. Odpowiedź ta często ma postać reprezentacja określonego zasobu.
W interfejsach API Google typu REST klient określa działanie za pomocą czasownika HTTP, na przykład
GET, POST, PUT lub DELETE. Klient określa
zasób według identyfikatora URI, który ma taką postać jak globalnie:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Ponieważ wszystkie zasoby interfejsu API mają unikalne identyfikatory URI dostępne przez HTTP, REST umożliwia buforowanie danych zoptymalizowane pod kątem pracy z rozproszoną infrastrukturą sieci.
W sekcji
definicje metod w dokumentacji standardów HTTP 1.1.
przydatne. Zawierają one specyfikację dotyczącą: 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 do każdej obsługiwanej operacji w interfejsach API jest wyświetlany w interfejsach Profilu Firmy Dokumentacja referencyjna.
Ś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 taką 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, pozwala w prosty sposób przedstawić dowolne struktury danych. Więcej informacji: json.org,
Tworzenie prostego żądania HTTP przy użyciu Oauth Playground
Za pomocą OAuth 2.0 Playground na eksperymenty z interfejsami Business Profile API. Interfejsy Business Profile API nie są publicznymi interfejsami API, jest kilka dodatkowych czynności, które musisz wykonać, aby używać ich w Playground. Ty potrzebujesz identyfikatora klienta aplikacji internetowej, aby kontynuować.
- Otwórz konsolę interfejsów API Google. i otwórz projekt. Jeśli nie masz identyfikatora klienta OAuth dla 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 & autoryzowanie interfejsów API,” wklej ten zakres dla Interfejsy Business Profile API w polu Wpisz własne zakresy:
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 do Pole 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 próśb znajdziesz w artykule Dokumentacja interfejsów Business Profile API.
Biblioteki klienta
Biblioteki klienta interfejsów Business Profile API obsługują funkcje interfejsów Business Profile API. Oferuje funkcje wspólne dla wszystkich interfejsów API Google, takie jak transport HTTP, obsługa błędów, uwierzytelnianie, i analizowania formatu JSON.
Aby pobrać biblioteki klienta, zobacz Biblioteki.