W tym dokumencie opisano czynności, które należy wykonać przed napisaniem pierwszej aplikacji klienckiej.
Załóż konto Google
Aby korzystać z tego interfejsu API, musisz mieć konto Google. Aby wywołać tę metodę w usłudze, musisz mieć w Search Console odpowiednie uprawnienia dotyczące danej usługi. Aby np. uruchomić searchAnalytics.query, musisz mieć w usłudze uprawnienia do odczytu.
Wypróbuj Google Search Console
W tej dokumentacji założono, że używasz 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. Każdy interfejs API reprezentuje funkcję raportu w Search Console. Zanim zaczniesz używać interfejsu API, zapoznaj się z dokumentacją odpowiedniego raportu, aby zrozumieć dane, które otrzymujesz.
Tworzenie projektu i danych logowania klienta
Aby wysyłać żądania do Google Search Console, musisz poinformować Google o swoim kliencie i aktywować dostęp do interfejsu API. Aby to zrobić, w konsoli interfejsu Google API utwórz projekt, czyli nazwany zbiór ustawień i informacji o dostępie do interfejsu API, oraz zarejestruj aplikację.
Wszystkie interfejsy API Search Console z wyjątkiem Testing Tools API wymagają danych logowania OAuth2. Przewodniki wprowadzające do języka Python i Java zawierają szczegółowe informacje o tym, jak utworzyć projekt i uzyskać dane logowania klienta.
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.
Podstawy 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 API Google Search Console
Operacje interfejsu API Google Search Console są mapowane bezpośrednio na czasowniki HTTP REST.
Format większości identyfikatorów URI URI interfejsu Google Search Console API jest podobny do tego:
VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters
Pełny zestaw identyfikatorów URI i czasowników użytych w przypadku każdej metody znajdziesz w omówieniu interfejsu API Google Search Console.
Podstawy JSON
Interfejs API Google Search Console 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.