Zanim zaczniesz kodować swoją pierwszą aplikację kliencką, musisz wykonać kilka czynności, jeśli jeszcze ich nie masz.
Załóż konto Google
Aby utworzyć projekt w Konsoli interfejsów API Google, musisz mieć konto Google. Jeśli masz już konto, nie musisz nic więcej robić.
Możesz też użyć oddzielnego konta Google na potrzeby testowania.
Wypróbuj Google Search Console
W tej dokumentacji założono, że znasz Google Search Console i znasz pojęcia związane z programowaniem i formatami danych internetowych.
Jeśli nie używasz Google Search Console, najpierw wypróbuj interfejs.
Tworzenie projektu dla klienta
Aby wysyłać żądania do Google Search Console, musisz poinformować Google o swoim kliencie i aktywować dostęp do interfejsu API. W tym celu musisz użyć Konsoli interfejsów API Google, aby utworzyć projekt, czyli nazwany zbiór ustawień i informacji o dostępie do interfejsu API, oraz zarejestrować swoją aplikację.
Aby rozpocząć korzystanie z interfejsu Search Console URL Testing Tools API, musisz najpierw użyć narzędzia do konfiguracji, które przeprowadzi Cię przez proces tworzenia projektu w Konsoli interfejsów API Google, włączania interfejsu API i tworzenia danych logowania.
Utwórz klucz interfejsu API aplikacji, jeśli nie jest jeszcze utworzony, klikając Utwórz dane logowania > Klucz interfejsu API. W sekcji Klucze API znajdź swój klucz interfejsu API.
Poznaj podstawy REST
Interfejs API można wywołać na 2 sposoby:
- Wysyłanie żądań HTTP i analizowanie odpowiedzi.
- korzystanie z bibliotek klienta.
Jeśli zdecydujesz się nie korzystać z bibliotek klienta, zapoznaj się z podstawami REST.
REST to styl architektury oprogramowania, który zapewnia wygodne i spójne podejście do żądania i modyfikowania danych.
Termin „EST” to skrót od „Representational State Transfer”. W kontekście interfejsów API Google oznacza to używanie czasowników HTTP w celu pobierania i modyfikowania informacji przechowywanych przez Google.
W systemie REST zasoby są przechowywane w magazynie danych. Klient wysyła żądanie wykonania określonego działania (na przykład utworzenia, pobrania, zaktualizowania lub usunięcia zasobu), a serwer wykonuje tę czynność i wysyła odpowiedź, często w postaci reprezentacji określonego zasobu.
W interfejsach API REST Google klient wskazuje działanie za pomocą czasownika HTTP, np. POST, GET, PUT lub DELETE. Określa zasób przez globalnie unikalny identyfikator URI tego formularza:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Wszystkie zasoby API mają unikalne identyfikatory URI dostępne w protokole HTTP, dlatego funkcja REST umożliwia przechowywanie danych w pamięci podręcznej i zoptymalizowanie jej do pracy z rozproszoną infrastrukturą internetową.
Definicje metod znajdziesz w dokumentacji standardów HTTP 1.1. Zawierają one specyfikacje GET, POST, PUT i DELETE.
REST w interfejsie Search Console URL Testing URL API
Interfejs Search Console URL Testing Tools API jest mapowany bezpośrednio na czasowniki HTTP REST.
Konkretne formaty identyfikatorów URI narzędzia do testowania adresów URL w Search Console to:
https://www.googleapis.com/webmaster-tools/search-console-api/v1/resourcePath?parameters
Pełny zestaw identyfikatorów URI używanych w każdej obsługiwanej operacji w interfejsie API znajdziesz w dokumentacji Search Console URL Testing API API.
Poznaj podstawy JSON
Interfejs Search Console URL Testing Tools API zwraca dane w formacie JSON.
JSON (JavaScript Object Notation) jest popularnym formatem danych niezależnym od języka, który w prosty sposób prezentuje dowolne struktury danych. Więcej informacji znajdziesz na stronie json.org.